<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html lang="en"> <head> <meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)"> <meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000"> <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> <link rel="start" href="../../../overview-summary.html"> <title>AnnotationReader (Doctrine)</title> </head> <body id="definition" onload="parent.document.title=document.title;"> <div class="header"> <h1>Doctrine</h1> <ul> <li><a href="../../../overview-summary.html">Overview</a></li> <li><a href="../../../doctrine/common/annotations/package-summary.html">Namespace</a></li> <li class="active">Class</li> <li><a href="../../../doctrine/common/annotations/package-tree.html">Tree</a></li> <li><a href="../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../index-all.html">Index</a></li> </ul> </div> <div class="small_links"> <a href="../../../index.html" target="_top">Frames</a> <a href="../../../doctrine/common/annotations/annotationreader.html" target="_top">No frames</a> </div> <div class="small_links"> Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a> Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a> </div> <hr> <div class="qualifiedName">Doctrine\Common\Annotations\AnnotationReader</div> <div class="location">/Doctrine/Common/Annotations/AnnotationReader.php at line 41</div> <h1>Class AnnotationReader</h1> <pre class="tree"><strong>AnnotationReader</strong><br /></pre> <hr> <p class="signature">public class <strong>AnnotationReader</strong></p> <div class="comment" id="overview_description"><p>A reader for docblock annotations.</p></div> <dl> <dt>License:</dt> <dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd> <dt>See Also:</dt> <dd><code>www.doctrine-project.org</code></dd> <dt>Since:</dt> <dd>2.0</dd> <dt>Version:</dt> <dd>$Revision: 3938 $</dd> <dt>Author:</dt> <dd>Benjamin Eberlei <kontakt@beberlei.de></dd> <dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd> <dd>Jonathan Wage <jonwage@gmail.com></dd> <dd>Roman Borschel <roman@code-factory.org></dd> </dl> <hr> <table id="summary_constr"> <tr><th colspan="2">Constructor Summary</th></tr> <tr> <td class="description"><p class="name"><a href="#AnnotationReader()">AnnotationReader</a>(<a href="../../../doctrine/common/cache/cache.html">Cache</a> cache)</p><p class="description">Constructor. </p></td> </tr> </table> <table id="summary_method"> <tr><th colspan="2">Method Summary</th></tr> <tr> <td class="type"> The</td> <td class="description"><p class="name"><a href="#getClassAnnotation()">getClassAnnotation</a>(mixed class, string annotation, $class )</p><p class="description">Gets a class annotation.</p></td> </tr> <tr> <td class="type"> array</td> <td class="description"><p class="name"><a href="#getClassAnnotations()">getClassAnnotations</a>(string|ReflectionClass class)</p><p class="description">Gets the annotations applied to a class.</p></td> </tr> <tr> <td class="type"> The</td> <td class="description"><p class="name"><a href="#getMethodAnnotation()">getMethodAnnotation</a>(ReflectionMethod method, string annotation)</p><p class="description">Gets a method annotation.</p></td> </tr> <tr> <td class="type"> array</td> <td class="description"><p class="name"><a href="#getMethodAnnotations()">getMethodAnnotations</a>(mixed method, string|ReflectionClass class, string|ReflectionMethod property)</p><p class="description">Gets the annotations applied to a method.</p></td> </tr> <tr> <td class="type"> The</td> <td class="description"><p class="name"><a href="#getPropertyAnnotation()">getPropertyAnnotation</a>(ReflectionProperty property, string annotation)</p><p class="description">Gets a property annotation.</p></td> </tr> <tr> <td class="type"> array</td> <td class="description"><p class="name"><a href="#getPropertyAnnotations()">getPropertyAnnotations</a>(string|ReflectionProperty property, string|ReflectionClass class)</p><p class="description">Gets the annotations applied to a property.</p></td> </tr> <tr> <td class="type"> void</td> <td class="description"><p class="name"><a href="#setAnnotationNamespaceAlias()">setAnnotationNamespaceAlias</a>(mixed namespace, mixed alias, $alias )</p><p class="description">Sets an alias for an annotation namespace.</p></td> </tr> <tr> <td class="type"> void</td> <td class="description"><p class="name"><a href="#setDefaultAnnotationNamespace()">setDefaultAnnotationNamespace</a>(string defaultNamespace)</p><p class="description">Sets the default namespace that the AnnotationReader should assume for annotations with not fully qualified names.</p></td> </tr> </table> <h2 id="detail_constr">Constructor Detail</h2> <div class="location">/Doctrine/Common/Annotations/AnnotationReader.php at line 71</div> <h3 id="AnnotationReader()">AnnotationReader</h3> <code class="signature">public <strong>AnnotationReader</strong>(<a href="../../../doctrine/common/cache/cache.html">Cache</a> cache)</code> <div class="details"> <p>Constructor. Initializes a new AnnotationReader that uses the given Cache provider.</p><dl> <dt>Parameters:</dt> <dd>cache - The cache provider to use. If none is provided, ArrayCache is used.</dd> </dl> </div> <hr> <h2 id="detail_method">Method Detail</h2> <div class="location">/Doctrine/Common/Annotations/AnnotationReader.php at line 128</div> <h3 id="getClassAnnotation()">getClassAnnotation</h3> <code class="signature">public The <strong>getClassAnnotation</strong>(mixed class, string annotation, $class )</code> <div class="details"> <p>Gets a class annotation.</p><dl> <dt>Parameters:</dt> <dd></dd> <dd>annotation - The name of the annotation.</dd> <dt>Returns:</dt> <dd>Annotation or NULL, if the requested annotation does not exist.</dd> </dl> </div> <hr> <div class="location">/Doctrine/Common/Annotations/AnnotationReader.php at line 106</div> <h3 id="getClassAnnotations()">getClassAnnotations</h3> <code class="signature">public array <strong>getClassAnnotations</strong>(string|ReflectionClass class)</code> <div class="details"> <p>Gets the annotations applied to a class.</p><dl> <dt>Parameters:</dt> <dd>class - The name or ReflectionClass of the class from which the class annotations should be read.</dd> <dt>Returns:</dt> <dd>An array of Annotations.</dd> </dl> </div> <hr> <div class="location">/Doctrine/Common/Annotations/AnnotationReader.php at line 202</div> <h3 id="getMethodAnnotation()">getMethodAnnotation</h3> <code class="signature">public The <strong>getMethodAnnotation</strong>(ReflectionMethod method, string annotation)</code> <div class="details"> <p>Gets a method annotation.</p><dl> <dt>Parameters:</dt> <dd></dd> <dd>annotation - The name of the annotation.</dd> <dt>Returns:</dt> <dd>Annotation or NULL, if the requested annotation does not exist.</dd> </dl> </div> <hr> <div class="location">/Doctrine/Common/Annotations/AnnotationReader.php at line 179</div> <h3 id="getMethodAnnotations()">getMethodAnnotations</h3> <code class="signature">public array <strong>getMethodAnnotations</strong>(mixed method, string|ReflectionClass class, string|ReflectionMethod property)</code> <div class="details"> <p>Gets the annotations applied to a method.</p><dl> <dt>Parameters:</dt> <dd>class - The name or ReflectionClass of the class that owns the method.</dd> <dd>property - The name or ReflectionMethod of the method from which the annotations should be read.</dd> <dt>Returns:</dt> <dd>An array of Annotations.</dd> </dl> </div> <hr> <div class="location">/Doctrine/Common/Annotations/AnnotationReader.php at line 165</div> <h3 id="getPropertyAnnotation()">getPropertyAnnotation</h3> <code class="signature">public The <strong>getPropertyAnnotation</strong>(ReflectionProperty property, string annotation)</code> <div class="details"> <p>Gets a property annotation.</p><dl> <dt>Parameters:</dt> <dd></dd> <dd>annotation - The name of the annotation.</dd> <dt>Returns:</dt> <dd>Annotation or NULL, if the requested annotation does not exist.</dd> </dl> </div> <hr> <div class="location">/Doctrine/Common/Annotations/AnnotationReader.php at line 142</div> <h3 id="getPropertyAnnotations()">getPropertyAnnotations</h3> <code class="signature">public array <strong>getPropertyAnnotations</strong>(string|ReflectionProperty property, string|ReflectionClass class)</code> <div class="details"> <p>Gets the annotations applied to a property.</p><dl> <dt>Parameters:</dt> <dd>class - The name or ReflectionClass of the class that owns the property.</dd> <dd>property - The name or ReflectionProperty of the property from which the annotations should be read.</dd> <dt>Returns:</dt> <dd>An array of Annotations.</dd> </dl> </div> <hr> <div class="location">/Doctrine/Common/Annotations/AnnotationReader.php at line 94</div> <h3 id="setAnnotationNamespaceAlias()">setAnnotationNamespaceAlias</h3> <code class="signature">public void <strong>setAnnotationNamespaceAlias</strong>(mixed namespace, mixed alias, $alias )</code> <div class="details"> <p>Sets an alias for an annotation namespace.</p></div> <hr> <div class="location">/Doctrine/Common/Annotations/AnnotationReader.php at line 83</div> <h3 id="setDefaultAnnotationNamespace()">setDefaultAnnotationNamespace</h3> <code class="signature">public void <strong>setDefaultAnnotationNamespace</strong>(string defaultNamespace)</code> <div class="details"> <p>Sets the default namespace that the AnnotationReader should assume for annotations with not fully qualified names.</p></div> <hr> <div class="header"> <h1>Doctrine</h1> <ul> <li><a href="../../../overview-summary.html">Overview</a></li> <li><a href="../../../doctrine/common/annotations/package-summary.html">Namespace</a></li> <li class="active">Class</li> <li><a href="../../../doctrine/common/annotations/package-tree.html">Tree</a></li> <li><a href="../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../index-all.html">Index</a></li> </ul> </div> <div class="small_links"> <a href="../../../index.html" target="_top">Frames</a> <a href="../../../doctrine/common/annotations/annotationreader.html" target="_top">No frames</a> </div> <div class="small_links"> Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a> Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a> </div> <hr> <p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p> </body> </html>