| Property | Type | Description | |
|---|---|---|---|
| $commandType | string | @since 2.31.0 | |
| $flags | Horde_ActiveSync::FLAG_ | Message flags |
| Property | Type | Description | |
|---|---|---|---|
| $_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. |
| Method | Description | |
|---|---|---|
| __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. |
| Method | Description | |
|---|---|---|
| _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. |
| Method | Description | |
|---|---|---|
| _hex2bin ( string $data ) : string | Function which converts a hex entryid to a binary entryid. |
| 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 |
| return | Horde_ActiveSync_Message_Base | |
| protected _checkSendEmpty ( string $tag ) : boolean | ||
| $tag | string | The tag name |
| return | boolean | |
| 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 |
| return | string | The formatted date |
| protected _getAttribute ( string $name, stting $default = null ) : mixed | ||
| $name | string | The property name |
| $default | stting | The default value to return if $property is empty |
| return | mixed | |
| protected _parseDate ( string $ts ) : Horde_Date | boolean | ||
| $ts | string | The timestamp |
| return | Horde_Date | boolean | The Horde_Date or false if unable to decode. |
| protected _preEncodeValidation ( ) : boolean | ||
| return | boolean | True if values were valid (or could be made valid). False if values are unable to be validated. |
| protected _validateDecodedValues ( ) : boolean | ||
| return | boolean | True on success, otherwise false. |
| public decodeStream ( Horde_ActiveSync_Wbxml_Decoder &$decoder ) | ||
| $decoder | Horde_ActiveSync_Wbxml_Decoder | |
| public encodeStream ( Horde_ActiveSync_Wbxml_Encoder &$encoder ) | ||
| $encoder | Horde_ActiveSync_Wbxml_Encoder | The wbxml stream encoder |
| public getProtocolVersion ( ) : float | ||
| return | float | A Horde_ActiveSync::VERSION_* constant. |
| public getSupported ( ) : array | ||
| return | array | The array of non-ghosted properties |
| public propertyExists ( string $property ) : boolean | ||
| $property | string | The property name |
| return | boolean | |
| 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. |
| protected Horde_ActiveSync_Device $_device | ||
| return | Horde_ActiveSync_Device | |
| protected array $_exists | ||
| return | array | |
| protected array $_mapping | ||
| return | array | |
| protected array $_streamFilters | ||
| return | array | |
| protected array $_supported | ||
| return | array | |
| protected float $_version | ||
| return | float | |
