PHP 클래스 Horde_ActiveSync, horde

저자: Michael J Rubinsky ([email protected])
파일 보기 프로젝트 열기: horde/horde 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$_certPath string Path to root certificate bundle
$_collectionsObj Horde_ActiveSync_Collections The singleton collections handler.
$_compression boolean Support gzip compression of certain data parts?
$_decoder Horde_ActiveSync_Wbxml_Decoder Wbxml decoder
$_device Horde_ActiveSync_Device
$_encoder Horde_ActiveSync_Wbxml_Encoder Wbxml encoder
$_get array Local cache of Get variables/decoded base64 uri
$_globalError boolean Global error flag.
$_logger Horde_Log_Logger The logger for this class.
$_loggerFactory Horde_ActiveSync_Interface_LoggerFactory Logger
$_maxVersion float Highest version to support.
$_multipart boolean Multipart support?
$_needMsRp boolean Flag to indicate we need to update the device version.
$_procid integer Process id (used in logging).
$_provisioning string Provisioning support
$_supportedVersions array Supported EAS versions.
$_version float The actual version we are supporting.

공개 메소드들

메소드 설명
__construct ( Horde_ActiveSync_Driver_Base $driver, Horde_ActiveSync_Wbxml_Decoder $decoder, Horde_ActiveSync_Wbxml_Encoder $encoder, Horde_ActiveSync_State_Base $state, Horde_Controller_Request_Http $request ) : Horde_ActiveSync Const'r
__get ( string $property ) : mixed Getter
activeSyncHeader ( ) Send the MS_Server-ActiveSync header.
authenticate ( Horde_ActiveSync_Credentials $credentials ) : boolean Authenticate to the backend.
checkGlobalError ( ) : mixed Return any global errors that occured during initial connection.
commandsHeader ( ) Send protocol commands header.
contentTypeHeader ( $content_type = null ) Send the content type header.
getCollectionsObject ( ) : Horde_ActiveSync_Collections Return a collections singleton.
getGetVars ( ) : array Return the GET variables passed from the device, decoding from base64 if needed.
getImporter ( ) : Horde_ActiveSync_Connector_Importer Return an Importer object.
getMIMETruncSize ( integer $truncation ) : integer | boolean Return the number of bytes corresponding to the requested trunction constant. This applies to MIMETRUNCATION only.
getPolicyKey ( ) : integer Obtain the policy key header from the request.
getProtocolVersion ( ) : string Obtain the ActiveSync protocol version requested by the client headers.
getSupportedCommands ( ) : string Return the supported commands in a comma delimited string suitable for sending as the MS-ASProtocolCommands header.
getSupportedVersions ( ) : string Return supported versions in a comma delimited string suitable for sending as the MS-ASProtocolVersions header.
getSyncCache ( ) : Horde_ActiveSync_SyncCache Return a new, fully configured SyncCache.
getTruncSize ( integer $truncation ) : integer | boolean Return the number of bytes corresponding to the requested trunction constant.
handleRequest ( string $cmd, string $devId ) : string | boolean The heart of the server. Dispatch a request to the appropriate request handler.
messageFactory ( string $message ) : Horde_ActiveSync_Message_Base Factory method for creating Horde_ActiveSync_Message objects.
provisionHeader ( ) Send provision header
provisioningRequired ( ) Send the headers indicating that provisioning is required.
setLogger ( Horde_ActiveSync_Interface_LoggerFactory $logger ) : void Setter for the logger
setProvisioning ( $provision ) Setter for provisioning support
setRootCertificatePath ( string $path ) Set the local path to the root certificate bundle.
setSupportedVersion ( float $version ) Allow to force the highest version to support.
versionHeader ( ) Send the protocol versions header.

보호된 메소드들

메소드 설명
_doOptionsRequest ( ) Send the OPTIONS request response headers.
_handleDevice ( string $devId ) : boolean Handle device checks. Takes into account permissions and restrictions via various callback methods.
_setLogger ( array $options )

메소드 상세

__construct() 공개 메소드

