PHP Class LdapTools\Utilities\DialInData

Author: Chad Sikorra ([email protected])
Show file Open project: ldaptools/ldaptools Class Usage Examples

Protected Properties

Property Type Description
$callbackPhoneNumber Hex representation of a phone number configured for the user on which the answerer should call back.
$signature string
$userPrivilege Dial-in bit-mask (NoCallback = 1, AdminSetCallback = 2, CallerSetCallback = 4, DialinPrivilege = 8)

Public Methods

Method Description
__construct ( string | null $dialInData = null )
getCallbackPhoneNumber ( ) : string Get the CallbackPhoneNumber as a hex value. The encoding process for this value is currently unknown.
getSignature ( ) : string Get the signature value for the dial-in data.
getUserPrivilege ( ) : integer Get the UserPrivilege bit-mask.
isSignatureValid ( ) : boolean Check whether the signature is valid, thus signifying a valid data structure.
setCallbackPhoneNumber ( string $callbackPhoneNumber ) Set the CallbackPhoneNumber as a hex value. The encoding process for this value is currently unknown.
setUserPrivilege ( integer $userPrivilege ) Set the UserPrivilege bit-mask.
toBinary ( ) : string Get the binary representation of the dial-in data for the userParameters value.

Protected Methods

Method Description
dec2hex ( integer $int, integer $padLength = 2 ) : string Need to make sure hex values are always an even length, so pad as needed.
decode ( string $binary ) Decode and parse the binary dial-in data from the userParameters attribute (the data between 44 and 96 bytes).

Method Details

__construct() public method

public __construct ( string | null $dialInData = null )
$dialInData string | null

dec2hex() protected method

Need to make sure hex values are always an even length, so pad as needed.
protected dec2hex ( integer $int, integer $padLength = 2 ) : string
$int integer
$padLength integer The hex string must be padded to this length (with zeros).
return string

decode() protected method

Decode and parse the binary dial-in data from the userParameters attribute (the data between 44 and 96 bytes).
protected decode ( string $binary )
$binary string

getCallbackPhoneNumber() public method

Get the CallbackPhoneNumber as a hex value. The encoding process for this value is currently unknown.
public getCallbackPhoneNumber ( ) : string
return string

getSignature() public method

Get the signature value for the dial-in data.
public getSignature ( ) : string
return string

getUserPrivilege() public method

Get the UserPrivilege bit-mask.
public getUserPrivilege ( ) : integer
return integer

isSignatureValid() public method

Check whether the signature is valid, thus signifying a valid data structure.
public isSignatureValid ( ) : boolean
return boolean

setCallbackPhoneNumber() public method

Set the CallbackPhoneNumber as a hex value. The encoding process for this value is currently unknown.
public setCallbackPhoneNumber ( string $callbackPhoneNumber )
$callbackPhoneNumber string

setUserPrivilege() public method

Set the UserPrivilege bit-mask.
public setUserPrivilege ( integer $userPrivilege )
$userPrivilege integer

toBinary() public method

Get the binary representation of the dial-in data for the userParameters value.
public toBinary ( ) : string
return string

Property Details

$callbackPhoneNumber protected property

Hex representation of a phone number configured for the user on which the answerer should call back.
protected $callbackPhoneNumber

$signature protected property

protected string $signature
return string

$userPrivilege protected property

Dial-in bit-mask (NoCallback = 1, AdminSetCallback = 2, CallerSetCallback = 4, DialinPrivilege = 8)
protected $userPrivilege