<!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>AbstractFileDriver (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/abstractfiledriver.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\AbstractFileDriver</div> <div class="location">/Doctrine/ORM/Mapping/Driver/AbstractFileDriver.php at line 43</div> <h1>Class AbstractFileDriver</h1> <pre class="tree"><strong>AbstractFileDriver</strong><br /></pre> <dl> <dt>All Implemented Interfaces:</dt> <dd>Driver </dt> </dl> <hr> <p class="signature">public abstract class <strong>AbstractFileDriver</strong></p> <div class="comment" id="overview_description"><p>Base driver for file-based metadata drivers.</p><p>A file driver operates in a mode where it loads the mapping files of individual classes on demand. This requires the user to adhere to the convention of 1 mapping file per class and the file names of the mapping files must correspond to the full class name, including namespace, with the namespace delimiters '\', replaced by dots '.'.</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.com</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 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="#AbstractFileDriver()">AbstractFileDriver</a>(string|array paths)</p><p class="description">Initializes a new FileDriver that looks in the given path(s) for mapping documents and operates in the specified operating mode.</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"> array</td> <td class="description"><p class="name"><a href="#getAllClassNames()">getAllClassNames</a>()</p><p class="description">Gets the names of all mapped classes known to this driver.</p></td> </tr> <tr> <td class="type"> array</td> <td class="description"><p class="name"><a href="#getElement()">getElement</a>(mixed className)</p><p class="description">Get the element of schema meta data for the class from the mapping file. </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 should have its metadata loaded. </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/AbstractFileDriver.php at line 57</div> <h3 id="_fileExtension">_fileExtension</h3> <code class="signature">protected string <strong>$_fileExtension</strong></code> <div class="details"> <p>The file extension of mapping documents.</p></div> <hr> <div class="location">/Doctrine/ORM/Mapping/Driver/AbstractFileDriver.php at line 50</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/AbstractFileDriver.php at line 65</div> <h3 id="AbstractFileDriver()">AbstractFileDriver</h3> <code class="signature">public <strong>AbstractFileDriver</strong>(string|array paths)</code> <div class="details"> <p>Initializes a new FileDriver that looks in the given path(s) for mapping documents and operates in the specified operating mode.</p><dl> <dt>Parameters:</dt> <dd>paths - One or multiple paths where mapping documents can be found.</dd> </dl> </div> <hr> <h2 id="detail_method">Method Detail</h2> <div class="location">/Doctrine/ORM/Mapping/Driver/AbstractFileDriver.php at line 75</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/AbstractFileDriver.php at line 151</div> <h3 id="getAllClassNames()">getAllClassNames</h3> <code class="signature">public array <strong>getAllClassNames</strong>()</code> <div class="details"> <p>Gets the names of all mapped classes known to this driver.</p><dl> <dt>Returns:</dt> <dd>The names of all mapped classes known to this driver.</dd> </dl> </div> <hr> <div class="location">/Doctrine/ORM/Mapping/Driver/AbstractFileDriver.php at line 117</div> <h3 id="getElement()">getElement</h3> <code class="signature">public array <strong>getElement</strong>(mixed className)</code> <div class="details"> <p>Get the element of schema meta data for the class from the mapping file. This will lazily load the mapping file if it is not loaded yet</p><dl> <dt>Returns:</dt> <dd>$element The element of schema meta data</dd> </dl> </div> <hr> <div class="location">/Doctrine/ORM/Mapping/Driver/AbstractFileDriver.php at line 95</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/AbstractFileDriver.php at line 85</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/AbstractFileDriver.php at line 132</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 should have its metadata loaded. This is only the case if it is either mapped as an Entity or a MappedSuperclass.</p></div> <hr> <div class="location">/Doctrine/ORM/Mapping/Driver/AbstractFileDriver.php at line 106</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/abstractfiledriver.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>