Class: Net_LDAP_Entry

none Net_LDAP_Entry( Net_LDAP|ressource|array &$ldap, [string|ressource $entry = null])

Internal Constructor

Constructor of the entry. Sets up the distinguished name and the entries attributes. You should not call this method manually! Use Net_LDAP_Entry::createFresh() instead!

Parameters:

true|Net_LDAP_Error add( [array $attr = array()])

Adds a new attribute or a new value to an existing attribute

The paramter has to be an array of the form: array('attributename' => 'single value', 'attributename' => array('value1', 'value2)) When the attribute already exists the values will be added, else the attribute will be created. These changes are local to the entry and do not affect the entry on the server until update() is called.

Note, that you can add values of attributes that you haven't selected, but if you do so, getValue() and getValues() will only return the values you added, _NOT_ all values present on the server. To avoid this, just refetch the entry after calling update() or select the attribute.

Parameters:

array attributes( )

Returns an array of attributes names

Net_LDAP_Entry createFresh( string $dn, [array $attrs = array()])

Creates a fresh entry that may be added to the directory later on

The method should be called statically: $entry = Net_LDAP_Entry::createFresh();

Use this method, if you want to initialize a fresh entry. The attributes parameter is as following:

 $attrs = array( 'attribute1' => array('value1', 'value2'),

                 'attribute2' => 'single value'
          );

Parameters:

true delete( [string|array $attr = null])

Deletes an whole attribute or a value or the whole entry

The parameter can be one of the following:

"attributename" - The attribute as a whole will be deleted array("attributename1", "attributename2) - All given attributes will be deleted array("attributename" => "value") - The value will be deleted array("attributename" => array("value1", "value2") - The given values will be deleted If $attr is null or omitted , then the whole Entry will be deleted!

These changes are local to the entry and do not affect the entry on the server until update() is called.

Please note that you must select the attribute (at $ldap->search() for example) to be able to delete values of it, Otherwise update() will silently fail and remove nothing.

Parameters:

string|true dn( [string $dn = null])

Get or set the distinguished name of the entry

If called without an argument the current (or the new DN if set) DN gets returned. If you provide an DN, this entry is moved to the new location specified if a DN existed. If the DN was not set, the DN gets initialized. Call update() to actually create the new Entry in the directory.

Please note that special characters (eg german umlauts) should be encoded using utf8_encode().

Parameters:

boolean exists( string $attr)

Returns whether an attribute exists or not

Parameters:

Net_LDAP|Net_LDAP_Error &getLDAP( )

Returns a reference to the LDAP-Object of this entry

string|array|PEAR_Error getValue( string $attr, [string $option = null])

Get the value of a specific attribute

The first parameter is the name of the attribute The second parameter influences the way the value is returned: 'single': only the first value is returned as string 'all': all values including the value count are returned in an array 'default': in all other cases an attribute value with a single value is returned as string, if it has multiple values it is returned as an array (without value count)

Parameters:

array getValues( )

Get the values of all attributes in a hash

The returned hash has the form

array('attributename' => 'single value',

       'attributename' => array('value1', value2', value3'))

void get_value( )

Alias function of getValue for perl-ldap interface

boolean|Net_LDAP_Error preg_match( string $regex, string $attr_name, [array $matches = array()])

Applies a regular expression onto a single- or multivalued attribute (like preg_match())

This method behaves like PHPs preg_match() but with some exceptions. If you want to retrieve match information, then you MUST pass the $matches parameter via reference! otherwise you will get no matches. Since it is possible to have multi valued attributes the $matches array will have a additionally numerical dimension (one for each value):

 $matches = array(

         0 => array (usual preg_match() returnarray),
         1 => array (usual preg_match() returnarray)
     )

Please note, that $matches will be initialized to an empty array inside.

Usage example:

 $result = $entry->preg_match('/089(\d+)/', 'telephoneNumber', &$matches);

 if ( $result === true ){
     echo "First match: ".$matches[0][1];   // Match of value 1, content of first bracket
 } else {
     if ( Net_LDAP::isError($result) ) {
         echo "Error: ".$result->getMessage();
     } else {
         echo "No match found.";
     }
 }

Please note that it is important to test for an Net_LDAP_Error, because objects are evaluating to true by default, thus if a error occured, and you only check using "==" then you get misleading results. Use the "identical" (===) operator to test for matches to avoid this as shown above.

Parameters:

true|Net_LDAP_Error replace( [array $attr = array()])

Replaces attributes or its values

The parameter has to an array of the following form: array("attributename" => "single value", "attribute2name" => array("value1", "value2")) If the attribute does not yet exist it will be added instead. If the attribue value is null, the attribute will de deleted

These changes are local to the entry and do not affect the entry on the server until update() is called.

Parameters:

true|Net_LDAP_Error setLDAP( Net_LDAP &$ldap)

Sets a reference to the LDAP-Object of this entry

After setting a Net_LDAP object, calling update() will use that object for updating directory contents. Use this to dynamicly switch directorys.

Parameters:

true|Net_LDAP_Error update( [Net_LDAP $ldap = null])

Update the entry on the directory server

Parameters: