You are viewing a plain text version of this content. The canonical link for it is here.
Posted to zeta-commits@incubator.apache.org by je...@apache.org on 2011/07/10 17:31:24 UTC
[zeta-commits] svn commit: r1144915 [23/37] - in /incubator/zetacomponents:
trunk/Authentication/docs/ trunk/AuthenticationDatabaseTiein/docs/
trunk/Base/docs/ trunk/Configuration/docs/ trunk/Document/docs/
trunk/EventLog/docs/ trunk/Feed/docs/ trunk/File/docs/ trunk...
Modified: incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageOptions.html
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageOptions.html?rev=1144915&r1=1144914&r2=1144915&view=diff
==============================================================================
--- incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageOptions.html (original)
+++ incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageOptions.html Sun Jul 10 17:30:59 2011
@@ -12,13 +12,13 @@
<meta name="keywords" content="" />
<meta name="author" content="jerome" />
<meta name="language" content="en" />
- <meta name="date" content="Wed, 06 Apr 2011 12:38:18 +0200" />
+ <meta name="date" content="Sun, 10 Jul 2011 11:10:50 +0200" />
<meta name="robots" content="all" />
<link rel="schema.DC" href="http://purl.org/dc/elements/1.1/" />
<meta name="DC.title" content="ezcCacheStorageOptions.html" />
<meta name="DC.creator" content="jerome" />
- <meta name="DC.date" content="Wed, 06 Apr 2011 12:38:18 +0200" />
+ <meta name="DC.date" content="Sun, 10 Jul 2011 11:10:50 +0200" />
<meta name="DC.rights" content="Copyright" />
<link rel="meta" href="/zetacomponents/documentation/trunk/Cache/phpdoc/ezcCacheStorageOptions.rdf" />
@@ -68,7 +68,10 @@
<div class="content">
<ul class="tabs">
- <li class="requested">
+ <li >
+ <a href="/zetacomponents/documentation/trunk/Cache/tutorial.html" title="Tutorial">Tutorial</a>
+ </li>
+<li class="requested">
<a href="/zetacomponents/documentation/trunk/Cache/phpdoc/classtrees.html" title="API">API</a>
</li>
@@ -83,28 +86,23 @@
<a name="sec-description"></a>
<h3>Class ezcCacheStorageOptions</h3>
-<p>Option class for the ezcCacheStorage class.</p>
-<div><p>Instances of this class store the options of ezcCacheStorage implementations.</p></div>
+<p>Option class for the ezcCacheStorage class.</p><div><p>Instances of this class store the options of ezcCacheStorage implementations.</p></div>
<p>Source for this file: <a href="http://fisheye6.atlassian.com/browse/zetacomponents/trunk/Cache/src/options/storage.php?r=HEAD">/Cache/src/options/storage.php</a></p>
-<pre><a href="../Base/ezcBaseOptions.html">ezcBaseOptions</a>
+<pre><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseOptions.html">ezcBaseOptions</a>
|
--ezcCacheStorageOptions</pre>
- <table><tr>
-<td>
+ <table><tr><td>
<strong>Version:</strong>  
</td>
<td>//autogentag//</td>
- </tr></table>
-<a name="sec-prop-summary"></a>
+ </tr></table><a name="sec-prop-summary"></a>
<h3>Properties</h3>
- <table class="summary">
-<tr>
-<td class="right">
+ <table class="summary"><tr><td class="right">
<a name="prop%24extension" id="$extension"></a>
<a name="prop-%24extension" id="$extension"></a>
<em>string</em> </td>
@@ -116,9 +114,7 @@
<a href="#prop-%24extension" title="details" class="var-name-summary">$extension</a>
</code>
<br><div style="margin-left: 20px">The (file) extension to use for the storage items.</div> </td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<a name="prop%24ttl" id="$ttl"></a>
<a name="prop-%24ttl" id="$ttl"></a>
<em>int</em> </td>
@@ -130,28 +126,19 @@
<a href="#prop-%24ttl" title="details" class="var-name-summary">$ttl</a>
</code>
<br><div style="margin-left: 20px">The time to live of cache entries.</div> </td>
- </tr>
-</table>
-<h3>Inherited Member Variables</h3>
- <table class="summary">
-<thead><tr>
-<th colspan="2">
- From <span class="classname"><a href="../Base/ezcBaseOptions.html">ezcBaseOptions</a></span>
+ </tr></table><h3>Inherited Member Variables</h3>
+ <table class="summary"><thead><tr><th colspan="2">
+ From <span class="classname"><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseOptions.html">ezcBaseOptions</a></span>
</th>
- </tr></thead>
-<tbody><tr>
-<td class="right">
+ </tr></thead><tbody><tr><td class="right">
<em>protected</em> </td>
<td>
- <code><a href="../Base/ezcBaseOptions.html#var%24properties">ezcBaseOptions::$properties</a></code>
+ <code><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseOptions.html#var%24properties">ezcBaseOptions::$properties</a></code>
</td>
- </tr></tbody>
-</table>
-<a name="sec-method-summary"></a>
+ </tr></tbody></table><a name="sec-method-summary"></a>
<h3>Method Summary</h3>
- <table class="summary"><tr>
-<td class="right">
+ <table class="summary"><tr><td class="right">
<em>public</em> <em>ezcCacheStorageOptions</em> </td>
<td>
<code>
@@ -160,60 +147,41 @@
= array()] )
</code>
<br><div style="margin-left: 20px">Constructs a new options object.</div> </td>
- </tr></table>
-<h3>Inherited Methods</h3>
- <table class="summary">
-<thead><tr>
-<th colspan="2">
- From <span class="classname"><a href="../Base/ezcBaseOptions.html">ezcBaseOptions</a></span>
+ </tr></table><h3>Inherited Methods</h3>
+ <table class="summary"><thead><tr><th colspan="2">
+ From <span class="classname"><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseOptions.html">ezcBaseOptions</a></span>
</th>
- </tr></thead>
-<tbody>
-<tr>
-<td class="right">
+ </tr></thead><tbody><tr><td class="right">
<em>public</em> <em>ezcBaseOptions</em> </td>
<td>
- <code><b><a href="../Base/ezcBaseOptions.html#method__construct">ezcBaseOptions::__construct()</a></b></code>
+ <code><b><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseOptions.html#method__construct">ezcBaseOptions::__construct()</a></b></code>
<br><div style="margin-left: 20px">Construct a new options object.</div> </td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>public</em> <em>void</em> </td>
<td>
- <code><b><a href="../Base/ezcBaseOptions.html#methodmerge">ezcBaseOptions::merge()</a></b></code>
+ <code><b><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseOptions.html#methodmerge">ezcBaseOptions::merge()</a></b></code>
<br><div style="margin-left: 20px">Merge an array into the actual options object.</div> </td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>public</em> <em>bool</em> </td>
<td>
- <code><b><a href="../Base/ezcBaseOptions.html#methodoffsetExists">ezcBaseOptions::offsetExists()</a></b></code>
+ <code><b><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseOptions.html#methodoffsetExists">ezcBaseOptions::offsetExists()</a></b></code>
<br><div style="margin-left: 20px">Returns if an option exists.</div> </td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>public</em> <em>mixed</em> </td>
<td>
- <code><b><a href="../Base/ezcBaseOptions.html#methodoffsetGet">ezcBaseOptions::offsetGet()</a></b></code>
+ <code><b><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseOptions.html#methodoffsetGet">ezcBaseOptions::offsetGet()</a></b></code>
<br><div style="margin-left: 20px">Returns an option value.</div> </td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>public</em> <em>void</em> </td>
<td>
- <code><b><a href="../Base/ezcBaseOptions.html#methodoffsetSet">ezcBaseOptions::offsetSet()</a></b></code>
+ <code><b><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseOptions.html#methodoffsetSet">ezcBaseOptions::offsetSet()</a></b></code>
<br><div style="margin-left: 20px">Set an option.</div> </td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>public</em> <em>void</em> </td>
<td>
- <code><b><a href="../Base/ezcBaseOptions.html#methodoffsetUnset">ezcBaseOptions::offsetUnset()</a></b></code>
+ <code><b><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseOptions.html#methodoffsetUnset">ezcBaseOptions::offsetUnset()</a></b></code>
<br><div style="margin-left: 20px">Unset an option.</div> </td>
- </tr>
-</tbody>
-</table>
-<a name="sec-methods"></a>
+ </tr></tbody></table><a name="sec-methods"></a>
<h3>Methods</h3>
<a name="method_detail"></a>
@@ -229,58 +197,35 @@
= array()] )
</div>
- <p>Constructs a new options object.</p>
-<div><p>It also sets the default values of the format property</p></div>
+ <p>Constructs a new options object.</p><div><p>It also sets the default values of the format property</p></div>
<h5>Parameters:</h5>
- <table class="detail">
-<thead><tr>
-<th>Name</th>
+ <table class="detail"><thead><tr><th>Name</th>
<th>Type</th>
<th class="desc">Description</th>
- </tr></thead>
-<tbody><tr>
-<td><code>$options</code></td>
+ </tr></thead><tbody><tr><td><code>$options</code></td>
<td><em>array(string=>mixed)</em></td>
<td>
The initial options to set.
</td>
- </tr></tbody>
-</table>
-<h5>Exceptions:</h5>
- <table class="detail">
-<thead><tr>
-<th>Type</th>
+ </tr></tbody></table><h5>Exceptions:</h5>
+ <table class="detail"><thead><tr><th>Type</th>
<th class="desc">Description</th>
- </tr></thead>
-<tbody>
-<tr>
-<td><code><a href="../Base/ezcBaseValueException.html">ezcBaseValueException</a></code></td>
+ </tr></thead><tbody><tr><td><code><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseValueException.html">ezcBaseValueException</a></code></td>
<td>
If the value for the property is incorrect
</td>
- </tr>
-<tr>
-<td><code><a href="../Base/ezcBasePropertyNotFoundException.html">ezcBasePropertyNotFoundException</a></code></td>
+ </tr><tr><td><code><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBasePropertyNotFoundException.html">ezcBasePropertyNotFoundException</a></code></td>
<td>
If trying to assign a property which does not exist
</td>
- </tr>
-</tbody>
-</table>
-<h5>Redefinition of:</h5>
- <table class="detail">
-<thead><tr>
-<th>Method</th>
+ </tr></tbody></table><h5>Redefinition of:</h5>
+ <table class="detail"><thead><tr><th>Method</th>
<th class="desc">Description</th>
- </tr></thead>
-<tbody><tr>
-<td><code><a href="../Base/ezcBaseOptions.html#method__construct">ezcBaseOptions::__construct()</a></code></td>
+ </tr></thead><tbody><tr><td><code><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseOptions.html#method__construct">ezcBaseOptions::__construct()</a></code></td>
<td>
Construct a new options object.
</td>
- </tr></tbody>
-</table>
-<div class="credit">
+ </tr></tbody></table><div class="credit">
Documentation generated by <a href="http://www.phpdoc.org">phpDocumentor 1.4.3</a>
</div>
</div>
Modified: incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheUsedLocationException.html
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheUsedLocationException.html?rev=1144915&r1=1144914&r2=1144915&view=diff
==============================================================================
--- incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheUsedLocationException.html (original)
+++ incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheUsedLocationException.html Sun Jul 10 17:30:59 2011
@@ -12,13 +12,13 @@
<meta name="keywords" content="" />
<meta name="author" content="jerome" />
<meta name="language" content="en" />
- <meta name="date" content="Wed, 06 Apr 2011 12:38:18 +0200" />
+ <meta name="date" content="Sun, 10 Jul 2011 11:10:50 +0200" />
<meta name="robots" content="all" />
<link rel="schema.DC" href="http://purl.org/dc/elements/1.1/" />
<meta name="DC.title" content="ezcCacheUsedLocationException.html" />
<meta name="DC.creator" content="jerome" />
- <meta name="DC.date" content="Wed, 06 Apr 2011 12:38:18 +0200" />
+ <meta name="DC.date" content="Sun, 10 Jul 2011 11:10:50 +0200" />
<meta name="DC.rights" content="Copyright" />
<link rel="meta" href="/zetacomponents/documentation/trunk/Cache/phpdoc/ezcCacheUsedLocationException.rdf" />
@@ -68,7 +68,10 @@
<div class="content">
<ul class="tabs">
- <li class="requested">
+ <li >
+ <a href="/zetacomponents/documentation/trunk/Cache/tutorial.html" title="Tutorial">Tutorial</a>
+ </li>
+<li class="requested">
<a href="/zetacomponents/documentation/trunk/Cache/phpdoc/classtrees.html" title="API">API</a>
</li>
@@ -83,110 +86,82 @@
<a name="sec-description"></a>
<h3>Class ezcCacheUsedLocationException</h3>
-<p>Exception that is thrown when a given location is already in use.</p>
-<div><p>Only one cache may reside in a specific location to avoid conflicts while storing (<a href="../Cache/ezcCacheStorage.html#methodstore">ezcCacheStorage::store()</a>) and restoring (<a href="../Cache/ezcCacheStorage.html#methodrestore">ezcCacheStorage::restore()</a>) data from a cache. If you try to configure a cache to be used in location that is already taken by another cachein ezcCacheManager::createCache(), this exception will be thrown.</p></div>
+<p>Exception that is thrown when a given location is already in use.</p><div><p>Only one cache may reside in a specific location to avoid conflicts while storing (<a href="ezcCacheStorage.html#methodstore">ezcCacheStorage::store()</a>) and restoring (<a href="ezcCacheStorage.html#methodrestore">ezcCacheStorage::restore()</a>) data from a cache. If you try to configure a cache to be used in location that is already taken by another cachein ezcCacheManager::createCache(), this exception will be thrown.</p></div>
<p>Source for this file: <a href="http://fisheye6.atlassian.com/browse/zetacomponents/trunk/Cache/src/exceptions/used_location.php?r=HEAD">/Cache/src/exceptions/used_location.php</a></p>
<pre>Exception
|
- --<a href="../Base/ezcBaseException.html">ezcBaseException</a>
+ --<a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseException.html">ezcBaseException</a>
|
- --<a href="../Cache/ezcCacheException.html">ezcCacheException</a>
+ --<a href="ezcCacheException.html">ezcCacheException</a>
|
--ezcCacheUsedLocationException</pre>
- <table><tr>
-<td>
+ <table><tr><td>
<strong>Version:</strong>  
</td>
<td>//autogen//</td>
- </tr></table>
-<h3>Inherited Member Variables</h3>
- <table class="summary">
-<thead><tr>
-<th colspan="2">
- From <span class="classname"><a href="../Base/ezcBaseException.html">ezcBaseException</a></span>
+ </tr></table><h3>Inherited Member Variables</h3>
+ <table class="summary"><thead><tr><th colspan="2">
+ From <span class="classname"><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseException.html">ezcBaseException</a></span>
</th>
- </tr></thead>
-<tbody><tr>
-<td class="right">
+ </tr></thead><tbody><tr><td class="right">
<em>public</em> </td>
<td>
- <code><a href="../Base/ezcBaseException.html#var%24originalMessage">ezcBaseException::$originalMessage</a></code>
+ <code><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseException.html#var%24originalMessage">ezcBaseException::$originalMessage</a></code>
</td>
- </tr></tbody>
-<thead><tr>
-<th colspan="2">
+ </tr></tbody><thead><tr><th colspan="2">
From <span class="classname">Exception (Internal Class)</span>
</th>
- </tr></thead>
-<tbody>
-<tr>
-<td class="right">
+ </tr></thead><tbody><tr><td class="right">
<em>protected</em> </td>
<td>
<code>$code</code>
</td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>protected</em> </td>
<td>
<code>$file</code>
</td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>protected</em> </td>
<td>
<code>$line</code>
</td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>protected</em> </td>
<td>
<code>$message</code>
</td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>private</em> </td>
<td>
<code>$previous</code>
</td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>private</em> </td>
<td>
<code>$string</code>
</td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>private</em> </td>
<td>
<code>$trace</code>
</td>
- </tr>
-</tbody>
-</table>
-<a name="sec-method-summary"></a>
+ </tr></tbody></table><a name="sec-method-summary"></a>
<h3>Method Summary</h3>
- <table class="summary"><tr>
-<td class="right">
+ <table class="summary"><tr><td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code>
@@ -196,100 +171,69 @@
)
</code>
<br><div style="margin-left: 20px">Creates a new ezcCacheUsedLocationException.</div> </td>
- </tr></table>
-<h3>Inherited Methods</h3>
- <table class="summary">
-<thead><tr>
-<th colspan="2">
- From <span class="classname"><a href="../Base/ezcBaseException.html">ezcBaseException</a></span>
+ </tr></table><h3>Inherited Methods</h3>
+ <table class="summary"><thead><tr><th colspan="2">
+ From <span class="classname"><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseException.html">ezcBaseException</a></span>
</th>
- </tr></thead>
-<tbody><tr>
-<td class="right">
+ </tr></thead><tbody><tr><td class="right">
<em>public</em> <em>ezcBaseException</em> </td>
<td>
- <code><b><a href="../Base/ezcBaseException.html#method__construct">ezcBaseException::__construct()</a></b></code>
+ <code><b><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseException.html#method__construct">ezcBaseException::__construct()</a></b></code>
<br><div style="margin-left: 20px">Constructs a new ezcBaseException with $message</div> </td>
- </tr></tbody>
-<thead><tr>
-<th colspan="2">
+ </tr></tbody><thead><tr><th colspan="2">
From <span class="classname">Exception (Internal Class)</span>
</th>
- </tr></thead>
-<tbody>
-<tr>
-<td class="right">
+ </tr></thead><tbody><tr><td class="right">
<em>public</em> <em>Exception</em> </td>
<td>
<code><b>constructor __construct ( [$message = ], [$code = ], [$previous = ] )</b></code>
</td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code><b>getCode ( )</b></code>
</td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code><b>getFile ( )</b></code>
</td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code><b>getLine ( )</b></code>
</td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code><b>getMessage ( )</b></code>
</td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code><b>getPrevious ( )</b></code>
</td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code><b>getTrace ( )</b></code>
</td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code><b>getTraceAsString ( )</b></code>
</td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code><b>__clone ( )</b></code>
</td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code><b>__toString ( )</b></code>
</td>
- </tr>
-</tbody>
-</table>
-<a name="sec-methods"></a>
+ </tr></tbody></table><a name="sec-methods"></a>
<h3>Methods</h3>
<a name="method_detail"></a>
@@ -309,43 +253,27 @@
<p>Creates a new ezcCacheUsedLocationException.</p>
<h5>Parameters:</h5>
- <table class="detail">
-<thead><tr>
-<th>Name</th>
+ <table class="detail"><thead><tr><th>Name</th>
<th>Type</th>
<th class="desc">Description</th>
- </tr></thead>
-<tbody>
-<tr>
-<td><code>$location</code></td>
+ </tr></thead><tbody><tr><td><code>$location</code></td>
<td><em>string</em></td>
<td>
The used location.
</td>
- </tr>
-<tr>
-<td><code>$cacheId</code></td>
+ </tr><tr><td><code>$cacheId</code></td>
<td><em>string</em></td>
<td>
The cache ID using this location.
</td>
- </tr>
-</tbody>
-</table>
-<h5>Redefinition of:</h5>
- <table class="detail">
-<thead><tr>
-<th>Method</th>
+ </tr></tbody></table><h5>Redefinition of:</h5>
+ <table class="detail"><thead><tr><th>Method</th>
<th class="desc">Description</th>
- </tr></thead>
-<tbody><tr>
-<td><code><a href="../Base/ezcBaseException.html#method__construct">ezcBaseException::__construct()</a></code></td>
+ </tr></thead><tbody><tr><td><code><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseException.html#method__construct">ezcBaseException::__construct()</a></code></td>
<td>
Constructs a new ezcBaseException with $message
</td>
- </tr></tbody>
-</table>
-<div class="credit">
+ </tr></tbody></table><div class="credit">
Documentation generated by <a href="http://www.phpdoc.org">phpDocumentor 1.4.3</a>
</div>
</div>
Modified: incubator/zetacomponents/website/htdocs/documentation/trunk/Configuration.html
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/htdocs/documentation/trunk/Configuration.html?rev=1144915&r1=1144914&r2=1144915&view=diff
==============================================================================
--- incubator/zetacomponents/website/htdocs/documentation/trunk/Configuration.html (original)
+++ incubator/zetacomponents/website/htdocs/documentation/trunk/Configuration.html Sun Jul 10 17:30:59 2011
@@ -10,15 +10,15 @@
<meta name="description" content="Apache Zeta Components - reusable set of high quality PHP components to fasten your development." />
<meta name="keywords" content="PHP, apache, components, framework, quality" />
- <meta name="author" content="dotxp" />
+ <meta name="author" content="jerome" />
<meta name="language" content="en" />
- <meta name="date" content="Wed, 04 Aug 2010 13:07:09 +0200" />
+ <meta name="date" content="Sun, 10 Jul 2011 11:10:39 +0200" />
<meta name="robots" content="all" />
<link rel="schema.DC" href="http://purl.org/dc/elements/1.1/" />
<meta name="DC.title" content="Configuration" />
- <meta name="DC.creator" content="dotxp" />
- <meta name="DC.date" content="Wed, 04 Aug 2010 13:07:09 +0200" />
+ <meta name="DC.creator" content="jerome" />
+ <meta name="DC.date" content="Sun, 10 Jul 2011 11:10:39 +0200" />
<meta name="DC.rights" content="Copyright" />
<link rel="meta" href="/zetacomponents/documentation/trunk/Configuration/tutorial.rdf" />
@@ -192,7 +192,7 @@ Hash["def"] = 5</code><a name="array-fil
<li><span style="color: #0000FF">);</span></li>
<li><span style="color: #000000">?></span></li>
-</ol><p>The # element in line 25 contains the comment for the group 'db' (line 23).</p><a name="lazy-initialization"></a><a name="id12"></a><h3>Lazy initialization</h3><p>Lazy initialization is a mechanism to load and configure a component, only when it is really used in your application. This mechanism saves time for parsing the classes and configuration, when the component is not used at all during one request. You can find a description how you can use it for your own components and how it works in the <a href="introduction_Base.html#lazy-initialization">ezcBase tutorial</a>. The keyword for the configuration component is <em>ezcInitConfigurationManager</em>.</p><ol class="code">
+</ol><p>The # element in line 25 contains the comment for the group 'db' (line 23).</p><a name="lazy-initialization"></a><a name="id12"></a><h3>Lazy initialization</h3><p>Lazy initialization is a mechanism to load and configure a component, only when it is really used in your application. This mechanism saves time for parsing the classes and configuration, when the component is not used at all during one request. You can find a description how you can use it for your own components and how it works in the <a href="../Base/tutorial.html">ezcBase tutorial</a>. The keyword for the configuration component is <em>ezcInitConfigurationManager</em>.</p><ol class="code">
<li><span style="color: #000000"><?php</span></li>
<li><span style="color: #0000FF">require_once </span><span style="color: #335533">'tutorial_autoload.php'</span><span style="color: #0000FF">;</span></li>
<li></li>
Modified: incubator/zetacomponents/website/htdocs/documentation/trunk/Configuration/tutorial.html
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/htdocs/documentation/trunk/Configuration/tutorial.html?rev=1144915&r1=1144914&r2=1144915&view=diff
==============================================================================
--- incubator/zetacomponents/website/htdocs/documentation/trunk/Configuration/tutorial.html (original)
+++ incubator/zetacomponents/website/htdocs/documentation/trunk/Configuration/tutorial.html Sun Jul 10 17:30:59 2011
@@ -10,15 +10,15 @@
<meta name="description" content="Apache Zeta Components - reusable set of high quality PHP components to fasten your development." />
<meta name="keywords" content="PHP, apache, components, framework, quality" />
- <meta name="author" content="dotxp" />
+ <meta name="author" content="jerome" />
<meta name="language" content="en" />
- <meta name="date" content="Wed, 04 Aug 2010 13:07:09 +0200" />
+ <meta name="date" content="Sun, 10 Jul 2011 11:10:39 +0200" />
<meta name="robots" content="all" />
<link rel="schema.DC" href="http://purl.org/dc/elements/1.1/" />
<meta name="DC.title" content="Tutorial" />
- <meta name="DC.creator" content="dotxp" />
- <meta name="DC.date" content="Wed, 04 Aug 2010 13:07:09 +0200" />
+ <meta name="DC.creator" content="jerome" />
+ <meta name="DC.date" content="Sun, 10 Jul 2011 11:10:39 +0200" />
<meta name="DC.rights" content="Copyright" />
<link rel="meta" href="/zetacomponents/documentation/trunk/Configuration/tutorial.rdf" />
@@ -192,7 +192,7 @@ Hash["def"] = 5</code><a name="array-fil
<li><span style="color: #0000FF">);</span></li>
<li><span style="color: #000000">?></span></li>
-</ol><p>The # element in line 25 contains the comment for the group 'db' (line 23).</p><a name="lazy-initialization"></a><a name="id12"></a><h3>Lazy initialization</h3><p>Lazy initialization is a mechanism to load and configure a component, only when it is really used in your application. This mechanism saves time for parsing the classes and configuration, when the component is not used at all during one request. You can find a description how you can use it for your own components and how it works in the <a href="introduction_Base.html#lazy-initialization">ezcBase tutorial</a>. The keyword for the configuration component is <em>ezcInitConfigurationManager</em>.</p><ol class="code">
+</ol><p>The # element in line 25 contains the comment for the group 'db' (line 23).</p><a name="lazy-initialization"></a><a name="id12"></a><h3>Lazy initialization</h3><p>Lazy initialization is a mechanism to load and configure a component, only when it is really used in your application. This mechanism saves time for parsing the classes and configuration, when the component is not used at all during one request. You can find a description how you can use it for your own components and how it works in the <a href="../Base/tutorial.html">ezcBase tutorial</a>. The keyword for the configuration component is <em>ezcInitConfigurationManager</em>.</p><ol class="code">
<li><span style="color: #000000"><?php</span></li>
<li><span style="color: #0000FF">require_once </span><span style="color: #335533">'tutorial_autoload.php'</span><span style="color: #0000FF">;</span></li>
<li></li>
Modified: incubator/zetacomponents/website/htdocs/documentation/trunk/Configuration/tutorial.txt
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/htdocs/documentation/trunk/Configuration/tutorial.txt?rev=1144915&r1=1144914&r2=1144915&view=diff
==============================================================================
--- incubator/zetacomponents/website/htdocs/documentation/trunk/Configuration/tutorial.txt (original)
+++ incubator/zetacomponents/website/htdocs/documentation/trunk/Configuration/tutorial.txt Sun Jul 10 17:30:59 2011
@@ -344,7 +344,7 @@ during one request. You can find a descr
own components and how it works in the `ezcBase tutorial`__. The keyword for
the configuration component is *ezcInitConfigurationManager*.
-__ introduction_Base.html#lazy-initialization
+__ ../Base/tutorial.html
.. include:: tutorial_lazy_initialization.php
:literal:
Modified: incubator/zetacomponents/website/htdocs/documentation/trunk/Document.html
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/htdocs/documentation/trunk/Document.html?rev=1144915&r1=1144914&r2=1144915&view=diff
==============================================================================
--- incubator/zetacomponents/website/htdocs/documentation/trunk/Document.html (original)
+++ incubator/zetacomponents/website/htdocs/documentation/trunk/Document.html Sun Jul 10 17:30:59 2011
@@ -10,15 +10,15 @@
<meta name="description" content="Apache Zeta Components - reusable set of high quality PHP components to fasten your development." />
<meta name="keywords" content="PHP, apache, components, framework, quality" />
- <meta name="author" content="dotxp" />
+ <meta name="author" content="jerome" />
<meta name="language" content="en" />
- <meta name="date" content="Sat, 06 Nov 2010 12:08:08 +0100" />
+ <meta name="date" content="Sun, 10 Jul 2011 11:10:40 +0200" />
<meta name="robots" content="all" />
<link rel="schema.DC" href="http://purl.org/dc/elements/1.1/" />
<meta name="DC.title" content="Document" />
- <meta name="DC.creator" content="dotxp" />
- <meta name="DC.date" content="Sat, 06 Nov 2010 12:08:08 +0100" />
+ <meta name="DC.creator" content="jerome" />
+ <meta name="DC.date" content="Sun, 10 Jul 2011 11:10:40 +0200" />
<meta name="DC.rights" content="Copyright" />
<link rel="meta" href="/zetacomponents/documentation/trunk/Document/tutorial.rdf" />
@@ -83,7 +83,7 @@
</ul>
- <h2>eZ Components - Document</h2><div class="toc"><h3>Table of Contents</h3><ul><li><p><a href="#introduction">Introduction</a></p></li><li><p><a href="#markup-languages">Markup languages</a></p><ul><li><p><a href="#restructured-text">ReStructured text</a></p><ul><li><p><a href="#error-handling">Error handling</a></p></li><li><p><a href="#directives">Directives</a></p></li><li><p><a href="#xhtml-rendering">XHTML rendering</a></p></li><li><p><a href="#writing-rst">Writing RST</a></p></li></ul></li><li><p><a href="#xhtml">XHTML</a></p><ul><li><p><a href="#writing-xhtml">Writing XHTML</a></p></li><li><p><a href="#html-styles">HTML styles</a></p></li></ul></li><li><p><a href="#ez-xml">eZ Xml</a></p><ul><li><p><a href="#reading-ez-xml">Reading eZ XML</a></p></li><li><p><a href="#wrting-ez-xml">Wrting eZ XML</a></p></li></ul></li><li><p><a href="#wiki-markup">Wiki markup</a></p><ul><li><p><a href="#reading-wiki-markup">Reading wiki markup</a></p></li><li><p><a href="#writing-wik
i-markup">Writing wiki markup</a></p></li></ul></li><li><p><a href="#pdf">PDF</a></p><ul><li><p><a href="#reading-pdf">Reading PDF</a></p></li><li><p><a href="#writing-pdf">Writing PDF</a></p></li></ul></li><li><p><a href="#open-document-text">Open Document Text</a></p><ul><li><p><a href="#reading-odt">Reading ODT</a></p></li><li><p><a href="#writing-odt">Writing ODT</a></p></li><li><p><a href="#styling-odt">Styling ODT</a></p></li></ul></li></ul></li></ul></div><a name="introduction"></a><a name="id37"></a><h3>Introduction</h3><p>The document component offers transformations between different semantic markup languages, like:</p><ul><li><p><a href="http://docutils.sourceforge.net/rst.html">ReStructured text</a></p></li><li><p><a href="http://www.w3.org/TR/xhtml1/">XHTML</a></p></li><li><p><a href="http://www.docbook.org/">Docbook</a></p></li><li><p><a href="Document_conversion.html">eZ Publish XML markup</a></p></li><li><p>Wiki markup languages, like: <a href="http://ez.no/d
oc/ez_publish/technical_manual/4_0/reference/xml_tags">Creole</a>, <a href="http://www.wikicreole.org/">Dokuwiki</a> and <a href="http://www.dokuwiki.org/dokuwiki">Confluence</a></p></li><li><p><a href="http://confluence.atlassian.com/renderer/notationhelp.action?section=all">Open Document Text</a> as used by <a href="http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office">OpenOffice.org</a> and other office suites</p></li></ul><p>Like shown in figure 1, each format supports conversions from and to docbook as a central intermediate format and may implement additional shortcuts for conversions from and to other formats. Not each format can express the same semantics, so there may be some information lost, which is <a href="http://www.openoffice.org/">documented in a dedicated document</a>.</p><div class=" 					image 					 							center 						 "><img alt="Conversion architecture in
document component Figure 1: Conversion architecture in document component" title="Conversion architecture in document component Figure 1: Conversion architecture in document component" src="img/document-architecture.png"/><span class="image_title">Conversion architecture in document component Figure 1: Conversion architecture in document component</span></div><p>There are central handler classes for each markup language, which follow a common conversion interface <a href='/zetacomponents/documentation/trunk/Document/phpdoc/ezcDocument.html'>ezcDocument</a> and all implement the methods getAsDocbook() and createFromDocbook().</p><p>Additionally the document component can render documents in the following output formats. Those formats cannot be read, but just generated:</p><ul><li><p>PDF</p></li></ul><a name="markup-languages"></a><a name="id38"></a><h3>Markup languages</h3><p>The following markup languages are currently handled by the document component.</p><a name="restruc
tured-text"></a><a name="id39"></a><h4>ReStructured text</h4><p><a href="http://docutils.sourceforge.net/rst.html">RsStructured Text</a> (RST) is a simple text based markup language, intended to be easy to read and write by humans. Examples can be found in the <a href="http://docutils.sourceforge.net/docs/user/rst/quickstart.html">documentation of RST</a>.</p><p>The transformation of a simple RST document to docbook can be done just like this:</p><ol class="code">
+ <h2>eZ Components - Document</h2><div class="toc"><h3>Table of Contents</h3><ul><li><p><a href="#introduction">Introduction</a></p></li><li><p><a href="#markup-languages">Markup languages</a></p><ul><li><p><a href="#restructured-text">ReStructured text</a></p><ul><li><p><a href="#error-handling">Error handling</a></p></li><li><p><a href="#directives">Directives</a></p></li><li><p><a href="#xhtml-rendering">XHTML rendering</a></p></li><li><p><a href="#writing-rst">Writing RST</a></p></li></ul></li><li><p><a href="#xhtml">XHTML</a></p><ul><li><p><a href="#writing-xhtml">Writing XHTML</a></p></li><li><p><a href="#html-styles">HTML styles</a></p></li></ul></li><li><p><a href="#ez-xml">eZ Xml</a></p><ul><li><p><a href="#reading-ez-xml">Reading eZ XML</a></p></li><li><p><a href="#wrting-ez-xml">Wrting eZ XML</a></p></li></ul></li><li><p><a href="#wiki-markup">Wiki markup</a></p><ul><li><p><a href="#reading-wiki-markup">Reading wiki markup</a></p></li><li><p><a href="#writing-wik
i-markup">Writing wiki markup</a></p></li></ul></li><li><p><a href="#pdf">PDF</a></p><ul><li><p><a href="#reading-pdf">Reading PDF</a></p></li><li><p><a href="#writing-pdf">Writing PDF</a></p></li></ul></li><li><p><a href="#open-document-text">Open Document Text</a></p><ul><li><p><a href="#reading-odt">Reading ODT</a></p></li><li><p><a href="#writing-odt">Writing ODT</a></p></li><li><p><a href="#styling-odt">Styling ODT</a></p></li></ul></li></ul></li></ul></div><a name="introduction"></a><a name="id37"></a><h3>Introduction</h3><p>The document component offers transformations between different semantic markup languages, like:</p><ul><li><p><a href="http://docutils.sourceforge.net/rst.html">ReStructured text</a></p></li><li><p><a href="http://www.w3.org/TR/xhtml1/">XHTML</a></p></li><li><p><a href="http://www.docbook.org/">Docbook</a></p></li><li><p><a href="Document_conversion.html">eZ Publish XML markup</a></p></li><li><p>Wiki markup languages, like: <a href="http://doc.ez.
no/eZ-Publish/Technical-manual/4.x/Reference/XML-tags">Creole</a>, <a href="http://www.wikicreole.org/">Dokuwiki</a> and <a href="http://www.dokuwiki.org/dokuwiki">Confluence</a></p></li><li><p><a href="http://confluence.atlassian.com/renderer/notationhelp.action?section=all">Open Document Text</a> as used by <a href="http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office">OpenOffice.org</a> and other office suites</p></li></ul><p>Like shown in figure 1, each format supports conversions from and to docbook as a central intermediate format and may implement additional shortcuts for conversions from and to other formats. Not each format can express the same semantics, so there may be some information lost, which is <a href="http://www.openoffice.org/">documented in a dedicated document</a>.</p><div class=" 					image 					 							center 						 "><img alt="Conversion architecture in
document component Figure 1: Conversion architecture in document component" title="Conversion architecture in document component Figure 1: Conversion architecture in document component" src="img/document-architecture.png"/><span class="image_title">Conversion architecture in document component Figure 1: Conversion architecture in document component</span></div><p>There are central handler classes for each markup language, which follow a common conversion interface <a href='/zetacomponents/documentation/trunk/Document/phpdoc/ezcDocument.html'>ezcDocument</a> and all implement the methods getAsDocbook() and createFromDocbook().</p><p>Additionally the document component can render documents in the following output formats. Those formats cannot be read, but just generated:</p><ul><li><p>PDF</p></li></ul><a name="markup-languages"></a><a name="id38"></a><h3>Markup languages</h3><p>The following markup languages are currently handled by the document component.</p><a name="restruc
tured-text"></a><a name="id39"></a><h4>ReStructured text</h4><p><a href="http://docutils.sourceforge.net/rst.html">RsStructured Text</a> (RST) is a simple text based markup language, intended to be easy to read and write by humans. Examples can be found in the <a href="http://docutils.sourceforge.net/docs/user/rst/quickstart.html">documentation of RST</a>.</p><p>The transformation of a simple RST document to docbook can be done just like this:</p><ol class="code">
<li><span style="color: #000000"><?php</span></li>
<li></li>
<li><span style="color: #0000FF">require </span><span style="color: #335533">'tutorial_autoload.php'</span><span style="color: #0000FF">;</span></li>
Modified: incubator/zetacomponents/website/htdocs/documentation/trunk/Document/tutorial.html
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/htdocs/documentation/trunk/Document/tutorial.html?rev=1144915&r1=1144914&r2=1144915&view=diff
==============================================================================
--- incubator/zetacomponents/website/htdocs/documentation/trunk/Document/tutorial.html (original)
+++ incubator/zetacomponents/website/htdocs/documentation/trunk/Document/tutorial.html Sun Jul 10 17:30:59 2011
@@ -10,15 +10,15 @@
<meta name="description" content="Apache Zeta Components - reusable set of high quality PHP components to fasten your development." />
<meta name="keywords" content="PHP, apache, components, framework, quality" />
- <meta name="author" content="dotxp" />
+ <meta name="author" content="jerome" />
<meta name="language" content="en" />
- <meta name="date" content="Sat, 06 Nov 2010 12:08:08 +0100" />
+ <meta name="date" content="Sun, 10 Jul 2011 11:10:40 +0200" />
<meta name="robots" content="all" />
<link rel="schema.DC" href="http://purl.org/dc/elements/1.1/" />
<meta name="DC.title" content="Tutorial" />
- <meta name="DC.creator" content="dotxp" />
- <meta name="DC.date" content="Sat, 06 Nov 2010 12:08:08 +0100" />
+ <meta name="DC.creator" content="jerome" />
+ <meta name="DC.date" content="Sun, 10 Jul 2011 11:10:40 +0200" />
<meta name="DC.rights" content="Copyright" />
<link rel="meta" href="/zetacomponents/documentation/trunk/Document/tutorial.rdf" />
@@ -83,7 +83,7 @@
</ul>
- <h2>eZ Components - Document</h2><div class="toc"><h3>Table of Contents</h3><ul><li><p><a href="#introduction">Introduction</a></p></li><li><p><a href="#markup-languages">Markup languages</a></p><ul><li><p><a href="#restructured-text">ReStructured text</a></p><ul><li><p><a href="#error-handling">Error handling</a></p></li><li><p><a href="#directives">Directives</a></p></li><li><p><a href="#xhtml-rendering">XHTML rendering</a></p></li><li><p><a href="#writing-rst">Writing RST</a></p></li></ul></li><li><p><a href="#xhtml">XHTML</a></p><ul><li><p><a href="#writing-xhtml">Writing XHTML</a></p></li><li><p><a href="#html-styles">HTML styles</a></p></li></ul></li><li><p><a href="#ez-xml">eZ Xml</a></p><ul><li><p><a href="#reading-ez-xml">Reading eZ XML</a></p></li><li><p><a href="#wrting-ez-xml">Wrting eZ XML</a></p></li></ul></li><li><p><a href="#wiki-markup">Wiki markup</a></p><ul><li><p><a href="#reading-wiki-markup">Reading wiki markup</a></p></li><li><p><a href="#writing-wik
i-markup">Writing wiki markup</a></p></li></ul></li><li><p><a href="#pdf">PDF</a></p><ul><li><p><a href="#reading-pdf">Reading PDF</a></p></li><li><p><a href="#writing-pdf">Writing PDF</a></p></li></ul></li><li><p><a href="#open-document-text">Open Document Text</a></p><ul><li><p><a href="#reading-odt">Reading ODT</a></p></li><li><p><a href="#writing-odt">Writing ODT</a></p></li><li><p><a href="#styling-odt">Styling ODT</a></p></li></ul></li></ul></li></ul></div><a name="introduction"></a><a name="id37"></a><h3>Introduction</h3><p>The document component offers transformations between different semantic markup languages, like:</p><ul><li><p><a href="http://docutils.sourceforge.net/rst.html">ReStructured text</a></p></li><li><p><a href="http://www.w3.org/TR/xhtml1/">XHTML</a></p></li><li><p><a href="http://www.docbook.org/">Docbook</a></p></li><li><p><a href="Document_conversion.html">eZ Publish XML markup</a></p></li><li><p>Wiki markup languages, like: <a href="http://ez.no/d
oc/ez_publish/technical_manual/4_0/reference/xml_tags">Creole</a>, <a href="http://www.wikicreole.org/">Dokuwiki</a> and <a href="http://www.dokuwiki.org/dokuwiki">Confluence</a></p></li><li><p><a href="http://confluence.atlassian.com/renderer/notationhelp.action?section=all">Open Document Text</a> as used by <a href="http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office">OpenOffice.org</a> and other office suites</p></li></ul><p>Like shown in figure 1, each format supports conversions from and to docbook as a central intermediate format and may implement additional shortcuts for conversions from and to other formats. Not each format can express the same semantics, so there may be some information lost, which is <a href="http://www.openoffice.org/">documented in a dedicated document</a>.</p><div class=" 					image 					 							center 						 "><img alt="Conversion architecture in
document component Figure 1: Conversion architecture in document component" title="Conversion architecture in document component Figure 1: Conversion architecture in document component" src="img/document-architecture.png"/><span class="image_title">Conversion architecture in document component Figure 1: Conversion architecture in document component</span></div><p>There are central handler classes for each markup language, which follow a common conversion interface <a href='/zetacomponents/documentation/trunk/Document/phpdoc/ezcDocument.html'>ezcDocument</a> and all implement the methods getAsDocbook() and createFromDocbook().</p><p>Additionally the document component can render documents in the following output formats. Those formats cannot be read, but just generated:</p><ul><li><p>PDF</p></li></ul><a name="markup-languages"></a><a name="id38"></a><h3>Markup languages</h3><p>The following markup languages are currently handled by the document component.</p><a name="restruc
tured-text"></a><a name="id39"></a><h4>ReStructured text</h4><p><a href="http://docutils.sourceforge.net/rst.html">RsStructured Text</a> (RST) is a simple text based markup language, intended to be easy to read and write by humans. Examples can be found in the <a href="http://docutils.sourceforge.net/docs/user/rst/quickstart.html">documentation of RST</a>.</p><p>The transformation of a simple RST document to docbook can be done just like this:</p><ol class="code">
+ <h2>eZ Components - Document</h2><div class="toc"><h3>Table of Contents</h3><ul><li><p><a href="#introduction">Introduction</a></p></li><li><p><a href="#markup-languages">Markup languages</a></p><ul><li><p><a href="#restructured-text">ReStructured text</a></p><ul><li><p><a href="#error-handling">Error handling</a></p></li><li><p><a href="#directives">Directives</a></p></li><li><p><a href="#xhtml-rendering">XHTML rendering</a></p></li><li><p><a href="#writing-rst">Writing RST</a></p></li></ul></li><li><p><a href="#xhtml">XHTML</a></p><ul><li><p><a href="#writing-xhtml">Writing XHTML</a></p></li><li><p><a href="#html-styles">HTML styles</a></p></li></ul></li><li><p><a href="#ez-xml">eZ Xml</a></p><ul><li><p><a href="#reading-ez-xml">Reading eZ XML</a></p></li><li><p><a href="#wrting-ez-xml">Wrting eZ XML</a></p></li></ul></li><li><p><a href="#wiki-markup">Wiki markup</a></p><ul><li><p><a href="#reading-wiki-markup">Reading wiki markup</a></p></li><li><p><a href="#writing-wik
i-markup">Writing wiki markup</a></p></li></ul></li><li><p><a href="#pdf">PDF</a></p><ul><li><p><a href="#reading-pdf">Reading PDF</a></p></li><li><p><a href="#writing-pdf">Writing PDF</a></p></li></ul></li><li><p><a href="#open-document-text">Open Document Text</a></p><ul><li><p><a href="#reading-odt">Reading ODT</a></p></li><li><p><a href="#writing-odt">Writing ODT</a></p></li><li><p><a href="#styling-odt">Styling ODT</a></p></li></ul></li></ul></li></ul></div><a name="introduction"></a><a name="id37"></a><h3>Introduction</h3><p>The document component offers transformations between different semantic markup languages, like:</p><ul><li><p><a href="http://docutils.sourceforge.net/rst.html">ReStructured text</a></p></li><li><p><a href="http://www.w3.org/TR/xhtml1/">XHTML</a></p></li><li><p><a href="http://www.docbook.org/">Docbook</a></p></li><li><p><a href="Document_conversion.html">eZ Publish XML markup</a></p></li><li><p>Wiki markup languages, like: <a href="http://doc.ez.
no/eZ-Publish/Technical-manual/4.x/Reference/XML-tags">Creole</a>, <a href="http://www.wikicreole.org/">Dokuwiki</a> and <a href="http://www.dokuwiki.org/dokuwiki">Confluence</a></p></li><li><p><a href="http://confluence.atlassian.com/renderer/notationhelp.action?section=all">Open Document Text</a> as used by <a href="http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office">OpenOffice.org</a> and other office suites</p></li></ul><p>Like shown in figure 1, each format supports conversions from and to docbook as a central intermediate format and may implement additional shortcuts for conversions from and to other formats. Not each format can express the same semantics, so there may be some information lost, which is <a href="http://www.openoffice.org/">documented in a dedicated document</a>.</p><div class=" 					image 					 							center 						 "><img alt="Conversion architecture in
document component Figure 1: Conversion architecture in document component" title="Conversion architecture in document component Figure 1: Conversion architecture in document component" src="img/document-architecture.png"/><span class="image_title">Conversion architecture in document component Figure 1: Conversion architecture in document component</span></div><p>There are central handler classes for each markup language, which follow a common conversion interface <a href='/zetacomponents/documentation/trunk/Document/phpdoc/ezcDocument.html'>ezcDocument</a> and all implement the methods getAsDocbook() and createFromDocbook().</p><p>Additionally the document component can render documents in the following output formats. Those formats cannot be read, but just generated:</p><ul><li><p>PDF</p></li></ul><a name="markup-languages"></a><a name="id38"></a><h3>Markup languages</h3><p>The following markup languages are currently handled by the document component.</p><a name="restruc
tured-text"></a><a name="id39"></a><h4>ReStructured text</h4><p><a href="http://docutils.sourceforge.net/rst.html">RsStructured Text</a> (RST) is a simple text based markup language, intended to be easy to read and write by humans. Examples can be found in the <a href="http://docutils.sourceforge.net/docs/user/rst/quickstart.html">documentation of RST</a>.</p><p>The transformation of a simple RST document to docbook can be done just like this:</p><ol class="code">
<li><span style="color: #000000"><?php</span></li>
<li></li>
<li><span style="color: #0000FF">require </span><span style="color: #335533">'tutorial_autoload.php'</span><span style="color: #0000FF">;</span></li>
Modified: incubator/zetacomponents/website/htdocs/documentation/trunk/Document/tutorial.txt
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/htdocs/documentation/trunk/Document/tutorial.txt?rev=1144915&r1=1144914&r2=1144915&view=diff
==============================================================================
--- incubator/zetacomponents/website/htdocs/documentation/trunk/Document/tutorial.txt (original)
+++ incubator/zetacomponents/website/htdocs/documentation/trunk/Document/tutorial.txt Sun Jul 10 17:30:59 2011
@@ -41,7 +41,7 @@ __ http://docutils.sourceforge.net/rst.h
__ http://www.w3.org/TR/xhtml1/
__ http://www.docbook.org/
__ Document_conversion.html
-__ http://ez.no/doc/ez_publish/technical_manual/4_0/reference/xml_tags
+__ http://doc.ez.no/eZ-Publish/Technical-manual/4.x/Reference/XML-tags
__ http://www.wikicreole.org/
__ http://www.dokuwiki.org/dokuwiki
__ http://confluence.atlassian.com/renderer/notationhelp.action?section=all
@@ -906,4 +906,4 @@ __ Document_styles.html
mode: rst
fill-column: 79
End:
- vim: et syn=rst tw=79
+ vim: et syn=rst tw=79
\ No newline at end of file
Modified: incubator/zetacomponents/website/htdocs/documentation/trunk/EventLog.html
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/htdocs/documentation/trunk/EventLog.html?rev=1144915&r1=1144914&r2=1144915&view=diff
==============================================================================
--- incubator/zetacomponents/website/htdocs/documentation/trunk/EventLog.html (original)
+++ incubator/zetacomponents/website/htdocs/documentation/trunk/EventLog.html Sun Jul 10 17:30:59 2011
@@ -10,15 +10,15 @@
<meta name="description" content="Apache Zeta Components - reusable set of high quality PHP components to fasten your development." />
<meta name="keywords" content="PHP, apache, components, framework, quality" />
- <meta name="author" content="dotxp" />
+ <meta name="author" content="jerome" />
<meta name="language" content="en" />
- <meta name="date" content="Wed, 04 Aug 2010 13:07:09 +0200" />
+ <meta name="date" content="Sun, 10 Jul 2011 11:10:39 +0200" />
<meta name="robots" content="all" />
<link rel="schema.DC" href="http://purl.org/dc/elements/1.1/" />
<meta name="DC.title" content="EventLog" />
- <meta name="DC.creator" content="dotxp" />
- <meta name="DC.date" content="Wed, 04 Aug 2010 13:07:09 +0200" />
+ <meta name="DC.creator" content="jerome" />
+ <meta name="DC.date" content="Sun, 10 Jul 2011 11:10:39 +0200" />
<meta name="DC.rights" content="Copyright" />
<link rel="meta" href="/zetacomponents/documentation/trunk/EventLog/tutorial.rdf" />
@@ -77,7 +77,7 @@
</ul>
- <h2>eZ Components - EventLog</h2><div class="toc"><h3>Table of Contents</h3><ul><li><p><a href="#introduction">Introduction</a></p></li><li><p><a href="#class-overview">Class overview</a></p></li><li><p><a href="#examples">Examples</a></p><ul><li><p><a href="#writing-a-log-message-to-file">Writing a log message to file</a></p></li><li><p><a href="#writing-a-log-message-to-a-database">Writing a log message to a database</a></p></li><li><p><a href="#assigning-sources-and-categories">Assigning sources and categories</a></p></li><li><p><a href="#adding-log-attributes-automatically">Adding log attributes automatically</a></p></li><li><p><a href="#assigning-log-messages-to-different-files">Assigning log messages to different files</a></p></li><li><p><a href="#using-trigger-error">Using trigger_error()</a></p></li></ul></li><li><p><a href="#lazy-initialization">Lazy initialization</a></p></li></ul></div><a name="introduction"></a><a name="id2"></a><h3>Introduction</h3><p>The Even
tLog component provides an API to log events and audit trails with log messages. These log messages are written to files or other storage elements. How and where the log messages are written depends on the log writer.</p><p>The available log writers are:</p><ul><li><p>ezcLogUnixFileWriter, which writes log messages to a file in a <em>Unix</em> file format.</p></li><li><p>ezcLogSyslogWriter, which writes log messages to syslog.</p></li><li><p>ezcLogDatabaseWriter, which writes log messages to the database. This is available in the <a href="introduction_EventLogDatabaseTiein.html">EventLogDatabaseTieIn</a> component.</p></li></ul><p>Each of these writers can be customized or extended.</p><p>An incoming log message can be written with zero or more writers. The writers depend on the variables of the log message itself and the <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogMapper.html'>ezcLogMapper</a> implementation. <a href='/zetacomponents/documentation/tru
nk/EventLog/phpdoc/ezcLogMapper.html'>ezcLogMapper</a> checks the severity, source and category from the log message and forwards the message to the appropriate writers.</p><a name="class-overview"></a><a name="id3"></a><h3>Class overview</h3><p>The following classes are most important to use, customize or extend:</p><dl><dt>ezcLog</dt><dd>The <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLog.html'>ezcLog</a> class is a singleton, meaning that only one instance of it can exist. This class provides methods to configure and record log messages. The recorded log messages are sent to an implementation of <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogMapper.html'>ezcLogMapper</a>, which forwards the messages to the appropriate log writers.</dd><dt>ezcLogMapper</dt><dd>ezcLogMapper provides an interface for log message mapping. Log messages are dispatched from <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLog.html'>ezcLog</a
> to a writer. The particular writer is determined in the class that implements <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogMapper.html'>ezcLogMapper</a> and is assigned in <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLog.html'>ezcLog</a>.</dd><dt>ezcLogFilterSet</dt><dd>ezcLogFilterSet is an implementation of <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogMapper.html'>ezcLogMapper</a>. <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogFilterSet.html'>ezcLogFilterSet</a> contains a set of rules in the form of objects of the class <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogFilterRule.html'>ezcLogFilterRule</a>. These rules are processed sequentially. In other words, the first assigned rule will be processed first. Each rule determines whether the log message matches the filter rule. If the log message matches, it calls the writer and decide whether the filter set stops proce
ssing.The <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogFilterSet.html'>ezcLogFilterSet</a> class is inspired by modern mail application filter settings. Normally these mail filter settings sort the incoming mail and store it in the correct mail folder.</dd><dt>ezcLogWriter</dt><dd>ezcLogWriter provides an interface for the writers. An implementation of this interface is a valid writer and can be addressed by <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogMapper.html'>ezcLogMapper</a>. The writer itself determines how and where the log message is stored.</dd><dt>ezcLogUnixFileWriter</dt><dd>ezcLogUnixFileWriter writes the log message to a file.</dd><dt>ezcLogFilter</dt><dd>ezcLogFilter is a structure to specify which log messages are accepted in a filter set.</dd></dl><p>For more information about these classes, see the class documentation.</p><a name="examples"></a><a name="id4"></a><h3>Examples</h3><a name="writing-a-log-message-to-
file"></a><a name="id5"></a><h4>Writing a log message to file</h4><p>This example creates a file writer and assigns it to the default log mapper.</p><ol class="code">
+ <h2>eZ Components - EventLog</h2><div class="toc"><h3>Table of Contents</h3><ul><li><p><a href="#introduction">Introduction</a></p></li><li><p><a href="#class-overview">Class overview</a></p></li><li><p><a href="#examples">Examples</a></p><ul><li><p><a href="#writing-a-log-message-to-file">Writing a log message to file</a></p></li><li><p><a href="#writing-a-log-message-to-a-database">Writing a log message to a database</a></p></li><li><p><a href="#assigning-sources-and-categories">Assigning sources and categories</a></p></li><li><p><a href="#adding-log-attributes-automatically">Adding log attributes automatically</a></p></li><li><p><a href="#assigning-log-messages-to-different-files">Assigning log messages to different files</a></p></li><li><p><a href="#using-trigger-error">Using trigger_error()</a></p></li></ul></li><li><p><a href="#lazy-initialization">Lazy initialization</a></p></li></ul></div><a name="introduction"></a><a name="id2"></a><h3>Introduction</h3><p>The Even
tLog component provides an API to log events and audit trails with log messages. These log messages are written to files or other storage elements. How and where the log messages are written depends on the log writer.</p><p>The available log writers are:</p><ul><li><p>ezcLogUnixFileWriter, which writes log messages to a file in a <em>Unix</em> file format.</p></li><li><p>ezcLogSyslogWriter, which writes log messages to syslog.</p></li><li><p>ezcLogDatabaseWriter, which writes log messages to the database. This is available in the <a href="../EventLogDatabaseTiein.html#introduction">EventLogDatabaseTieIn</a> component.</p></li></ul><p>Each of these writers can be customized or extended.</p><p>An incoming log message can be written with zero or more writers. The writers depend on the variables of the log message itself and the <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogMapper.html'>ezcLogMapper</a> implementation. <a href='/zetacomponents/documentation/
trunk/EventLog/phpdoc/ezcLogMapper.html'>ezcLogMapper</a> checks the severity, source and category from the log message and forwards the message to the appropriate writers.</p><a name="class-overview"></a><a name="id3"></a><h3>Class overview</h3><p>The following classes are most important to use, customize or extend:</p><dl><dt>ezcLog</dt><dd>The <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLog.html'>ezcLog</a> class is a singleton, meaning that only one instance of it can exist. This class provides methods to configure and record log messages. The recorded log messages are sent to an implementation of <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogMapper.html'>ezcLogMapper</a>, which forwards the messages to the appropriate log writers.</dd><dt>ezcLogMapper</dt><dd>ezcLogMapper provides an interface for log message mapping. Log messages are dispatched from <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLog.html'>ezcLog
</a> to a writer. The particular writer is determined in the class that implements <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogMapper.html'>ezcLogMapper</a> and is assigned in <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLog.html'>ezcLog</a>.</dd><dt>ezcLogFilterSet</dt><dd>ezcLogFilterSet is an implementation of <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogMapper.html'>ezcLogMapper</a>. <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogFilterSet.html'>ezcLogFilterSet</a> contains a set of rules in the form of objects of the class <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogFilterRule.html'>ezcLogFilterRule</a>. These rules are processed sequentially. In other words, the first assigned rule will be processed first. Each rule determines whether the log message matches the filter rule. If the log message matches, it calls the writer and decide whether the filter set stops pr
ocessing.The <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogFilterSet.html'>ezcLogFilterSet</a> class is inspired by modern mail application filter settings. Normally these mail filter settings sort the incoming mail and store it in the correct mail folder.</dd><dt>ezcLogWriter</dt><dd>ezcLogWriter provides an interface for the writers. An implementation of this interface is a valid writer and can be addressed by <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogMapper.html'>ezcLogMapper</a>. The writer itself determines how and where the log message is stored.</dd><dt>ezcLogUnixFileWriter</dt><dd>ezcLogUnixFileWriter writes the log message to a file.</dd><dt>ezcLogFilter</dt><dd>ezcLogFilter is a structure to specify which log messages are accepted in a filter set.</dd></dl><p>For more information about these classes, see the class documentation.</p><a name="examples"></a><a name="id4"></a><h3>Examples</h3><a name="writing-a-log-message-
to-file"></a><a name="id5"></a><h4>Writing a log message to file</h4><p>This example creates a file writer and assigns it to the default log mapper.</p><ol class="code">
<li><span style="color: #000000"><?php</span></li>
<li></li>
<li><span style="color: #0000FF">require_once </span><span style="color: #335533">'tutorial_autoload.php'</span><span style="color: #0000FF">;</span></li>
@@ -105,7 +105,7 @@
<li></li>
<li><span style="color: #000000">?></span></li>
-</ol><p>First, <em>tutorial_autoload.php</em> is included. This file loads the correct PHP files for the EventLog component.</p><p>Then, the log is set up and a message is written to the log file <em>default.log</em>, to be placed in the <em>/tmp/logs</em> directory.</p><p>After execution, the file <em>/tmp/logs/default.log</em> contains something like this:</p><code class="block">Jan 24 14:39:57 [Warning] [default] [default] Could not connect with the payment server.</code><p>The date, severity, source, category and message are shown. The source and category are both set to default, because they were not specified in the message.</p><a name="writing-a-log-message-to-a-database"></a><a name="id6"></a><h4>Writing a log message to a database</h4><p>With the optional <a href="introduction_EventLogDatabaseTiein.html">EventLogDatabaseTiein</a> component it is also possible to write log messages to a database table. See the <a href="introduction_EventLogDatabaseTiein.html">EventLo
gDatabaseTiein</a> tutorial on how to use the <a href="EventLogDatabaseTiein/ezcLogDatabaseWriter.html">ezcLogDatabaseWriter</a> as writer instead of the <a href="EventLog/ezcLogUnixFileWriter.html">ezcLogUnixFileWriter</a> from this component. You can use both log writers at the same time. See the section <a href="#assigning-log-messages-to-different-files">Assigning log messages to different files</a> on how to use different writers simultaneously.</p><a name="assigning-sources-and-categories"></a><a name="id7"></a><h4>Assigning sources and categories</h4><p>The default source and category from <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLog.html'>ezcLog</a> can be set via the properties <em>source</em> and <em>category</em>. The next example demonstrates how the default properties can be set and how extra variables can be added to the log.</p><ol class="code">
+</ol><p>First, <em>tutorial_autoload.php</em> is included. This file loads the correct PHP files for the EventLog component.</p><p>Then, the log is set up and a message is written to the log file <em>default.log</em>, to be placed in the <em>/tmp/logs</em> directory.</p><p>After execution, the file <em>/tmp/logs/default.log</em> contains something like this:</p><code class="block">Jan 24 14:39:57 [Warning] [default] [default] Could not connect with the payment server.</code><p>The date, severity, source, category and message are shown. The source and category are both set to default, because they were not specified in the message.</p><a name="writing-a-log-message-to-a-database"></a><a name="id6"></a><h4>Writing a log message to a database</h4><p>With the optional <a href="../EventLogDatabaseTiein.html#introduction">EventLogDatabaseTiein</a> component it is also possible to write log messages to a database table. See the <a href="../EventLogDatabaseTiein.html#introduction">E
ventLogDatabaseTiein</a> tutorial on how to use the <a href="../EventLogDatabaseTiein/phpdoc/ezcLogDatabaseWriter.html">ezcLogDatabaseWriter</a> as writer instead of the <a href="../EventLog/phpdoc/ezcLogUnixFileWriter.html">ezcLogUnixFileWriter</a> from this component. You can use both log writers at the same time. See the section <a href="#assigning-log-messages-to-different-files">Assigning log messages to different files</a> on how to use different writers simultaneously.</p><a name="assigning-sources-and-categories"></a><a name="id7"></a><h4>Assigning sources and categories</h4><p>The default source and category from <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLog.html'>ezcLog</a> can be set via the properties <em>source</em> and <em>category</em>. The next example demonstrates how the default properties can be set and how extra variables can be added to the log.</p><ol class="code">
<li><span style="color: #000000"><?php</span></li>
<li></li>
<li><span style="color: #0000FF">require_once </span><span style="color: #335533">'tutorial_autoload.php'</span><span style="color: #0000FF">;</span></li>
Modified: incubator/zetacomponents/website/htdocs/documentation/trunk/EventLog/tutorial.html
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/htdocs/documentation/trunk/EventLog/tutorial.html?rev=1144915&r1=1144914&r2=1144915&view=diff
==============================================================================
--- incubator/zetacomponents/website/htdocs/documentation/trunk/EventLog/tutorial.html (original)
+++ incubator/zetacomponents/website/htdocs/documentation/trunk/EventLog/tutorial.html Sun Jul 10 17:30:59 2011
@@ -10,15 +10,15 @@
<meta name="description" content="Apache Zeta Components - reusable set of high quality PHP components to fasten your development." />
<meta name="keywords" content="PHP, apache, components, framework, quality" />
- <meta name="author" content="dotxp" />
+ <meta name="author" content="jerome" />
<meta name="language" content="en" />
- <meta name="date" content="Wed, 04 Aug 2010 13:07:09 +0200" />
+ <meta name="date" content="Sun, 10 Jul 2011 11:10:39 +0200" />
<meta name="robots" content="all" />
<link rel="schema.DC" href="http://purl.org/dc/elements/1.1/" />
<meta name="DC.title" content="Tutorial" />
- <meta name="DC.creator" content="dotxp" />
- <meta name="DC.date" content="Wed, 04 Aug 2010 13:07:09 +0200" />
+ <meta name="DC.creator" content="jerome" />
+ <meta name="DC.date" content="Sun, 10 Jul 2011 11:10:39 +0200" />
<meta name="DC.rights" content="Copyright" />
<link rel="meta" href="/zetacomponents/documentation/trunk/EventLog/tutorial.rdf" />
@@ -77,7 +77,7 @@
</ul>
- <h2>eZ Components - EventLog</h2><div class="toc"><h3>Table of Contents</h3><ul><li><p><a href="#introduction">Introduction</a></p></li><li><p><a href="#class-overview">Class overview</a></p></li><li><p><a href="#examples">Examples</a></p><ul><li><p><a href="#writing-a-log-message-to-file">Writing a log message to file</a></p></li><li><p><a href="#writing-a-log-message-to-a-database">Writing a log message to a database</a></p></li><li><p><a href="#assigning-sources-and-categories">Assigning sources and categories</a></p></li><li><p><a href="#adding-log-attributes-automatically">Adding log attributes automatically</a></p></li><li><p><a href="#assigning-log-messages-to-different-files">Assigning log messages to different files</a></p></li><li><p><a href="#using-trigger-error">Using trigger_error()</a></p></li></ul></li><li><p><a href="#lazy-initialization">Lazy initialization</a></p></li></ul></div><a name="introduction"></a><a name="id2"></a><h3>Introduction</h3><p>The Even
tLog component provides an API to log events and audit trails with log messages. These log messages are written to files or other storage elements. How and where the log messages are written depends on the log writer.</p><p>The available log writers are:</p><ul><li><p>ezcLogUnixFileWriter, which writes log messages to a file in a <em>Unix</em> file format.</p></li><li><p>ezcLogSyslogWriter, which writes log messages to syslog.</p></li><li><p>ezcLogDatabaseWriter, which writes log messages to the database. This is available in the <a href="introduction_EventLogDatabaseTiein.html">EventLogDatabaseTieIn</a> component.</p></li></ul><p>Each of these writers can be customized or extended.</p><p>An incoming log message can be written with zero or more writers. The writers depend on the variables of the log message itself and the <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogMapper.html'>ezcLogMapper</a> implementation. <a href='/zetacomponents/documentation/tru
nk/EventLog/phpdoc/ezcLogMapper.html'>ezcLogMapper</a> checks the severity, source and category from the log message and forwards the message to the appropriate writers.</p><a name="class-overview"></a><a name="id3"></a><h3>Class overview</h3><p>The following classes are most important to use, customize or extend:</p><dl><dt>ezcLog</dt><dd>The <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLog.html'>ezcLog</a> class is a singleton, meaning that only one instance of it can exist. This class provides methods to configure and record log messages. The recorded log messages are sent to an implementation of <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogMapper.html'>ezcLogMapper</a>, which forwards the messages to the appropriate log writers.</dd><dt>ezcLogMapper</dt><dd>ezcLogMapper provides an interface for log message mapping. Log messages are dispatched from <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLog.html'>ezcLog</a
> to a writer. The particular writer is determined in the class that implements <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogMapper.html'>ezcLogMapper</a> and is assigned in <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLog.html'>ezcLog</a>.</dd><dt>ezcLogFilterSet</dt><dd>ezcLogFilterSet is an implementation of <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogMapper.html'>ezcLogMapper</a>. <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogFilterSet.html'>ezcLogFilterSet</a> contains a set of rules in the form of objects of the class <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogFilterRule.html'>ezcLogFilterRule</a>. These rules are processed sequentially. In other words, the first assigned rule will be processed first. Each rule determines whether the log message matches the filter rule. If the log message matches, it calls the writer and decide whether the filter set stops proce
ssing.The <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogFilterSet.html'>ezcLogFilterSet</a> class is inspired by modern mail application filter settings. Normally these mail filter settings sort the incoming mail and store it in the correct mail folder.</dd><dt>ezcLogWriter</dt><dd>ezcLogWriter provides an interface for the writers. An implementation of this interface is a valid writer and can be addressed by <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogMapper.html'>ezcLogMapper</a>. The writer itself determines how and where the log message is stored.</dd><dt>ezcLogUnixFileWriter</dt><dd>ezcLogUnixFileWriter writes the log message to a file.</dd><dt>ezcLogFilter</dt><dd>ezcLogFilter is a structure to specify which log messages are accepted in a filter set.</dd></dl><p>For more information about these classes, see the class documentation.</p><a name="examples"></a><a name="id4"></a><h3>Examples</h3><a name="writing-a-log-message-to-
file"></a><a name="id5"></a><h4>Writing a log message to file</h4><p>This example creates a file writer and assigns it to the default log mapper.</p><ol class="code">
+ <h2>eZ Components - EventLog</h2><div class="toc"><h3>Table of Contents</h3><ul><li><p><a href="#introduction">Introduction</a></p></li><li><p><a href="#class-overview">Class overview</a></p></li><li><p><a href="#examples">Examples</a></p><ul><li><p><a href="#writing-a-log-message-to-file">Writing a log message to file</a></p></li><li><p><a href="#writing-a-log-message-to-a-database">Writing a log message to a database</a></p></li><li><p><a href="#assigning-sources-and-categories">Assigning sources and categories</a></p></li><li><p><a href="#adding-log-attributes-automatically">Adding log attributes automatically</a></p></li><li><p><a href="#assigning-log-messages-to-different-files">Assigning log messages to different files</a></p></li><li><p><a href="#using-trigger-error">Using trigger_error()</a></p></li></ul></li><li><p><a href="#lazy-initialization">Lazy initialization</a></p></li></ul></div><a name="introduction"></a><a name="id2"></a><h3>Introduction</h3><p>The Even
tLog component provides an API to log events and audit trails with log messages. These log messages are written to files or other storage elements. How and where the log messages are written depends on the log writer.</p><p>The available log writers are:</p><ul><li><p>ezcLogUnixFileWriter, which writes log messages to a file in a <em>Unix</em> file format.</p></li><li><p>ezcLogSyslogWriter, which writes log messages to syslog.</p></li><li><p>ezcLogDatabaseWriter, which writes log messages to the database. This is available in the <a href="../EventLogDatabaseTiein.html#introduction">EventLogDatabaseTieIn</a> component.</p></li></ul><p>Each of these writers can be customized or extended.</p><p>An incoming log message can be written with zero or more writers. The writers depend on the variables of the log message itself and the <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogMapper.html'>ezcLogMapper</a> implementation. <a href='/zetacomponents/documentation/
trunk/EventLog/phpdoc/ezcLogMapper.html'>ezcLogMapper</a> checks the severity, source and category from the log message and forwards the message to the appropriate writers.</p><a name="class-overview"></a><a name="id3"></a><h3>Class overview</h3><p>The following classes are most important to use, customize or extend:</p><dl><dt>ezcLog</dt><dd>The <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLog.html'>ezcLog</a> class is a singleton, meaning that only one instance of it can exist. This class provides methods to configure and record log messages. The recorded log messages are sent to an implementation of <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogMapper.html'>ezcLogMapper</a>, which forwards the messages to the appropriate log writers.</dd><dt>ezcLogMapper</dt><dd>ezcLogMapper provides an interface for log message mapping. Log messages are dispatched from <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLog.html'>ezcLog
</a> to a writer. The particular writer is determined in the class that implements <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogMapper.html'>ezcLogMapper</a> and is assigned in <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLog.html'>ezcLog</a>.</dd><dt>ezcLogFilterSet</dt><dd>ezcLogFilterSet is an implementation of <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogMapper.html'>ezcLogMapper</a>. <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogFilterSet.html'>ezcLogFilterSet</a> contains a set of rules in the form of objects of the class <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogFilterRule.html'>ezcLogFilterRule</a>. These rules are processed sequentially. In other words, the first assigned rule will be processed first. Each rule determines whether the log message matches the filter rule. If the log message matches, it calls the writer and decide whether the filter set stops pr
ocessing.The <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogFilterSet.html'>ezcLogFilterSet</a> class is inspired by modern mail application filter settings. Normally these mail filter settings sort the incoming mail and store it in the correct mail folder.</dd><dt>ezcLogWriter</dt><dd>ezcLogWriter provides an interface for the writers. An implementation of this interface is a valid writer and can be addressed by <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLogMapper.html'>ezcLogMapper</a>. The writer itself determines how and where the log message is stored.</dd><dt>ezcLogUnixFileWriter</dt><dd>ezcLogUnixFileWriter writes the log message to a file.</dd><dt>ezcLogFilter</dt><dd>ezcLogFilter is a structure to specify which log messages are accepted in a filter set.</dd></dl><p>For more information about these classes, see the class documentation.</p><a name="examples"></a><a name="id4"></a><h3>Examples</h3><a name="writing-a-log-message-
to-file"></a><a name="id5"></a><h4>Writing a log message to file</h4><p>This example creates a file writer and assigns it to the default log mapper.</p><ol class="code">
<li><span style="color: #000000"><?php</span></li>
<li></li>
<li><span style="color: #0000FF">require_once </span><span style="color: #335533">'tutorial_autoload.php'</span><span style="color: #0000FF">;</span></li>
@@ -105,7 +105,7 @@
<li></li>
<li><span style="color: #000000">?></span></li>
-</ol><p>First, <em>tutorial_autoload.php</em> is included. This file loads the correct PHP files for the EventLog component.</p><p>Then, the log is set up and a message is written to the log file <em>default.log</em>, to be placed in the <em>/tmp/logs</em> directory.</p><p>After execution, the file <em>/tmp/logs/default.log</em> contains something like this:</p><code class="block">Jan 24 14:39:57 [Warning] [default] [default] Could not connect with the payment server.</code><p>The date, severity, source, category and message are shown. The source and category are both set to default, because they were not specified in the message.</p><a name="writing-a-log-message-to-a-database"></a><a name="id6"></a><h4>Writing a log message to a database</h4><p>With the optional <a href="introduction_EventLogDatabaseTiein.html">EventLogDatabaseTiein</a> component it is also possible to write log messages to a database table. See the <a href="introduction_EventLogDatabaseTiein.html">EventLo
gDatabaseTiein</a> tutorial on how to use the <a href="EventLogDatabaseTiein/ezcLogDatabaseWriter.html">ezcLogDatabaseWriter</a> as writer instead of the <a href="EventLog/ezcLogUnixFileWriter.html">ezcLogUnixFileWriter</a> from this component. You can use both log writers at the same time. See the section <a href="#assigning-log-messages-to-different-files">Assigning log messages to different files</a> on how to use different writers simultaneously.</p><a name="assigning-sources-and-categories"></a><a name="id7"></a><h4>Assigning sources and categories</h4><p>The default source and category from <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLog.html'>ezcLog</a> can be set via the properties <em>source</em> and <em>category</em>. The next example demonstrates how the default properties can be set and how extra variables can be added to the log.</p><ol class="code">
+</ol><p>First, <em>tutorial_autoload.php</em> is included. This file loads the correct PHP files for the EventLog component.</p><p>Then, the log is set up and a message is written to the log file <em>default.log</em>, to be placed in the <em>/tmp/logs</em> directory.</p><p>After execution, the file <em>/tmp/logs/default.log</em> contains something like this:</p><code class="block">Jan 24 14:39:57 [Warning] [default] [default] Could not connect with the payment server.</code><p>The date, severity, source, category and message are shown. The source and category are both set to default, because they were not specified in the message.</p><a name="writing-a-log-message-to-a-database"></a><a name="id6"></a><h4>Writing a log message to a database</h4><p>With the optional <a href="../EventLogDatabaseTiein.html#introduction">EventLogDatabaseTiein</a> component it is also possible to write log messages to a database table. See the <a href="../EventLogDatabaseTiein.html#introduction">E
ventLogDatabaseTiein</a> tutorial on how to use the <a href="../EventLogDatabaseTiein/phpdoc/ezcLogDatabaseWriter.html">ezcLogDatabaseWriter</a> as writer instead of the <a href="../EventLog/phpdoc/ezcLogUnixFileWriter.html">ezcLogUnixFileWriter</a> from this component. You can use both log writers at the same time. See the section <a href="#assigning-log-messages-to-different-files">Assigning log messages to different files</a> on how to use different writers simultaneously.</p><a name="assigning-sources-and-categories"></a><a name="id7"></a><h4>Assigning sources and categories</h4><p>The default source and category from <a href='/zetacomponents/documentation/trunk/EventLog/phpdoc/ezcLog.html'>ezcLog</a> can be set via the properties <em>source</em> and <em>category</em>. The next example demonstrates how the default properties can be set and how extra variables can be added to the log.</p><ol class="code">
<li><span style="color: #000000"><?php</span></li>
<li></li>
<li><span style="color: #0000FF">require_once </span><span style="color: #335533">'tutorial_autoload.php'</span><span style="color: #0000FF">;</span></li>
Modified: incubator/zetacomponents/website/htdocs/documentation/trunk/EventLog/tutorial.txt
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/htdocs/documentation/trunk/EventLog/tutorial.txt?rev=1144915&r1=1144914&r2=1144915&view=diff
==============================================================================
--- incubator/zetacomponents/website/htdocs/documentation/trunk/EventLog/tutorial.txt (original)
+++ incubator/zetacomponents/website/htdocs/documentation/trunk/EventLog/tutorial.txt Sun Jul 10 17:30:59 2011
@@ -106,9 +106,9 @@ ezcLogUnixFileWriter_ from this componen
at the same time. See the section `Assigning log messages to different files`_
on how to use different writers simultaneously.
-.. _EventLogDatabaseTiein: introduction_EventLogDatabaseTiein.html
-.. _ezcLogDatabaseWriter: EventLogDatabaseTiein/ezcLogDatabaseWriter.html
-.. _ezcLogUnixFileWriter: EventLog/ezcLogUnixFileWriter.html
+.. _EventLogDatabaseTiein: ../EventLogDatabaseTiein.html#introduction
+.. _ezcLogDatabaseWriter: ../EventLogDatabaseTiein/phpdoc/ezcLogDatabaseWriter.html
+.. _ezcLogUnixFileWriter: ../EventLog/phpdoc/ezcLogUnixFileWriter.html
Assigning sources and categories