<!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>ClassLoader (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/package-summary.html">Namespace</a></li> <li class="active">Class</li> <li><a href="../../doctrine/common/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/classloader.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\ClassLoader</div> <div class="location">/Doctrine/Common/ClassLoader.php at line 36</div> <h1>Class ClassLoader</h1> <pre class="tree"><strong>ClassLoader</strong><br /></pre> <hr> <p class="signature">public class <strong>ClassLoader</strong></p> <div class="comment" id="overview_description"><p>A <tt>ClassLoader</tt> is an autoloader for class files that can be installed on the SPL autoload stack. It is a class loader that loads only classes of a specific namespace or all namespaces and is suitable for working together with other autoloaders in the SPL autoload stack.</p><p>If no include path is configured through <code><a href="../../doctrine/common/classloader.html#setIncludePath()">setIncludePath</a></code>, a ClassLoader relies on the PHP include_path.</p></div> <dl> <dt>Author:</dt> <dd>Roman Borschel <roman@code-factory.org></dd> <dt>Since:</dt> <dd>2.0</dd> </dl> <hr> <table id="summary_constr"> <tr><th colspan="2">Constructor Summary</th></tr> <tr> <td class="description"><p class="name"><a href="#ClassLoader()">ClassLoader</a>(string ns, mixed includePath)</p><p class="description">Creates a new ClassLoader that loads classes of the specified namespace.</p></td> </tr> </table> <table id="summary_method"> <tr><th colspan="2">Method Summary</th></tr> <tr> <td class="type"> string</td> <td class="description"><p class="name"><a href="#getFileExtension()">getFileExtension</a>()</p><p class="description">Gets the file extension of class files in the namespace of this class loader.</p></td> </tr> <tr> <td class="type"> string</td> <td class="description"><p class="name"><a href="#getIncludePath()">getIncludePath</a>()</p><p class="description">Gets the base include path for all class files in the namespace of this class loader.</p></td> </tr> <tr> <td class="type"> string</td> <td class="description"><p class="name"><a href="#getNamespaceSeparator()">getNamespaceSeparator</a>()</p><p class="description">Gets the namespace separator used by classes in the namespace of this class loader.</p></td> </tr> <tr> <td class="type"> boolean</td> <td class="description"><p class="name"><a href="#loadClass()">loadClass</a>(mixed className, string classname)</p><p class="description">Loads the given class or interface.</p></td> </tr> <tr> <td class="type"> void</td> <td class="description"><p class="name"><a href="#register()">register</a>()</p><p class="description">Installs this class loader on the SPL autoload stack.</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">Sets the file extension of class files in the namespace of this class loader.</p></td> </tr> <tr> <td class="type"> void</td> <td class="description"><p class="name"><a href="#setIncludePath()">setIncludePath</a>(string includePath)</p><p class="description">Sets the base include path for all class files in the namespace of this class loader.</p></td> </tr> <tr> <td class="type"> void</td> <td class="description"><p class="name"><a href="#setNamespaceSeparator()">setNamespaceSeparator</a>(string sep)</p><p class="description">Sets the namespace separator used by classes in the namespace of this class loader.</p></td> </tr> <tr> <td class="type"> void</td> <td class="description"><p class="name"><a href="#unregister()">unregister</a>()</p><p class="description">Uninstalls this class loader on the SPL autoload stack.</p></td> </tr> </table> <h2 id="detail_constr">Constructor Detail</h2> <div class="location">/Doctrine/Common/ClassLoader.php at line 49</div> <h3 id="ClassLoader()">ClassLoader</h3> <code class="signature">public <strong>ClassLoader</strong>(string ns, mixed includePath)</code> <div class="details"> <p>Creates a new <tt>ClassLoader</tt> that loads classes of the specified namespace.</p><dl> <dt>Parameters:</dt> <dd>ns - The namespace to use.</dd> </dl> </div> <hr> <h2 id="detail_method">Method Detail</h2> <div class="location">/Doctrine/Common/ClassLoader.php at line 110</div> <h3 id="getFileExtension()">getFileExtension</h3> <code class="signature">public string <strong>getFileExtension</strong>()</code> <div class="details"> <p>Gets the file extension of class files in the namespace of this class loader.</p></div> <hr> <div class="location">/Doctrine/Common/ClassLoader.php at line 90</div> <h3 id="getIncludePath()">getIncludePath</h3> <code class="signature">public string <strong>getIncludePath</strong>()</code> <div class="details"> <p>Gets the base include path for all class files in the namespace of this class loader.</p></div> <hr> <div class="location">/Doctrine/Common/ClassLoader.php at line 70</div> <h3 id="getNamespaceSeparator()">getNamespaceSeparator</h3> <code class="signature">public string <strong>getNamespaceSeparator</strong>()</code> <div class="details"> <p>Gets the namespace separator used by classes in the namespace of this class loader.</p></div> <hr> <div class="location">/Doctrine/Common/ClassLoader.php at line 137</div> <h3 id="loadClass()">loadClass</h3> <code class="signature">public boolean <strong>loadClass</strong>(mixed className, string classname)</code> <div class="details"> <p>Loads the given class or interface.</p><dl> <dt>Parameters:</dt> <dd>classname - The name of the class to load.</dd> <dt>Returns:</dt> <dd>TRUE if the class has been successfully loaded, FALSE otherwise.</dd> </dl> </div> <hr> <div class="location">/Doctrine/Common/ClassLoader.php at line 118</div> <h3 id="register()">register</h3> <code class="signature">public void <strong>register</strong>()</code> <div class="details"> <p>Installs this class loader on the SPL autoload stack.</p></div> <hr> <div class="location">/Doctrine/Common/ClassLoader.php at line 100</div> <h3 id="setFileExtension()">setFileExtension</h3> <code class="signature">public void <strong>setFileExtension</strong>(string fileExtension)</code> <div class="details"> <p>Sets the file extension of class files in the namespace of this class loader.</p></div> <hr> <div class="location">/Doctrine/Common/ClassLoader.php at line 80</div> <h3 id="setIncludePath()">setIncludePath</h3> <code class="signature">public void <strong>setIncludePath</strong>(string includePath)</code> <div class="details"> <p>Sets the base include path for all class files in the namespace of this class loader.</p></div> <hr> <div class="location">/Doctrine/Common/ClassLoader.php at line 60</div> <h3 id="setNamespaceSeparator()">setNamespaceSeparator</h3> <code class="signature">public void <strong>setNamespaceSeparator</strong>(string sep)</code> <div class="details"> <p>Sets the namespace separator used by classes in the namespace of this class loader.</p><dl> <dt>Parameters:</dt> <dd>sep - The separator to use.</dd> </dl> </div> <hr> <div class="location">/Doctrine/Common/ClassLoader.php at line 126</div> <h3 id="unregister()">unregister</h3> <code class="signature">public void <strong>unregister</strong>()</code> <div class="details"> <p>Uninstalls this class loader on the SPL autoload stack.</p></div> <hr> <div class="header"> <h1>Doctrine</h1> <ul> <li><a href="../../overview-summary.html">Overview</a></li> <li><a href="../../doctrine/common/package-summary.html">Namespace</a></li> <li class="active">Class</li> <li><a href="../../doctrine/common/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/classloader.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>