<!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:05 +0000">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css">
<link rel="start" href="../../../../overview-summary.html">
<title>AnnotationDriver (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/orm/mapping/driver/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../../doctrine/orm/mapping/driver/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/orm/mapping/driver/annotationdriver.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\ORM\Mapping\Driver\AnnotationDriver</div>
<div class="location">/Doctrine/ORM/Mapping/Driver/AnnotationDriver.php at line 43</div>
<h1>Class AnnotationDriver</h1>
<pre class="tree"><strong>AnnotationDriver</strong><br /></pre>
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>Driver </dt>
</dl>
<hr>
<p class="signature">public class <strong>AnnotationDriver</strong></p>
<div class="comment" id="overview_description"><p>The AnnotationDriver reads the mapping metadata from 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$</dd>
<dt>Author Benjamin:</dt>
<dd>Eberlei <kontakt@beberlei.de></dd>
<dt>Author Guilherme:</dt>
<dd>Blanco <guilhermeblanco@hotmail.com></dd>
<dt>Author:</dt>
<dd>Jonathan H. Wage <jonwage@gmail.com></dd>
<dd>Roman Borschel <roman@code-factory.org></dd>
</dl>
<hr>
<table id="summary_field">
<tr><th colspan="2">Field Summary</th></tr>
<tr>
<td class="type">protected mixed</td>
<td class="description"><p class="name"><a href="#_classNames">$_classNames</a></p><p class="description"></p></td>
</tr>
<tr>
<td class="type">protected string</td>
<td class="description"><p class="name"><a href="#_fileExtension">$_fileExtension</a></p><p class="description">The file extension of mapping documents.</p></td>
</tr>
<tr>
<td class="type">protected array</td>
<td class="description"><p class="name"><a href="#_paths">$_paths</a></p><p class="description">The paths where to look for mapping files.</p></td>
</tr>
</table>
<table id="summary_constr">
<tr><th colspan="2">Constructor Summary</th></tr>
<tr>
<td class="description"><p class="name"><a href="#AnnotationDriver()">AnnotationDriver</a>(mixed reader, string|array paths, $reader The)</p><p class="description">Initializes a new AnnotationDriver that uses the given AnnotationReader for reading
docblock annotations.</p></td>
</tr>
</table>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#addPaths()">addPaths</a>(array paths)</p><p class="description">Append lookup paths to metadata driver.</p></td>
</tr>
<tr>
<td class="type">static <a href="../../../../doctrine/orm/mapping/driver/annotationdriver.html">AnnotationDriver</a></td>
<td class="description"><p class="name"><a href="#create()">create</a>(array|string paths, <a href="../../../../doctrine/common/annotations/annotationreader.html">AnnotationReader</a> reader)</p><p class="description">Factory method for the Annotation Driver</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#getAllClassNames()">getAllClassNames</a>()</p><p class="description">{@inheritDoc}</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#getFileExtension()">getFileExtension</a>()</p><p class="description">Get the file extension used to look for mapping files under</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#getPaths()">getPaths</a>()</p><p class="description">Retrieve the defined metadata lookup paths.</p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#isTransient()">isTransient</a>(string className)</p><p class="description">Whether the class with the specified name is transient. </p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#loadMetadataForClass()">loadMetadataForClass</a>(mixed className, mixed metadata)</p><p class="description">{@inheritdoc}</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#setFileExtension()">setFileExtension</a>(string fileExtension)</p><p class="description">Set the file extension used to look for mapping files under</p></td>
</tr>
</table>
<h2 id="detail_field">Field Detail</h2>
<div class="location">/Doctrine/ORM/Mapping/Driver/AnnotationDriver.php at line 69</div>
<h3 id="_classNames">_classNames</h3>
<code class="signature">protected mixed <strong>$_classNames</strong></code>
<div class="details">
<p></p></div>
<hr>
<div class="location">/Doctrine/ORM/Mapping/Driver/AnnotationDriver.php at line 64</div>
<h3 id="_fileExtension">_fileExtension</h3>
<code class="signature">protected string <strong>$_fileExtension</strong> = '.php'</code>
<div class="details">
<p>The file extension of mapping documents.</p></div>
<hr>
<div class="location">/Doctrine/ORM/Mapping/Driver/AnnotationDriver.php at line 57</div>
<h3 id="_paths">_paths</h3>
<code class="signature">protected array <strong>$_paths</strong> = array()</code>
<div class="details">
<p>The paths where to look for mapping files.</p></div>
<hr>
<h2 id="detail_constr">Constructor Detail</h2>
<div class="location">/Doctrine/ORM/Mapping/Driver/AnnotationDriver.php at line 78</div>
<h3 id="AnnotationDriver()">AnnotationDriver</h3>
<code class="signature">public <strong>AnnotationDriver</strong>(mixed reader, string|array paths, $reader The)</code>
<div class="details">
<p>Initializes a new AnnotationDriver that uses the given AnnotationReader for reading
docblock annotations.</p><dl>
<dt>Parameters:</dt>
<dd>The - AnnotationReader to use.</dd>
<dd>paths - One or multiple paths where mapping classes can be found.</dd>
</dl>
</div>
<hr>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/ORM/Mapping/Driver/AnnotationDriver.php at line 91</div>
<h3 id="addPaths()">addPaths</h3>
<code class="signature">public void <strong>addPaths</strong>(array paths)</code>
<div class="details">
<p>Append lookup paths to metadata driver.</p></div>
<hr>
<div class="location">/Doctrine/ORM/Mapping/Driver/AnnotationDriver.php at line 481</div>
<h3 id="create()">create</h3>
<code class="signature">public static <a href="../../../../doctrine/orm/mapping/driver/annotationdriver.html">AnnotationDriver</a> <strong>create</strong>(array|string paths, <a href="../../../../doctrine/common/annotations/annotationreader.html">AnnotationReader</a> reader)</code>
<div class="details">
<p>Factory method for the Annotation Driver</p></div>
<hr>
<div class="location">/Doctrine/ORM/Mapping/Driver/AnnotationDriver.php at line 425</div>
<h3 id="getAllClassNames()">getAllClassNames</h3>
<code class="signature">public void <strong>getAllClassNames</strong>()</code>
<div class="details">
<p></p></div>
<hr>
<div class="location">/Doctrine/ORM/Mapping/Driver/AnnotationDriver.php at line 111</div>
<h3 id="getFileExtension()">getFileExtension</h3>
<code class="signature">public void <strong>getFileExtension</strong>()</code>
<div class="details">
<p>Get the file extension used to look for mapping files under</p></div>
<hr>
<div class="location">/Doctrine/ORM/Mapping/Driver/AnnotationDriver.php at line 101</div>
<h3 id="getPaths()">getPaths</h3>
<code class="signature">public array <strong>getPaths</strong>()</code>
<div class="details">
<p>Retrieve the defined metadata lookup paths.</p></div>
<hr>
<div class="location">/Doctrine/ORM/Mapping/Driver/AnnotationDriver.php at line 414</div>
<h3 id="isTransient()">isTransient</h3>
<code class="signature">public boolean <strong>isTransient</strong>(string className)</code>
<div class="details">
<p>Whether the class with the specified name is transient. Only non-transient
classes, that is entities and mapped superclasses, should have their metadata loaded.
A class is non-transient if it is annotated with either @Entity or</p><dl>
<dt>MappedSuperclass:</dt>
<dd>in the class doc block.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/ORM/Mapping/Driver/AnnotationDriver.php at line 130</div>
<h3 id="loadMetadataForClass()">loadMetadataForClass</h3>
<code class="signature">public void <strong>loadMetadataForClass</strong>(mixed className, mixed metadata)</code>
<div class="details">
<p></p></div>
<hr>
<div class="location">/Doctrine/ORM/Mapping/Driver/AnnotationDriver.php at line 122</div>
<h3 id="setFileExtension()">setFileExtension</h3>
<code class="signature">public void <strong>setFileExtension</strong>(string fileExtension)</code>
<div class="details">
<p>Set the file extension used to look for mapping files under</p><dl>
<dt>Parameters:</dt>
<dd>fileExtension - The file extension to set</dd>
</dl>
</div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="../../../../doctrine/orm/mapping/driver/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../../doctrine/orm/mapping/driver/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/orm/mapping/driver/annotationdriver.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>