Const'r
public __construct ( Horde_ActiveSync_Driver_Base $driver, Horde_ActiveSync_Wbxml_Decoder $decoder, Horde_ActiveSync_Wbxml_Encoder $encoder, Horde_ActiveSync_State_Base $state, Horde_Controller_Request_Http $request ) : Horde_ActiveSync
$driver Horde_ActiveSync_Driver_Base The backend driver.
$decoder Horde_ActiveSync_Wbxml_Decoder The Wbxml decoder.
$encoder Horde_ActiveSync_Wbxml_Encoder The Wbxml encoder.
$state Horde_ActiveSync_State_Base The state driver.
$request Horde_Controller_Request_Http The HTTP request object.
리턴 Horde_ActiveSync The ActiveSync server object.

__get() 공개 메소드

Getter
public __get ( string $property ) : mixed
$property string The property to return.
리턴 mixed The value of the requested property.

_doOptionsRequest() 보호된 메소드

Send the OPTIONS request response headers.
protected _doOptionsRequest ( )

_handleDevice() 보호된 메소드

Handle device checks. Takes into account permissions and restrictions via various callback methods.
protected _handleDevice ( string $devId ) : boolean
$devId string The client provided device id.
리턴 boolean If EAS version is > 12.1 returns false on any type of failure in allowing the device to connect. Sets appropriate internal variables to indicate the type of error to return to the client. Failure on EAS version < 12.1 results in throwing exceptions. Otherwise, return true.

_setLogger() 보호된 메소드

protected _setLogger ( array $options )
$options array

activeSyncHeader() 공개 메소드

Send the MS_Server-ActiveSync header.
public activeSyncHeader ( )

authenticate() 공개 메소드

Authenticate to the backend.
public authenticate ( Horde_ActiveSync_Credentials $credentials ) : boolean
$credentials Horde_ActiveSync_Credentials The credentials object.
리턴 boolean True on successful authentication to the backend.

checkGlobalError() 공개 메소드

Return any global errors that occured during initial connection.
부터: 2.4.0
public checkGlobalError ( ) : mixed
리턴 mixed A Horde_ActiveSync_Status:: constant of boolean false if no errors.

commandsHeader() 공개 메소드

Send protocol commands header.
public commandsHeader ( )

contentTypeHeader() 공개 메소드

Send the content type header.
public contentTypeHeader ( $content_type = null )

getCollectionsObject() 공개 메소드

Return a collections singleton.
부터: 2.4.0
public getCollectionsObject ( ) : Horde_ActiveSync_Collections
리턴 Horde_ActiveSync_Collections

getGetVars() 공개 메소드

Return the GET variables passed from the device, decoding from base64 if needed.
public getGetVars ( ) : array
리턴 array A hash of get variables => values.

getImporter() 공개 메소드

Return an Importer object.
부터: 2.4.0
public getImporter ( ) : Horde_ActiveSync_Connector_Importer
리턴 Horde_ActiveSync_Connector_Importer

getMIMETruncSize() 공개 정적인 메소드

Return the number of bytes corresponding to the requested trunction constant. This applies to MIMETRUNCATION only.
부터: 2.20.0
public static getMIMETruncSize ( integer $truncation ) : integer | boolean
$truncation integer The constant.
리턴 integer | boolean Either the size, in bytes, to truncate or falso if no truncation.

getPolicyKey() 공개 메소드

Obtain the policy key header from the request.
public getPolicyKey ( ) : integer
리턴 integer The policy key or '0' if not set.

getProtocolVersion() 공개 메소드

Obtain the ActiveSync protocol version requested by the client headers.
public getProtocolVersion ( ) : string
리턴 string The EAS version requested by the client.

getSupportedCommands() 공개 메소드

Return the supported commands in a comma delimited string suitable for sending as the MS-ASProtocolCommands header.
public getSupportedCommands ( ) : string
리턴 string

getSupportedVersions() 공개 메소드

Return supported versions in a comma delimited string suitable for sending as the MS-ASProtocolVersions header.
public getSupportedVersions ( ) : string
리턴 string

getSyncCache() 공개 메소드

Return a new, fully configured SyncCache.
부터: 2.4.0
public getSyncCache ( ) : Horde_ActiveSync_SyncCache
리턴 Horde_ActiveSync_SyncCache

getTruncSize() 공개 메소드

Return the number of bytes corresponding to the requested trunction constant.
public getTruncSize ( integer $truncation ) : integer | boolean
$truncation integer The constant.
리턴 integer | boolean Either the size, in bytes, to truncate or falso if no truncation.

