PHP Class Horde_ActiveSync_Policies, horde

Author: Michael J Rubinsky ([email protected])
Mostra file Open project: horde/horde Class Usage Examples

Protected Properties

Property Type Description
$_defaults array Default policy values used in both 12.0 and 12.1
$_defaults_twelve array Deafaults for 12.0 policies.
$_defaults_twelveone array Defaults used only in 12.1
$_encoder Horde_ActiveSync_Wbxml_Encoder Output stream
$_overrides array Explicitly set policies.
$_policies array Local cache of all policies to send.
$_version long EAS version to support.

Public Methods

Method Description
__construct ( Horde_ActiveSync_Wbxml_Encoder $encoder = null, float $version = Horde_ActiveSync::VERSION_TWELVEONE, array $policies = [] ) Const'r
getAvailablePolicies ( ) : array Return a list of all configurable policy names.
toWbxml ( ) Output the policies as WBXML. Used in EAS Versions >= 12.0
toXml ( ) Output the policies as XML. Only used in EAS Version 2.5. This method only outputs the 2.5 compatible policies.
validatePolicyVersion ( ) : boolean Determine if the requested policy settings are available for the current version being used.

Protected Methods

Method Description
_getPolicies ( )
_sendPolicy ( string $policy, mixed $value, boolean $nodefault = false ) Output a single policy value

Method Details

__construct() public method

Const'r
public __construct ( Horde_ActiveSync_Wbxml_Encoder $encoder = null, float $version = Horde_ActiveSync::VERSION_TWELVEONE, array $policies = [] )
$encoder Horde_ActiveSync_Wbxml_Encoder The output stream encoder
$version float The EAS Version.
$policies array The policy array.

_getPolicies() protected method

protected _getPolicies ( )

_sendPolicy() protected method

Output a single policy value
protected _sendPolicy ( string $policy, mixed $value, boolean $nodefault = false )
$policy string The policy name
$value mixed The policy value
$nodefault boolean Don't send the policy if the value is default.

getAvailablePolicies() public method

Return a list of all configurable policy names.
public getAvailablePolicies ( ) : array
return array

toWbxml() public method

Output the policies as WBXML. Used in EAS Versions >= 12.0
public toWbxml ( )

toXml() public method

Output the policies as XML. Only used in EAS Version 2.5. This method only outputs the 2.5 compatible policies.
public toXml ( )

validatePolicyVersion() public method

Determine if the requested policy settings are available for the current version being used.
public validatePolicyVersion ( ) : boolean
return boolean True if policies are available in current version, false otherwise.

Property Details

$_defaults protected_oe property

Default policy values used in both 12.0 and 12.1
protected array $_defaults
return array

$_defaults_twelve protected_oe property

Deafaults for 12.0 policies.
protected array $_defaults_twelve
return array

$_defaults_twelveone protected_oe property

Defaults used only in 12.1
protected array $_defaults_twelveone
return array

$_encoder protected_oe property

Output stream
protected Horde_ActiveSync_Wbxml_Encoder $_encoder
return Horde_ActiveSync_Wbxml_Encoder

$_overrides protected_oe property

Explicitly set policies.
protected array $_overrides
return array

$_policies protected_oe property

Local cache of all policies to send.
protected array $_policies
return array

$_version protected_oe property

EAS version to support.
protected long $_version
return long