PHP 클래스 Horde_ActiveSync_Message_Base, horde

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

공개 프로퍼티들

프로퍼티 타입 설명
$commandType string @since 2.31.0
$flags Horde_ActiveSync::FLAG_ Message flags

보호된 프로퍼티들

프로퍼티 타입 설명
$_device Horde_ActiveSync_Device The device object
$_exists array Existence cache, used for working with ghosted properties.
$_logger Horde_Log_Logger Logger
$_mapping array Holds the mapping for object properties
$_properties array Holds property values
$_streamFilters array Cache of current stream filters.
$_supported array An array describing the non-ghosted elements this message supports.
$_version float The version of EAS we are to support.

공개 메소드들

메소드 설명
__call ( mixed $method, array $arg ) : mixed Magic caller method.
__construct ( array $options = [] ) : Horde_ActiveSync_Message_Base Const'r
__destruct ( )
__get ( string $property ) : mixed Accessor
__isset ( string $property ) : boolean. Magic method.
__set ( string $property, mixed $value ) Setter
decodeStream ( Horde_ActiveSync_Wbxml_Decoder &$decoder ) Recursively decodes the WBXML from input stream. This means that if this message contains complex types (like Appointment.Recuurence for example) the sub-objects are auto-instantiated and decoded as well. Places the decoded objects in the local properties array.
encodeStream ( Horde_ActiveSync_Wbxml_Encoder &$encoder ) Encodes this object (and any sub-objects) as wbxml to the output stream.
getProtocolVersion ( ) : float Return the EAS version this object supports.
getSupported ( ) : array Get the list of non-ghosted properties for this message.
isEmpty ( ) : boolean Returns whether or not this message actually contains any data to send.
isGhosted ( string $property ) : boolean Determines if the property specified has been ghosted by the client.
propertyExists ( string $property ) : boolean Check the existence of a property in this message.
setSupported ( array $fields ) Set the list of non-ghosted fields for this message.

보호된 메소드들

메소드 설명
_checkEncoding ( mixed $data, string $tag ) : mixed Checks if the data needs to be encoded like e.g., when outputing binary data in-line during ITEMOPERATIONS requests. Concrete classes should override this if needed.
_checkSendEmpty ( string $tag ) : boolean Checks to see if we should send an empty value.
_formatDate ( Horde_Date $dt, integer $type ) : string Oh yeah. This is beautiful. Exchange outputs date fields differently in calendar items and emails. We could just always send one or the other, but unfortunately nokia's 'Mail for exchange' depends on this quirk.
_getAttribute ( string $name, stting $default = null ) : mixed Helper method to allow default values for unset properties.
_parseDate ( string $ts ) : Horde_Date | boolean Get a Horde_Date from a timestamp, ensuring it's in the correct format.
_preEncodeValidation ( ) : boolean Give concrete classes the chance to enforce rules before encoding messages to send to the client.
_validateDecodedValues ( ) : boolean Give concrete classes the chance to enforce rules.

비공개 메소드들

메소드 설명
_hex2bin ( string $data ) : string Function which converts a hex entryid to a binary entryid.

메소드 상세

__call() 공개 메소드

Magic caller method.
public __call ( mixed $method, array $arg ) : mixed
$method mixed The method to call.
$arg array Method arguments.
리턴 mixed

__construct() 공개 메소드

Const'r
public __construct ( array $options = [] ) : Horde_ActiveSync_Message_Base
$options array Configuration options for the message: - logger: (Horde_Log_Logger) A logger instance DEFAULT: none (No logging). - protocolversion: (float) The version of EAS to support. DEFAULT: Horde_ActiveSync::VERSION_TWOFIVE (2.5) - device: (Horde_ActiveSync_Device) The device object. @since 2.9.2
리턴 Horde_ActiveSync_Message_Base

__destruct() 공개 메소드

public __destruct ( )

__get() 공개 메소드

Accessor
public __get ( string $property ) : mixed
$property string Property to get.
리턴 mixed The value of the requested property.

__isset() 공개 메소드

Magic method.
public __isset ( string $property ) : boolean.
$property string The property name to check.
리턴 boolean.

__set() 공개 메소드

Setter
public __set ( string $property, mixed $value )
$property string The property to set.
$value mixed The value to set it to.

_checkEncoding() 보호된 메소드

Checks if the data needs to be encoded like e.g., when outputing binary data in-line during ITEMOPERATIONS requests. Concrete classes should override this if needed.
protected _checkEncoding ( mixed $data, string $tag ) : mixed
$data mixed The data to check. A string or stream resource.
$tag string The tag we are outputing.
리턴 mixed The encoded data. A string or stream resource with a filter attached.

