Property | Type | Description | |
---|---|---|---|
$_client | Horde_Http_Client | HTTP client | |
$_cookies | array | All cookies to sent with OX requests. | |
$_folderType | string | The folder category. | |
$_params | array | Any parameters. | |
$_session | string | The current session ID. | |
$_uri | string | Base URI of the API endpoint. |
Method | Description | |
---|---|---|
__construct ( array $params = [] ) | Constructor. | |
getConfig ( string $config ) : mixed | Returns user configuration. | |
getGroup ( integer $id ) : array | Returns information about a system group. | |
getUser ( integer $id ) : array | Returns information about a system user. | |
listResources ( string $type = self::RESOURCE_PRIVATE ) : array | Returns a list of visible groupware resources. | |
login ( string $user, string $password ) | Logs a user in. | |
logout ( ) | Logs the current user out. |
Method | Description | |
---|---|---|
_login ( ) | Logs a user in, if necessary. | |
_request ( string $method, string $namespace, array $params, array | string $data = [] ) : array | Sends a request and parses the response. |
public __construct ( array $params = [] ) | ||
$params | array | List of optional parameters: - client: (Horde_Http_Client) An HTTP client. - endpoint: (string) The URI of the OX API endpoint. - user: (string) Authentication user. - password: (string) Authentication password. |
protected _request ( string $method, string $namespace, array $params, array | string $data = [] ) : array | ||
$method | string | A HTTP request method (uppercase). |
$namespace | string | An API namespace. |
$params | array | URL parameters. |
$data | array | string | Request data. |
return | array | The decoded result data or null if no data has been returned but the request was still successful. |
public listResources ( string $type = self::RESOURCE_PRIVATE ) : array | ||
$type | string | An resource type, one of the RESOURCE_* constants. |
return | array | List of resources with resource IDs as keys and information hashes as values. |
protected Horde_Http_Client $_client | ||
return | Horde_Http_Client |
protected array $_cookies | ||
return | array |