init

author: Horus3 2014-02-24 16:42:14 +0100
committer: Horus3 2014-02-24 16:42:14 +0100
commit: 06f945f27840b53e57795dadbc38e76f7e11ab1c (patch)
tree: 689d5c7f4ffa15460c7e90f47c6a7dd59ce4e8bd /zend/documentation/api/core/files/Registry.html
download: random-06f945f27840b53e57795dadbc38e76f7e11ab1c.tar.gz
1 files changed, 54 insertions, 0 deletions
diff --git a/zend/documentation/api/core/files/Registry.html b/zend/documentation/api/core/files/Registry.html
new file mode 100644
index 0000000..a9be89f
--- /dev/null
+++ b/zend/documentation/api/core/files/Registry.html
@@ -0,0 +1,54 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Zend Gdata API Documentation</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><link rel="stylesheet" href="../css/template.css" type="text/css"></link><script type="text/javascript" src="../js/jquery-1.4.2.min.js"></script><script type="text/javascript" src="../js/jquery.tools.min.js"></script><script type="text/javascript" src="../js/jquery-ui-1.8.2.custom.min.js"></script><script type="text/javascript" src="../js/template.js"></script></head><body><div id="content"><h1 class="file">Registry.php</h1><div id="file-nav-box"><div id="file-nav-options">
+              Show:
+              <img src="../images/icons/visibility_public.png" alt="Public" id="show-public"></img><img src="../images/icons/visibility_protected.png" alt="Protected" id="show-protected"></img><img src="../images/icons/visibility_private.png" alt="Private" id="show-private"></img><span class="attribute" id="show-inherited">inherited</span></div><div id="file-nav-container"><ul id="file-nav"><li><a href="#classes"><img src="../images/icons/class.png" alt="Class" height="14"></img>
+                          Classes
+                      </a><ul><li><a href="#\Zend_Registry">\Zend_Registry</a></li></ul></li></ul><div style="clear: left;"></div></div><div id="file-nav-tab">
+              Table of Contents
+          </div></div><a name="top" class="anchor"></a><div id="file-description"><div class="short-description">Zend Framework</div><div class="long-description"><p>LICENSE</p>
+
+<p>This source file is subject to the new BSD license that is bundled
+with this package in the file LICENSE.txt.
+It is also available through the world-wide-web at this URL:
+http://framework.zend.com/license/new-bsd
+If you did not receive a copy of the license and are unable to
+obtain it through the world-wide-web, please send an email
+to license@zend.com so we can send you a copy immediately.</p></div></div><dl class="file-info"><dt>Category</dt><dd>Zend
+         
+    </dd><dt>Copyright</dt><dd>Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
+         
+    </dd><dt>License</dt><dd><a href="http://framework.zend.com/license/new-bsd">New BSD License</a>
+         
+    </dd><dt>Package</dt><dd>Zend_Registry
+         
+    </dd><dt>Version</dt><dd>$Id: Registry.php 24593 2012-01-05 20:35:02Z matthew $
+         
+    </dd></dl><a name="classes" class="anchor"></a><a id="\Zend_Registry" class="anchor"></a><h2 class="class">\Zend_Registry<div class="to-top"><a href="#top">jump to top</a></div></h2><div class="class"><small class="package"><b>Package: </b>Zend\Registry</small><div class="short-description">Generic storage class helps to manage global data.</div><div class="long-description"></div><dl class="class-info"><dt>Parent(s)</dt><dd><a href="../files/http://php.net/manual/en/class.arrayobject.php">\ArrayObject</a></dd><dt>Category</dt><dd>Zend
+         
+    </dd><dt>Copyright</dt><dd>Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
+         
+    </dd><dt>License</dt><dd><a href="http://framework.zend.com/license/new-bsd">New BSD License</a>
+         
+    </dd></dl><h3>Properties</h3><div><a id="\Zend_Registry::$_registry" class="anchor"></a><div class="property private"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img>\Zend_Registry <span class="highlight">$_registry</span> = null</code><div class="description"><span class="attribute">static</span><div class="short-description">Registry object provides storage for shared objects.</div></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>null</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd><a href="../files/Registry.html#\Zend_Registry">\Zend_Registry</a></dd></dl></div><div class="clear"></div></div><a id="\Zend_Registry::$_registryClassName" class="anchor"></a><div class="property private"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img>string <span class="highlight">$_registryClassName</span> = 'Zend_Registry'</code><div class="description"><span class="attribute">static</span><div class="short-description">Class name of the singleton registry object.</div></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>'Zend_Registry'</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>string</dd></dl></div><div class="clear"></div></div></div><h3>Methods</h3><div><a id="\Zend_Registry::__construct()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">__construct</span><span class="nb-faded-text">(array $array = array(), integer $flags = parent::ARRAY_AS_PROPS)</span> : void</code><div class="description"><p class="short_description">Constructs a parent ArrayObject with default
+ARRAY_AS_PROPS to allow acces as an object</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$array</th><td>array</td><td><em><p>data array</p></em></td></tr><tr><th>$flags</th><td>integer</td><td><em><p>ArrayObject flags</p></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Registry::_unsetInstance()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">_unsetInstance</span><span class="nb-faded-text">()</span> : void</code><div class="description"><span class="attribute">static</span><p class="short_description">Unset the default registry instance.</p></div><div class="code-tabs"><div class="long-description"><p>Primarily used in tearDown() in unit tests.</p></div><strong>Details</strong><dl class="function-info"><dt>Returns</dt><dd>void
+         
+    </dd></dl></div><div class="clear"></div></div><a id="\Zend_Registry::get()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">get</span><span class="nb-faded-text">(string $index)</span> : mixed</code><div class="description"><span class="attribute">static</span><p class="short_description">getter method, basically same as offsetGet().</p></div><div class="code-tabs"><div class="long-description"><p>This method can be called from an object of type Zend_Registry, or it
+can be called statically.  In the latter case, it uses the default
+static instance stored in the class.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$index</th><td>string</td><td><em><ul>
+<li>get the value associated with $index</li>
+</ul>
+</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>mixed</td><td></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Exception.html#\Zend_Exception">\Zend_Exception</a></td><td><em>if no entry is registerd for $index.</em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Registry::getInstance()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getInstance</span><span class="nb-faded-text">()</span> : <a href="../files/Registry.html#\Zend_Registry">\Zend_Registry</a></code><div class="description"><span class="attribute">static</span><p class="short_description">Retrieves the default registry instance.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Registry.html#\Zend_Registry">\Zend_Registry</a></td><td></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Registry::init()" class="anchor"></a><div class="method protected"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"></img><span class="highlight">init</span><span class="nb-faded-text">()</span> : void</code><div class="description"><span class="attribute">static</span><p class="short_description">Initialize the default registry instance.</p></div><div class="code-tabs"><div class="long-description"></div></div><div class="clear"></div></div><a id="\Zend_Registry::isRegistered()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">isRegistered</span><span class="nb-faded-text">(string $index)</span> : boolean</code><div class="description"><span class="attribute">static</span><p class="short_description">Returns TRUE if the $index is a named value in the registry,
+or FALSE if $index was not found in the registry.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$index</th><td>string</td><td><em></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>boolean</td><td></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Registry::offsetExists()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">offsetExists</span><span class="nb-faded-text">(string $index)</span> : void</code><div class="description"><p class="short_description"></p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$index</th><td>string</td><td><em></em></td></tr></table><strong>Details</strong><dl class="function-info"><dt>Returns</dt><dd>mixed
+Workaround for http://bugs.php.net/bug.php?id=40442 (ZF-960).
+         
+    </dd></dl></div><div class="clear"></div></div><a id="\Zend_Registry::set()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">set</span><span class="nb-faded-text">(string $index, mixed $value)</span> : void</code><div class="description"><span class="attribute">static</span><p class="short_description">setter method, basically same as offsetSet().</p></div><div class="code-tabs"><div class="long-description"><p>This method can be called from an object of type Zend_Registry, or it
+can be called statically.  In the latter case, it uses the default
+static instance stored in the class.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$index</th><td>string</td><td><em><p>The location in the ArrayObject in which to store
+  the value.</p></em></td></tr><tr><th>$value</th><td>mixed</td><td><em><p>The object to store in the ArrayObject.</p></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Registry::setClassName()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">setClassName</span><span class="nb-faded-text">(string $registryClassName = 'Zend_Registry')</span> : void</code><div class="description"><span class="attribute">static</span><p class="short_description">Set the class name to use for the default registry instance.</p></div><div class="code-tabs"><div class="long-description"><p>Does not affect the currently initialized instance, it only applies
+for the next time you instantiate.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$registryClassName</th><td>string</td><td><em></em></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Exception.html#\Zend_Exception">\Zend_Exception</a></td><td><em>if the registry is initialized or if the
+  class name is not valid.</em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Registry::setInstance()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">setInstance</span><span class="nb-faded-text">(<a href="../files/Registry.html#\Zend_Registry">\Zend_Registry</a> $registry)</span> : void</code><div class="description"><span class="attribute">static</span><p class="short_description">Set the default registry instance to a specified instance.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$registry</th><td><a href="../files/Registry.html#\Zend_Registry">\Zend_Registry</a></td><td><em><p>An object instance of type Zend_Registry,
+  or a subclass.</p></em></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Exception.html#\Zend_Exception">\Zend_Exception</a></td><td><em>if registry is already initialized.</em></td></tr></table></div><div class="clear"></div></div></div></div></div><small class="footer">
+            Documentation was generated by
+            <a href="http://phpdoc.org">phpDocumentor
+                2.0.0a12</a>.
+        </small></body></html>
author	Horus3	2014-02-24 16:42:14 +0100
committer	Horus3	2014-02-24 16:42:14 +0100
commit	06f945f27840b53e57795dadbc38e76f7e11ab1c (patch)
tree	689d5c7f4ffa15460c7e90f47c6a7dd59ce4e8bd /zend/documentation/api/core/files/Registry.html
download	random-06f945f27840b53e57795dadbc38e76f7e11ab1c.tar.gz