Net::LDAP::Entry - An LDAP entry object |
Net::LDAP::Entry - An LDAP entry object
use Net::LDAP;
$ldap = Net::LDAP->new($host); $mesg = $ldap->search(@search_args);
my $max = $mesg->count; for($i = 0 ; $i < $max ; $i++) { my $entry = $mesg->entry($i); foreach my $attr ($entry->attributes) { print join("\n ",$attr, $entry->get_value($attr)),"\n"; } }
# or
use Net::LDAP::Entry;
$entry = Net::LDAP::Entry->new;
$entry->add( attr1 => 'value1', attr2 => [qw(value1 value2)] );
$entry->delete( 'unwanted' );
$entry->replace( attr1 => 'newvalue' attr2 => [qw(new values)] );
$entry->update( $ldap ); # update directory server
$entry2 = $entry->clone; # copies entry
The Net::LDAP::Entry object represents a single entry in the directory. It is a container for attribute-value pairs.
A Net::LDAP::Entry object can be used in two situations. The first and probably most common use is in the result of a search to the directory server.
The other is where a new object is created locally and then a single command is sent to the directory server to add, modify or replace an entry. Entries for this purpose can also be created by reading an LDIF file with the the Net::LDAP::LDIF manpage module.
'add'
$entry->add( 'sn' => 'Barr');
$entry->add( 'street' => [ '1 some road','nowhere']);
NOTE: these changes are local to the client and will not
appear on the directory server until the update
method
is called.
OPTIONS is a list of name/value pairs, valid options are :-
name: Graham Barr name;en-us: Bob jpeg;binary: **binary data**
then
@values = $entry->attributes() print "default: @values\n";
@values = $entry->attributes( nooptions => 1); print "nooptions: @values\n";
will output
default: name name;en-us jpeg;binary nooptions: name jpeg
Possible values for TYPE are
$entry->delete( 'mail' => [ 'foo.bar@example.com' ] ); $entry->delete( 'description' => [ ], 'streetAddress' => [ ] );
NOTE: these changes are local to the client and will not
appear on the directory server until the update
method
is called.
dn
will return
the current DN. If an argument is given then it will change the DN
for the entry and return the previous value.
NOTE: these changes are local to the client and will not
appear on the directory server until the update
method
is called.
The return value may be changed by OPTIONS, which is a list of name => value pairs, valid options are :-
name: Graham Barr name;en-us: Bob
Then a get for attribute ``name'' with alloptions set to a true value
$ref = $entry->get_value( 'name', alloptions => 1);
will return a hash reference that would be like
{ '' => [ 'Graham Barr' ], ';en-us' => [ 'Bob' ] }
$scalar = $entry->get_value('name');
$scalar will be the first value for the name
attribute, or undef
if the
entry does not contain a name
attribute.
$ref = $entry->get_value('name', asref => 1);
$ref will be a reference to an array, which will have all the values for
the name
attribute. If the entry does not have an attribute called name
then $ref will be undef
NOTE: In the interest of performance the array references returned by get_value
are references to structures held inside the entry object. These values and
thier contents should NOT be modified directly.
NOTE: these changes are local to the client and will not
appear on the directory server until the update
method
is called.
This method can also be used to modify the DN of the entry on the server, by specifying moddn or modrdn as the changetype, and setting the entry attributes newrdn, deleteoldrdn, and (optionally) newsuperior.
CLIENT is a Net::LDAP
object where the update will be sent to.
The result will be an object of type the Net::LDAP::Message manpage as returned by the add, modify or delete method called on CLIENT.
the Net::LDAP manpage, the Net::LDAP::LDIF manpage
Graham Barr <gbarr@pobox.com>.
Please report any bugs, or post any suggestions, to the perl-ldap mailing list <perl-ldap@perl.org>.
Copyright (c) 1997-2000 Graham Barr. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
$Id: Entry.pod,v 1.11 2003/05/07 10:57:16 chrisridd Exp $
Net::LDAP::Entry - An LDAP entry object |