handleRequest() 공개 메소드

The heart of the server. Dispatch a request to the appropriate request handler.
public handleRequest ( string $cmd, string $devId ) : string | boolean
$cmd string The command we are requesting.
$devId string The device id making the request. @deprecated
리턴 string | boolean false if failed, true if succeeded and response content is wbxml, otherwise the content-type string to send in the response.

messageFactory() 공개 정적인 메소드

Factory method for creating Horde_ActiveSync_Message objects.
부터: 2.4.0
public static messageFactory ( string $message ) : Horde_ActiveSync_Message_Base
$message string The message type.
리턴 Horde_ActiveSync_Message_Base The concrete message object.

provisionHeader() 공개 메소드

Send provision header
public provisionHeader ( )

provisioningRequired() 공개 메소드

Send the headers indicating that provisioning is required.

setLogger() 공개 메소드

Setter for the logger
public setLogger ( Horde_ActiveSync_Interface_LoggerFactory $logger ) : void
$logger Horde_ActiveSync_Interface_LoggerFactory The logger object.
리턴 void

setProvisioning() 공개 메소드

Setter for provisioning support
public setProvisioning ( $provision )

setRootCertificatePath() 공개 메소드

Set the local path to the root certificate bundle.
public setRootCertificatePath ( string $path )
$path string The local path to the bundle.

setSupportedVersion() 공개 메소드

Allow to force the highest version to support.
public setSupportedVersion ( float $version )
$version float The highest version

versionHeader() 공개 메소드

Send the protocol versions header.
public versionHeader ( )

프로퍼티 상세

$_certPath 보호되어 있는 프로퍼티

Path to root certificate bundle
protected string $_certPath
리턴 string

$_collectionsObj 보호되어 있는 프로퍼티

The singleton collections handler.
protected Horde_ActiveSync_Collections $_collectionsObj
리턴 Horde_ActiveSync_Collections

$_compression 보호되어 있는 프로퍼티

Support gzip compression of certain data parts?
protected bool $_compression
리턴 boolean

$_decoder 보호되어 있는 프로퍼티

Wbxml decoder
protected Horde_ActiveSync_Wbxml_Decoder $_decoder
리턴 Horde_ActiveSync_Wbxml_Decoder

$_device 보호되어 있는 정적으로 프로퍼티

protected static Horde_ActiveSync_Device $_device
리턴 Horde_ActiveSync_Device

$_encoder 보호되어 있는 프로퍼티

Wbxml encoder
protected Horde_ActiveSync_Wbxml_Encoder $_encoder
리턴 Horde_ActiveSync_Wbxml_Encoder

$_get 보호되어 있는 프로퍼티

Local cache of Get variables/decoded base64 uri
protected array $_get
리턴 array

$_globalError 보호되어 있는 프로퍼티

Global error flag.
protected bool $_globalError
리턴 boolean

$_logger 보호되어 있는 정적으로 프로퍼티

The logger for this class.
protected static Horde_Log_Logger $_logger
리턴 Horde_Log_Logger

$_loggerFactory 보호되어 있는 프로퍼티

Logger
protected Horde_ActiveSync_Interface_LoggerFactory $_loggerFactory
리턴 Horde_ActiveSync_Interface_LoggerFactory

$_maxVersion 보호되어 있는 프로퍼티

Highest version to support.
protected float $_maxVersion
리턴 float

$_multipart 보호되어 있는 프로퍼티

Multipart support?
protected bool $_multipart
리턴 boolean

$_needMsRp 보호되어 있는 프로퍼티

Flag to indicate we need to update the device version.
protected bool $_needMsRp
리턴 boolean

$_procid 보호되어 있는 프로퍼티

Process id (used in logging).
protected int $_procid
리턴 integer

$_provisioning 보호되어 있는 프로퍼티

Provisioning support
protected string $_provisioning
리턴 string

$_supportedVersions 보호되어 있는 정적으로 프로퍼티

Supported EAS versions.
protected static array $_supportedVersions
리턴 array

$_version 보호되어 있는 정적으로 프로퍼티

The actual version we are supporting.
protected static float $_version
리턴 float