| Method | Description | |
|---|---|---|
| __construct ( string $name = '', array $params = [] ) | Constructor function. | |
| hasPermission ( integer $perm ) : boolean | Checks if the current user has the requested permissions on this source. This source is always read only. |
| Method | Description | |
|---|---|---|
| _getAddressBook ( ) | TODO | |
| _read ( string $key, mixed $ids, string $owner, array $fields, array $blobFields = [], array $dateFields = [] ) : array | Reads the given data from the address book and returns the results. | |
| _search ( array $criteria, array $fields, array $blobFields = [], $count_only = false ) : array | Searches the group list with the given criteria and returns a filtered list of results. If the criteria parameter is an empty array, all records will be returned. |
| public __construct ( string $name = '', array $params = [] ) | ||
| $name | string | Source name |
| $params | array | Hash containing additional configuration parameters. |
| protected _read ( string $key, mixed $ids, string $owner, array $fields, array $blobFields = [], array $dateFields = [] ) : array | ||
| $key | string | The primary key field to use. |
| $ids | mixed | The ids of the contacts to load. |
| $owner | string | Only return contacts owned by this user. |
| $fields | array | List of fields to return. |
| $blobFields | array | Array of fields containing binary data. |
| $dateFields | array | Array of fields containing date data. @since 4.2.0 |
| return | array | Hash containing the search results. |
| protected _search ( array $criteria, array $fields, array $blobFields = [], $count_only = false ) : array | ||
| $criteria | array | Array containing the search criteria. |
| $fields | array | List of fields to return. |
| $blobFields | array | A list of fields that contain binary data. |
| return | array | Hash containing the search results. |
| public hasPermission ( integer $perm ) : boolean | ||
| $perm | integer | The permission to check for. |
| return | boolean | True if the user has permission, otherwise false. |