API Documentation
\

\Horde_ActiveSync_Request_Search

Handle Search requests.

Summary

Methods
Properties
Constants
__construct()
checkPolicyKey()
setLogger()
handle()
No public properties found
SEARCH_SEARCH
SEARCH_STORE
SEARCH_NAME
SEARCH_QUERY
SEARCH_OPTIONS
SEARCH_RANGE
SEARCH_STATUS
SEARCH_RESPONSE
SEARCH_RESULT
SEARCH_PROPERTIES
SEARCH_TOTAL
SEARCH_EQUALTO
SEARCH_VALUE
SEARCH_AND
SEARCH_OR
SEARCH_FREETEXT
SEARCH_DEEPTRAVERSAL
SEARCH_LONGID
SEARCH_REBUILDRESULTS
SEARCH_LESSTHAN
SEARCH_GREATERTHAN
SEARCH_SCHEMA
SEARCH_SUPPORTED
SEARCH_USERNAME
SEARCH_PASSWORD
SEARCH_CONVERSATIONID
SEARCH_PICTURE
SEARCH_MAXSIZE
SEARCH_MAXPICTURES
SEARCH_STATUS_SUCCESS
SEARCH_STATUS_ERROR
STATUS_PROTERROR
STORE_STATUS_SUCCESS
STORE_STATUS_PROTERR
STORE_STATUS_SERVERERR
STORE_STATUS_BADLINK
STORE_STATUS_NOTFOUND
STORE_STATUS_CONNECTIONERR
STORE_STATUS_COMPLEX
_bodyPartPrefs()
_bodyPrefs()
_rightsManagement()
_mimeSupport()
_cleanUpAfterPairing()
_requireProvisionWbxml()
_handle()
_parseQuery()
_handleError()
$_driver
$_state
$_encoder
$_decoder
$_request
$_provisioning
$_statusCode
$_activeSync
$_logger
$_device
$_procid
$_collections
N/A
No private methods found
No private properties found
N/A

Constants

SEARCH_STORE

SEARCH_STORE

SEARCH_NAME

SEARCH_NAME

SEARCH_QUERY

SEARCH_QUERY

SEARCH_OPTIONS

SEARCH_OPTIONS

SEARCH_RANGE

SEARCH_RANGE

SEARCH_STATUS

SEARCH_STATUS

SEARCH_RESPONSE

SEARCH_RESPONSE

SEARCH_RESULT

SEARCH_RESULT

SEARCH_PROPERTIES

SEARCH_PROPERTIES

SEARCH_TOTAL

SEARCH_TOTAL

SEARCH_EQUALTO

SEARCH_EQUALTO

SEARCH_VALUE

SEARCH_VALUE

SEARCH_AND

SEARCH_AND

SEARCH_OR

SEARCH_OR

SEARCH_FREETEXT

SEARCH_FREETEXT

SEARCH_DEEPTRAVERSAL

SEARCH_DEEPTRAVERSAL

SEARCH_LONGID

SEARCH_LONGID

SEARCH_REBUILDRESULTS

SEARCH_REBUILDRESULTS

SEARCH_LESSTHAN

SEARCH_LESSTHAN

SEARCH_GREATERTHAN

SEARCH_GREATERTHAN

SEARCH_SCHEMA

SEARCH_SCHEMA

SEARCH_SUPPORTED

SEARCH_SUPPORTED

SEARCH_USERNAME

SEARCH_USERNAME

SEARCH_PASSWORD

SEARCH_PASSWORD

SEARCH_CONVERSATIONID

SEARCH_CONVERSATIONID

SEARCH_PICTURE

SEARCH_PICTURE

SEARCH_MAXSIZE

SEARCH_MAXSIZE

SEARCH_MAXPICTURES

SEARCH_MAXPICTURES

SEARCH_STATUS_SUCCESS

SEARCH_STATUS_SUCCESS

Search Status *

SEARCH_STATUS_ERROR

SEARCH_STATUS_ERROR

STATUS_PROTERROR

STATUS_PROTERROR

Compat *

STORE_STATUS_SUCCESS

STORE_STATUS_SUCCESS

Store Status *

STORE_STATUS_PROTERR

STORE_STATUS_PROTERR

STORE_STATUS_SERVERERR

STORE_STATUS_SERVERERR

STORE_STATUS_NOTFOUND

STORE_STATUS_NOTFOUND

STORE_STATUS_CONNECTIONERR

STORE_STATUS_CONNECTIONERR

STORE_STATUS_COMPLEX

STORE_STATUS_COMPLEX

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

_bodyPartPrefs()

_bodyPartPrefs(array  $options)

Parse incoming BODYPARTPREFERENCE options.

Parameters

array $options

An array structure to parse the data into.

_bodyPrefs()

_bodyPrefs(  $options)

Parse incoming BODYPREFERENCE options.

Parameters

$options

_rightsManagement()

_rightsManagement(  $collection)

Parameters

$collection

_mimeSupport()

_mimeSupport(  $collection)

Parameters

$collection

_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 request

Returns

boolean

_parseQuery()

_parseQuery(boolean  $subquery = null) : array

Receive, and parse, the incoming wbxml query.

According to MS docs, OR is supported in the protocol, but will ALWAYS return a searchToComplex status in Exchange 2007. Additionally, AND is ONLY supported as the topmost element. No nested AND is allowed. All such queries will return a searchToComplex status.

Parameters

boolean $subquery

Parsing a subquery.

Returns

array

_handleError()

_handleError(array  $data)

Parameters

array $data