Class: Net_SMPP_Command

This class is the base from which the command-specific classes inherit. It contains functions common to the parsing and generation of the paramaters for all SMPP commands.

Author: Ian Eure <ieure@php.net>
Version: Release: @package_version@
Version: CVS: $Revision: 298434 $
Copyright: 2005 WebSprockets, LLC.
Link: http://pear.php.net/package/Net_SMPP
Since: Release 0.0.1dev2
License: PHP License 3.0

[ Top ]

Class Variables

$_defs = array()

[line 171]

Parameter defs for this command

*ORDER IS SIGNIFICANT!* Required paramaters *MUST* be listed in the order as defined by the protocol. Optional paramaters *MUST* come after all the required paramaters.

This should look like:

$_defs = array( 'field_name' => array( 'type' => 'field_type', 'size' => field_size, 'max' => field_max_size ) );

'type' is one of: int, string, ostring.

int: your basic integer. 'size' is the number of bytes the value will be packed into. 'max' is ignored.
string: a basic string. 'size' is the size of the string in bytes if the length of the string is less than 'size,' it will be null-padded. 'max' is the maximum length for variable-length strings. Only set one of 'max' or 'size.'
ostring: Non-null-terminated, variable length octet string.

Access: protected

Type:

array

[ Top ]

Method Detail

__construct (Constructor) [line 193]

void __construct(

$command, [array
$args = array()])

5.x/main constructor

See: Net_SMPP_Command::set()

Parameters:

array	`$args`	—	Values to set
	`$command`	—

[ Top ]

Net_SMPP_Command (Constructor) [line 181]

void Net_SMPP_Command(

$command, [array
$args = array()])

4.x constructor

See: Net_SMPP_Command::__construct()

Parameters:

array	`$args`	—	Values to set
	`$command`	—

[ Top ]

commandCode [line 233]

mixed commandCode(
int
$cmdname)

Get the ID of a command from it's name

Return: Int command ID, or false

Parameters:

int $cmdname — Command name

[ Top ]

commandName [line 217]

mixed commandName(
int
$cmdcode)

Get the name of a command from it's ID

Return: String command name, or false

Parameters:

int $cmdcode — Command ID

[ Top ]

fieldExists [line 580]

boolean fieldExists(
string
$field)

Does this field exist?

Return: true if it exists, false otherwise
Access: protected

Parameters:

string $field — Field to check

[ Top ]

fieldIsOptional [line 591]

boolean fieldIsOptional(
string
$field)

Is this field optional?

Return: true if optional, false otherwise

Parameters:

string $field — Field name

[ Top ]

generateParams [line 254]

string generateParams(
)

Generate the binary data from the object

This is the workhorse of this class (and all the other Net_SMPP_Command_* classes). It's responsible for generating the binary protocol data from the fields in the object, and is the opposite of parse().

See: _packFormat()

[ Top ]

isFixed [line 469]

boolean isFixed(
string
$field)

Is this a fixed-length field?

Return: true if it is, false otherwise
Access: protected

Parameters:

string $field — Field to test

[ Top ]

parseOptionalParams [line 524]

void parseOptionalParams(
string
$data)

Parse optional paramaters

Access: protected

Parameters:

string $data — Optional paramaters to parse

[ Top ]

parseParams [line 483]

boolean parseParams(
string
$data)

Parse data into the object structure

Return: true on success, false otherwise

Parameters:

string $data — Data to parse

[ Top ]

set [line 613]

void set(
[array
$args = array()])

Set values in this object

Unknown values are ignored.

Parameters:

array $args — Values to set

[ Top ]

_commandList [line 629]

array &_commandList(
)

Get the list of SMPP v3.4 commands

Access: protected

[ Top ]

_optionalParams [line 671]

array &_optionalParams(
)

Get list of optional paramaters

Access: protected

[ Top ]