_checkSendEmpty() 보호된 메소드

Checks to see if we should send an empty value.
protected _checkSendEmpty ( string $tag ) : boolean
$tag string The tag name
리턴 boolean

_formatDate() 보호된 메소드

So we have to send a different date type depending on where it's used. Used when encoding a date value to send to the client.
protected _formatDate ( Horde_Date $dt, integer $type ) : string
$dt Horde_Date The Horde_Date object to format (should normally be in local tz).
$type integer The type to format as: One of TYPE_DATE or TYPE_DATE_DASHES, TYPE_DATE_LOCAL
리턴 string The formatted date

_getAttribute() 보호된 메소드

Helper method to allow default values for unset properties.
protected _getAttribute ( string $name, stting $default = null ) : mixed
$name string The property name
$default stting The default value to return if $property is empty
리턴 mixed

_parseDate() 보호된 메소드

Used when decoding an incoming date value from the client.
protected _parseDate ( string $ts ) : Horde_Date | boolean
$ts string The timestamp
리턴 Horde_Date | boolean The Horde_Date or false if unable to decode.

_preEncodeValidation() 보호된 메소드

Give concrete classes the chance to enforce rules before encoding messages to send to the client.
부터: 2.31.0
protected _preEncodeValidation ( ) : boolean
리턴 boolean True if values were valid (or could be made valid). False if values are unable to be validated.

_validateDecodedValues() 보호된 메소드

Give concrete classes the chance to enforce rules.
부터: 2.31.0
protected _validateDecodedValues ( ) : boolean
리턴 boolean True on success, otherwise false.

decodeStream() 공개 메소드

Recursively decodes the WBXML from input stream. This means that if this message contains complex types (like Appointment.Recuurence for example) the sub-objects are auto-instantiated and decoded as well. Places the decoded objects in the local properties array.
public decodeStream ( Horde_ActiveSync_Wbxml_Decoder &$decoder )
$decoder Horde_ActiveSync_Wbxml_Decoder

encodeStream() 공개 메소드

Output is ordered according to $_mapping
public encodeStream ( Horde_ActiveSync_Wbxml_Encoder &$encoder )
$encoder Horde_ActiveSync_Wbxml_Encoder The wbxml stream encoder

getProtocolVersion() 공개 메소드

Return the EAS version this object supports.
public getProtocolVersion ( ) : float
리턴 float A Horde_ActiveSync::VERSION_* constant.

getSupported() 공개 메소드

Get the list of non-ghosted properties for this message.
public getSupported ( ) : array
리턴 array The array of non-ghosted properties

isEmpty() 공개 메소드

Returns whether or not this message actually contains any data to send.
부터: 2.34.0
public isEmpty ( ) : boolean
리턴 boolean True if message is empty, otherwise false.

isGhosted() 공개 메소드

A property is ghosted if it is NOT listed in the SUPPORTED list sent by the client AND is NOT present in the request data.
public isGhosted ( string $property ) : boolean
$property string The property to check
리턴 boolean

propertyExists() 공개 메소드

Check the existence of a property in this message.
public propertyExists ( string $property ) : boolean
$property string The property name
리턴 boolean

setSupported() 공개 메소드

Set the list of non-ghosted fields for this message.
public setSupported ( array $fields )
$fields array The array of fields, keyed by the fully qualified property name i.e., POOMCONTACTS:Anniversary. To signify an empty SUPPORTED container $fields should contain a single element equal to Horde_ActiveSync::ALL_GHOSTED.

프로퍼티 상세

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

The device object
부터: 2.9.2
protected Horde_ActiveSync_Device $_device
리턴 Horde_ActiveSync_Device

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

Existence cache, used for working with ghosted properties.
protected array $_exists
리턴 array

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

Logger
protected Horde_Log_Logger $_logger
리턴 Horde_Log_Logger

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

Holds the mapping for object properties
protected array $_mapping
리턴 array

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

Holds property values
protected array $_properties
리턴 array

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

Cache of current stream filters.
protected array $_streamFilters
리턴 array

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

An array describing the non-ghosted elements this message supports.
protected array $_supported
리턴 array

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

The version of EAS we are to support.
protected float $_version
리턴 float

$commandType 공개적으로 프로퍼티

@since 2.31.0
public string $commandType
리턴 string

$flags 공개적으로 프로퍼티

Message flags
public Horde_ActiveSync::FLAG_ $flags
리턴 Horde_ActiveSync::FLAG_