cvs: peardoc /en/package/networking net-ldap2.xml /en/package/networking/net-ldap2 schemacache.xml
[email protected] ("Benedikt Hallinger")
| Newsgroups | php.pear.doc |
|---|---|
| Message-ID | <cvsbeni1243947721@cvsserver> |
beni Tue Jun 2 13:02:01 2009 UTC
Modified files:
/peardoc/en/package/networking net-ldap2.xml
/peardoc/en/package/networking/net-ldap2 schemacache.xml
Log:
* Some little fixes in Net_LDAP2 docs
http://cvs.php.net/viewvc.cgi/peardoc/en/package/networking/net-ldap2.xml?r1=1.2&r2=1.3&diff_format=u
Index: peardoc/en/package/networking/net-ldap2.xml
diff -u peardoc/en/package/networking/net-ldap2.xml:1.2 peardoc/en/package/networking/net-ldap2.xml:1.3
--- peardoc/en/package/networking/net-ldap2.xml:1.2 Tue Jun 2 12:25:30 2009
+++ peardoc/en/package/networking/net-ldap2.xml Tue Jun 2 13:02:00 2009
@@ -28,5 +28,6 @@
&package.networking.net-ldap2.entries;
&package.networking.net-ldap2.filter;
&package.networking.net-ldap2.ldif;
+ &package.networking.net-ldap2.schemacache;
</chapter>
</book>
http://cvs.php.net/viewvc.cgi/peardoc/en/package/networking/net-ldap2/schemacache.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/package/networking/net-ldap2/schemacache.xml
diff -u peardoc/en/package/networking/net-ldap2/schemacache.xml:1.1 peardoc/en/package/networking/net-ldap2/schemacache.xml:1.2
--- peardoc/en/package/networking/net-ldap2/schemacache.xml:1.1 Thu May 28 09:47:18 2009
+++ peardoc/en/package/networking/net-ldap2/schemacache.xml Tue Jun 2 13:02:00 2009
@@ -6,19 +6,19 @@
</refnamediv>
<refsection><info><title>Net_LDAP2s schema caching facility</title></info>
- <para>
+ <para>
<classname>Net_LDAP2</classname> features an easy schema caching facility.
Caching the schema can gain some performance, especially with slow servers or connections.
The facility works with an plugin object that must be passed to <classname>Net_LDAP2</classname>s
<function>registerSchemaCache</function> method. The cache object can be registered (or unregistered)
- at any time, but of course it is the best time right after initializing <classname>Net_LDAP</classname>.
-
+ at any time, but of course it is the best time right after initializing <classname>Net_LDAP2</classname>.
+
<example><info><title>Enabling/disabling Net_LDAP2s schema caching facility</title></info>
<programlisting role="php"><![CDATA[
// registering a valid schema cache object is enough to enable the caching facility:
$ldap->registerSchemaCache($myCacheObject);
-// unregistering is easy too: just supply null:
+// unregistering is easy too: just supply null as schema cache object:
$ldap->registerSchemaCache(null);
]]>
</programlisting>
@@ -27,9 +27,9 @@
<para>
The object that gets passed to <function>registerSchemaCache</function> must implement the
<classname>Net_LDAP2_SchemaCache</classname> interface which demands two methods.
- Initialisation of the cache object is dependent on the class itself. Initialisation should
- be handled inside the cache constructor, however this may vary. Please refer to the cache
- documentation for those details.
+ Initialisation of the cache object is dependent on the class itself but should
+ be handled inside the cache class constructor, however this may vary. Please refer to the cache
+ class documentation for those details.
<table><title><classname>Net_LDAP2_SchemaCache</classname> interface methods</title>
<tgroup cols="2">
<thead>
@@ -42,7 +42,7 @@
</thead>
<tbody>
<row>
- <entry>loadSchema</entry>
+ <entry><function>loadSchema</function></entry>
<entry>none</entry>
<entry>
<classname>Net_LDAP2_Schema</classname>,
@@ -57,7 +57,7 @@
</entry>
</row>
<row>
- <entry>storeSchema</entry>
+ <entry><function>storeSchema</function></entry>
<entry><classname>Net_LDAP2_Schema</classname> object</entry>
<entry><literal>true</literal> or (in special cases) <classname>Net_LDAP2_Error</classname></entry>
<entry>
@@ -80,7 +80,10 @@
<refsection><info><title>Packaged schema cache classes</title></info>
<para>
- As of Net_LDAP2 2.0.0, there is one default schema caching class: <classname>Net_LDAP2_SimpleFileSchemaCache</classname>.
+ As of Net_LDAP2 2.0.0, there is one default schema caching class: <classname>Net_LDAP2_SimpleFileSchemaCache</classname>
+ to make your life a little easier. Caching to files should also be the most commonly used case.
+ </para>
+ <para>
This cache class is built to be flexible yet simple to use and may serve as example to write own caching classes.
This cache stores the schema object in a flat file. The path is freely configurable. It also servers a cache aging
mechanism that can be used to invalidate the cached schema after some time so it will be refreshed regularly.
@@ -114,7 +117,7 @@
<row>
<entry><literal>path</literal></entry>
<entry>No</entry>
- <entry><litral>/tmp/Net_LDAP_Schema.cache</literal></entry>
+ <entry><literal>/tmp/Net_LDAP_Schema.cache</literal></entry>
<entry>
The full path to the cache file. To improve the caches performance under linux,
you can place the cache file in a tmpfs mounted directory. This will put the file
@@ -124,7 +127,7 @@
<row>
<entry><literal>max_age</literal></entry>
<entry>No</entry>
- <entry><litral>1200</literal></entry>
+ <entry><literal>1200</literal></entry>
<entry>
Maximum cache age in seconds. The age of the cache is determined by the files
last change time. If <literal>max_age</literal> is reached, Net_LDAP2 will fetch