| Property | Type | Description | |
|---|---|---|---|
| $_authenticated | boolean | Holds if we are authenticated. | |
| $_bookName | string | The name of the addressbook. | |
| $_capabilities | array | Driver capabilities. | |
| $_groupField | string | Holds name of the field indicating an IMSP group. | |
| $_groupValue | string | Holds value that $_groupField will have if entry is an IMSP group. | |
| $_imsp | Horde_Imsp | Horde_Imsp object | |
| $_noGroups | boolean | Used to set if the current search is for contacts only. |
| Method | Description | |
|---|---|---|
| __construct ( string $name = '', array $params = [] ) | Constructs a new Turba imsp driver object. | |
| _sendSearch ( array $criteria ) : array | Sends a search request to the server. | |
| checkDefaultShare ( $share, $srcConfig ) : TODO | Check if the passed in share is the default share for this source. | |
| createShare ( $share_id, $params ) : Horde_Share | Creates a new Horde_Share and creates the address book on the IMSP server. | |
| hasPermission ( integer $perm ) : boolean | Checks if the current user has the requested permission on this source. |
| Method | Description | |
|---|---|---|
| _aclToHordePerms ( string $acl ) : integer | Converts an acl string to a Horde Permissions bitmask. | |
| _add ( array $attributes, array $blob_fields = [], array $date_fields = [] ) | Adds the specified contact to the addressbook. | |
| _canAdd ( ) | TODO | |
| _countDelimiters ( string $in ) : integer | Helper function to count the occurances of the ':' * delimiter in group member entries. | |
| _delete ( $object_key, $object_id ) | Deletes the specified object from the IMSP server. | |
| _deleteAll ( ) | Deletes the address book represented by this driver from the IMSP server. | |
| _doSearch ( array $criteria, string $glue ) : array | Parses the search criteria, requests the individual searches from the server and performs any necessary ANDs / ORs on the results. | |
| _getContactOwner ( ) : string | Returns the owner for this contact. For an IMSP source, this should be the name of the address book. | |
| _getDuplicated ( array $names ) : array | Returns only those names that are duplicated in $names | |
| _getGroupEmails ( string $emailText ) : array | Parses out $emailText into an array of pure email addresses suitable for searching the IMSP datastore with. | |
| _makeKey ( array $attributes ) : string | Create an object key for a new object. | |
| _read ( string $key, mixed $ids, string $owner, array $fields, array $blobFields = [] ) : array | Reads the given data from the address book and returns the results. | |
| _removeDuplicated ( array $names ) : array | Returns an array with all duplicate names removed. | |
| _save ( Turba_Object $object ) : string | Saves the specified object to the IMSP server. | |
| _search ( array $criteria, array $fields, array $blobFields = [], $count_only = false ) : array | Returns all entries matching $critera. |
| public __construct ( string $name = '', array $params = [] ) | ||
| $name | string | Source name |
| $params | array | Hash containing additional configuration parameters. |
| protected _aclToHordePerms ( string $acl ) : integer | ||
| $acl | string | A standard, IMAP style acl string. |
| return | integer | Horde Permissions bitmask. |
| protected _countDelimiters ( string $in ) : integer | ||
| $in | string | The group member entry. |
| return | integer | The number of ':' in $in. |
| protected _delete ( $object_key, $object_id ) |
| protected _deleteAll ( ) |
| protected _getContactOwner ( ) : string | ||
| return | string | TODO |
| protected _getDuplicated ( array $names ) : array | ||
| $names | array | A nested array of arrays containing names |
| return | array | Array containing the 'AND' of all arrays in $names |
| protected _getGroupEmails ( string $emailText ) : array | ||
| $emailText | string | Single string containing email addressses. |
| return | array | Pure email address. |
| protected _read ( string $key, mixed $ids, string $owner, array $fields, array $blobFields = [] ) : array | ||
| $key | string | The primary key field to use (always 'name' for IMSP). |
| $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. |
| return | array | Hash containing the search results. |
| protected _removeDuplicated ( array $names ) : array | ||
| $names | array | Nested array of arrays containing names. |
| return | array | Array containg the 'OR' of all arrays in $names. |
| public _sendSearch ( array $criteria ) : array | ||
| $criteria | array | Array containing the search critera. |
| return | array | Array containing a list of names that match the search. |
| public hasPermission ( integer $perm ) : boolean | ||
| $perm | integer | The permission to check for. |
| return | boolean | true if user has permission, false otherwise. |
| protected bool $_authenticated | ||
| return | boolean | |
| protected string $_bookName | ||
| return | string | |
| protected array $_capabilities | ||
| return | array | |
| protected string $_groupField | ||
| return | string | |
| protected string $_groupValue | ||
| return | string | |
| protected bool $_noGroups | ||
| return | boolean | |