API Documentation
\

\Horde_ActiveSync_Request_Provision

Hanlde Provision requests.

Summary

Methods
Properties
Constants
__construct()
checkPolicyKey()
setLogger()
handle()
No public properties found
STATUS_SUCCESS
STATUS_PROTERROR
STATUS_NOTDEFINED
STATUS_SERVERERROR
STATUS_POLICYUNKNOWN
STATUS_DEVEXTMANAGED
STATUS_POLICYCORRUPT
STATUS_POLKEYMISM
STATUS_CLIENT_SUCCESS
STATUS_CLIENT_PARTIAL
STATUS_CLIENT_FAILED
STATUS_CLIENT_THIRDPARTY
_cleanUpAfterPairing()
_requireProvisionWbxml()
_handle()
_sendNoProvisionNeededResponse()
_globalError()
_handleSettings()
_handleVersionMismatch()
$_driver
$_state
$_encoder
$_decoder
$_request
$_provisioning
$_statusCode
$_activeSync
$_logger
$_device
$_procid
N/A
No private methods found
No private properties found
N/A

Constants

STATUS_SUCCESS

STATUS_SUCCESS

STATUS_PROTERROR

STATUS_PROTERROR

STATUS_NOTDEFINED

STATUS_NOTDEFINED

STATUS_SERVERERROR

STATUS_SERVERERROR

STATUS_POLICYUNKNOWN

STATUS_POLICYUNKNOWN

STATUS_DEVEXTMANAGED

STATUS_DEVEXTMANAGED

STATUS_POLICYCORRUPT

STATUS_POLICYCORRUPT

STATUS_POLKEYMISM

STATUS_POLKEYMISM

STATUS_CLIENT_SUCCESS

STATUS_CLIENT_SUCCESS

STATUS_CLIENT_PARTIAL

STATUS_CLIENT_PARTIAL

STATUS_CLIENT_FAILED

STATUS_CLIENT_FAILED

STATUS_CLIENT_THIRDPARTY

STATUS_CLIENT_THIRDPARTY

Properties

$_request

$_request : \Horde_Controller_Request_Http

Request object

Type

\Horde_Controller_Request_Http

$_provisioning

$_provisioning : integer

Whether we require provisioned devices.

Valid values are:

  • Horde_ActiveSync::PROVISIONING_FORCE: Accept ONLY provisioned devices
  • Horde_ActiveSync::PROVISIONING_LOOSE: Force provisioning if device supports provisioning, allow non-provisionable devices as well.
  • Horde_ActiveSync::PROVISIONING_NONE: Allow any device.

Type

integer

$_statusCode

$_statusCode : integer

Used to track what error code to send back to client on failure

Type

integer

$_activeSync

$_activeSync : \Horde_ActiveSync

ActiveSync server

Type

\Horde_ActiveSync

$_logger

$_logger : \Horde_Log_Logger

Logger

Type

\Horde_Log_Logger

$_procid

$_procid : integer

The procid

Type

integer

Methods

checkPolicyKey()

checkPolicyKey(string  $sentKey, string  $requestType = null) : boolean

Ensure the client's policy key is current.

Parameters

string $sentKey

The policykey sent to us by the client
string $requestType

The type of request we are handling. A Horde_ActiveSync constant.

Returns

boolean

setLogger()

setLogger(\Horde_Log_Logger  $logger)

Set the logger.

Parameters

\Horde_Log_Logger $logger

handle()

handle() : boolean

Handle the request.

Returns

boolean

_cleanUpAfterPairing()

_cleanUpAfterPairing()

Clean up after initial pairing. Initial pairing can happen either as a result of either a FOLDERSYNC or PROVISION command, depending on the device capabilities.

_requireProvisionWbxml()

_requireProvisionWbxml(string  $requestType, integer  $status)

Send WBXML to indicate provisioning is required.

Parameters

string $requestType

The type of request we are handling.
integer $status

The reason we need to provision.

_handle()

_handle() : boolean

Handle the Provision request. This is a 3-phase process. Phase 1 is actually the enforcement, when the server rejects a request and forces the client to perform this PROVISION request.

..so we are handling phase 2 (download policies) and 3 (acknowledge policies) here.

Throws

\Horde_ActiveSync_Exception

Returns

boolean

_sendNoProvisionNeededResponse()

_sendNoProvisionNeededResponse(integer  $status)

Send a WBXML response to the output stream indicating that no provision requests are necessary.

Parameters

integer $status

The status code to send along with the response.

_globalError()

_globalError(integer  $status)

Handle global provision request errors, and send the output to the output stream.

Parameters

integer $status

The status code to send.

_handleSettings()

_handleSettings() : boolean|array

Handle the EAS 14.1 SETTINGS_DEVICEINFORMATION parsing.

Returns

boolean|array —

An array of received device information or false on any protocol error.

_handleVersionMismatch()

_handleVersionMismatch()

Output status that indicates device does not support the required policies.