Update of /cvsroot/perl-ldap/ldap/lib/Net/LDAP
In directory sc8-pr-cvs1:/tmp/cvs-serv28185/lib/Net/LDAP
Modified Files:
Schema.pod
Log Message:
Rearranged description of HASHes
Index: Schema.pod
===================================================================
RCS file: /cvsroot/perl-ldap/ldap/lib/Net/LDAP/Schema.pod,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -d -r1.13 -r1.14
--- Schema.pod 5 Aug 2003 13:33:04 -0000 1.13
+++ Schema.pod 16 Aug 2003 08:44:26 -0000 1.14
@@ -32,27 +32,11 @@
or raw oid (object identifier, in dotted numeric string form, e.g. 2.5.4.0)
may be supplied.
-=over 4
-
-=item all_attributes ( )
-
-=item all_ditcontentrules ( )
-
-=item all_ditstructurerules ( )
-
-=item all_matchingrules ( )
-
-=item all_matchingruleuses ( )
-
-=item all_nameforms ( )
-
-=item all_objectclasses ( )
-
-=item all_syntaxes ( )
-
-Returns a list of all the requested types in the schema. Each item in
-the list is a reference to a HASH; the various keys in each HASH are
-named after the keys defined in RFC 2252:
+Each returned item of schema (eg an attribute definition) is returned
+in a HASH. The keys in the returned HASH are lowercased versions of
+the keys read from the server. Here's a partial list (not all HASHes
+define all keys) although note that RFC 2252 permits other keys as
+well:
name
desc
@@ -77,6 +61,26 @@
oc
form
+=over 4
+
+=item all_attributes ( )
+
+=item all_ditcontentrules ( )
+
+=item all_ditstructurerules ( )
+
+=item all_matchingrules ( )
+
+=item all_matchingruleuses ( )
+
+=item all_nameforms ( )
+
+=item all_objectclasses ( )
+
+=item all_syntaxes ( )
+
+Returns a list of all the requested types in the schema.
+
=item attribute ( NAME )
=item ditcontentrule ( NAME )
@@ -113,19 +117,22 @@
=item error ( )
-Returns the last error encountered.
+Returns the last error encountered when parsing the schema.
=item may ( OBJECTCLASS )
Given an argument which is the name or oid of a known object class,
-returns the names of the attributes which are optional in the class.
+returns a list of HASHes describing the attributes which are optional
+in the class.
@may = $schema->may ( $oc );
+ # First optional attr has the name '$may[0]->{name}'
=item must ( OBJECTCLASS )
Given an argument which is the name or oid of a known object class,
-returns the names of the attributes which are mandatory in the class
+returns a list of HASHes describing the attributes which are mandatory
+in the class.
@must = $schema->must ( $oc );
|
