PHP Класс Horde_Kolab_Server_Decorator_Map, horde

Copyright 2008-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
См. ссылку: http://pear.horde.org/index.php?package=Kolab_Server
Автор: Gunnar Wrobel ([email protected])
Наследование: implements Horde_Kolab_Server_Interface
Показать файл Открыть проект

Открытые методы

Метод Описание
__construct ( Horde_Kolab_Server_Interface $server, array $mapping ) Constructor.
add ( Horde_Kolab_Server_Object_Interface $object, array $data ) : null Add new object data.
connect ( string $user = null, string $pass = null ) : NULL. Connect to the server. Use this method if the user name you can provide does not match a GUID. In this case it will be required to map this user name first.
connectGuid ( string $guid = '', string $pass = '' ) : NULL. Connect to the server.
delete ( string $guid ) : null Delete an object.
find ( string $query, array $params = [] ) : array Finds object data matching a given set of criteria.
findBelow ( string $query, string $parent, array $params = [] ) : array Finds all object data below a parent matching a given set of criteria.
getBaseGuid ( ) : string Get the base GUID of this server
getGuid ( ) : string Get the current GUID
getParentGuid ( string $guid ) : string Get the parent GUID of this object.
getSchema ( ) : Horde_Ldap_Schema Return the ldap schema.
mapField ( array $field ) : The Map a single attribute key defined within this library into its real world counterpart.
read ( string $guid, array $attrs = [] ) : array Low level access to reading object data.
readAttributes ( string $guid, array $attrs ) : array Low level access to reading some object attributes.
rename ( string $guid, string $new ) : null Rename an object.
save ( Horde_Kolab_Server_Object_Interface $object, array $data ) : null Modify existing object data.

Защищенные методы

Метод Описание
mapAttributes ( &$data ) : null Map attributes defined within this library into their real world counterparts.
mapKeys ( &$keys ) : null Map attribute keys defined within this library into their real world counterparts.
unmapAttributes ( &$data ) : null Map attributes defined within this library to their real world counterparts.

Описание методов

__construct() публичный Метод

Constructor.
public __construct ( Horde_Kolab_Server_Interface $server, array $mapping )
$server Horde_Kolab_Server_Interface The base server connection.
$mapping array The attribute mapping.

add() публичный Метод

Add new object data.
public add ( Horde_Kolab_Server_Object_Interface $object, array $data ) : null
$object Horde_Kolab_Server_Object_Interface
$data array The attributes of the object to be added.
Результат null

connect() публичный Метод

Connect to the server. Use this method if the user name you can provide does not match a GUID. In this case it will be required to map this user name first.
public connect ( string $user = null, string $pass = null ) : NULL.
$user string The user name.
$pass string The password.
Результат NULL.

connectGuid() публичный Метод

Connect to the server.
public connectGuid ( string $guid = '', string $pass = '' ) : NULL.
$guid string The global unique id of the user.
$pass string The password.
Результат NULL.

delete() публичный Метод

Delete an object.
public delete ( string $guid ) : null
$guid string The GUID of the object to be deleted.
Результат null

find() публичный Метод

Finds object data matching a given set of criteria.
public find ( string $query, array $params = [] ) : array
$query string The LDAP search query
$params array Additional search parameters.
Результат array The result array.

findBelow() публичный Метод

Finds all object data below a parent matching a given set of criteria.
public findBelow ( string $query, string $parent, array $params = [] ) : array
$query string The LDAP search query
$parent string The parent to search below.
$params array Additional search parameters.
Результат array The result array.

getBaseGuid() публичный Метод

Get the base GUID of this server
public getBaseGuid ( ) : string
Результат string The base GUID of this server.

getGuid() публичный Метод

Get the current GUID
public getGuid ( ) : string
Результат string The GUID of the connected user.

getParentGuid() публичный Метод

Get the parent GUID of this object.
public getParentGuid ( string $guid ) : string
$guid string The GUID of the child.
Результат string the parent GUID of this object.

getSchema() публичный Метод

Return the ldap schema.
public getSchema ( ) : Horde_Ldap_Schema
Результат Horde_Ldap_Schema The LDAP schema.

mapAttributes() защищенный Метод

Map attributes defined within this library into their real world counterparts.
protected mapAttributes ( &$data ) : null
Результат null

mapField() публичный Метод

Map a single attribute key defined within this library into its real world counterpart.
public mapField ( array $field ) : The
$field array The attribute name.
Результат The real name of this attribute on the server we connect to.

mapKeys() защищенный Метод

Map attribute keys defined within this library into their real world counterparts.
protected mapKeys ( &$keys ) : null
Результат null

read() публичный Метод

Low level access to reading object data.
public read ( string $guid, array $attrs = [] ) : array
$guid string The object to retrieve.
$attrs array Restrict to these attributes.
Результат array An array of attributes.

readAttributes() публичный Метод

Low level access to reading some object attributes.
См. также: Horde_Kolab_Server::read
public readAttributes ( string $guid, array $attrs ) : array
$guid string The object to retrieve.
$attrs array Restrict to these attributes.
Результат array An array of attributes.

rename() публичный Метод

Rename an object.
public rename ( string $guid, string $new ) : null
$guid string The GUID of the object to be renamed.
$new string The new GUID of the object.
Результат null

save() публичный Метод

Modify existing object data.
public save ( Horde_Kolab_Server_Object_Interface $object, array $data ) : null
$object Horde_Kolab_Server_Object_Interface
$data array The attributes of the object to be added.
Результат null

unmapAttributes() защищенный Метод

Map attributes defined within this library to their real world counterparts.
protected unmapAttributes ( &$data ) : null
Результат null