PHP Class Horde_ActiveSync_Request_Base, horde

Author: Michael J Rubinsky ([email protected])

Mostrar archivo Open project: horde/horde

Protected Properties

Property	Type	Description
$_activeSync	Horde_ActiveSync	ActiveSync server
$_decoder	Horde_ActiveSync_Wbxml_Decoder	Decoder
$_device	Horde_ActiveSync_Device	The device info
$_driver	Horde_ActiveSync_Driver_Base	Driver for communicating with the backend datastore.
$_encoder	Horde_ActiveSync_Wbxml_Encoder	Encoder
$_logger	Horde_Log_Logger	Logger
$_procid	integer	The procid
$_provisioning	integer	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.
$_request	Horde_Controller_Request_Http	Request object
$_state	Horde_ActiveSync_State_Base	State driver
$_statusCode	integer	Used to track what error code to send back to client on failure

Public Methods

Method	Description
__construct ( Horde_ActiveSync $as ) : Horde_ActiveSync_Request_Base	Const'r
checkPolicyKey ( string $sentKey, string $requestType = null ) : boolean	Ensure the client's policy key is current.
handle ( ) : boolean	Handle the request.
setLogger ( Horde_Log_Logger $logger )	Set the logger.

Protected Methods

Method	Description
_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.
_handle ( ) : string \| boolean	Implementation method for handling request.
_requireProvisionWbxml ( string $requestType, integer $status )	Send WBXML to indicate provisioning is required.

Method Details

__construct() public method

Const'r

public __construct ( Horde_ActiveSync $as ) : Horde_ActiveSync_Request_Base
$as	Horde_ActiveSync	The ActiveSync server.
return	Horde_ActiveSync_Request_Base

_cleanUpAfterPairing() protected method

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.

protected _cleanUpAfterPairing ( )

_handle() abstract protected method

Implementation method for handling request.

abstract protected _handle ( ) : string \| boolean
return	string \| boolean	Content-Type of results if not wbxml, or boolean.

_requireProvisionWbxml() protected method

Send WBXML to indicate provisioning is required.

protected _requireProvisionWbxml ( string $requestType, integer $status )
$requestType	string	The type of request we are handling.
$status	integer	The reason we need to provision.

checkPolicyKey() public method

Ensure the client's policy key is current.

public checkPolicyKey ( string $sentKey, string $requestType = null ) : boolean
$sentKey	string	The policykey sent to us by the client
$requestType	string	The type of request we are handling. A Horde_ActiveSync constant.
return	boolean

handle() public method

Handle the request.

public handle ( ) : boolean
return	boolean

setLogger() public method

Set the logger.

public setLogger ( Horde_Log_Logger $logger )
$logger	Horde_Log_Logger

Property Details

$_activeSync protected_oe property

ActiveSync server

protected Horde_ActiveSync $_activeSync
return	Horde_ActiveSync

$_decoder protected_oe property

Decoder

protected Horde_ActiveSync_Wbxml_Decoder $_decoder
return	Horde_ActiveSync_Wbxml_Decoder

$_device protected_oe property

The device info

protected Horde_ActiveSync_Device $_device
return	Horde_ActiveSync_Device

$_driver protected_oe property

Driver for communicating with the backend datastore.

protected Horde_ActiveSync_Driver_Base $_driver
return	Horde_ActiveSync_Driver_Base

$_encoder protected_oe property

Encoder

protected Horde_ActiveSync_Wbxml_Encoder $_encoder
return	Horde_ActiveSync_Wbxml_Encoder

$_logger protected_oe property

Logger

protected Horde_Log_Logger $_logger
return	Horde_Log_Logger

$_procid protected_oe property

The procid

protected int $_procid
return	integer

$_provisioning protected_oe property

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.

protected int $_provisioning
return	integer

$_request protected_oe property

Request object

protected Horde_Controller_Request_Http $_request
return	Horde_Controller_Request_Http

$_state protected_oe property

State driver

protected Horde_ActiveSync_State_Base $_state
return	Horde_ActiveSync_State_Base

$_statusCode protected_oe property

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

protected int $_statusCode
return	integer