221 lines
8.8 KiB
HTML
221 lines
8.8 KiB
HTML
<!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:04 +0000">
|
|
|
|
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
|
|
<link rel="start" href="../../../overview-summary.html">
|
|
|
|
<title>ClassMetadataFactory (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/package-summary.html">Namespace</a></li>
|
|
<li class="active">Class</li>
|
|
<li><a href="../../../doctrine/orm/mapping/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/classmetadatafactory.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\ClassMetadataFactory</div>
|
|
<div class="location">/Doctrine/ORM/Mapping/ClassMetadataFactory.php at line 42</div>
|
|
|
|
<h1>Class ClassMetadataFactory</h1>
|
|
|
|
<pre class="tree"><strong>ClassMetadataFactory</strong><br /></pre>
|
|
|
|
<hr>
|
|
|
|
<p class="signature">public class <strong>ClassMetadataFactory</strong></p>
|
|
|
|
<div class="comment" id="overview_description"><p>The ClassMetadataFactory is used to create ClassMetadata objects that contain all the
|
|
metadata mapping informations of a class which describes how a class should be mapped
|
|
to a relational database.</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:</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="#ClassMetadataFactory()">ClassMetadataFactory</a>(mixed em, $driver The)</p><p class="description">Creates a new factory instance that uses the given metadata driver implementation.</p></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<table id="summary_method">
|
|
<tr><th colspan="2">Method Summary</th></tr>
|
|
<tr>
|
|
<td class="type"> array</td>
|
|
<td class="description"><p class="name"><a href="#getAllMetadata()">getAllMetadata</a>()</p><p class="description">Forces the factory to load the metadata of all classes known to the underlying
|
|
mapping driver.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> Doctrine\Common\Cache\Cache</td>
|
|
<td class="description"><p class="name"><a href="#getCacheDriver()">getCacheDriver</a>()</p><p class="description">Gets the cache driver used by the factory to cache ClassMetadata instances.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#getLoadedMetadata()">getLoadedMetadata</a>()</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> Doctrine\ORM\Mapping\ClassMetadata</td>
|
|
<td class="description"><p class="name"><a href="#getMetadataFor()">getMetadataFor</a>(string className)</p><p class="description">Gets the class metadata descriptor for a class.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> boolean</td>
|
|
<td class="description"><p class="name"><a href="#hasMetadataFor()">hasMetadataFor</a>(string className)</p><p class="description">Checks whether the factory has the metadata for a class loaded already.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#setCacheDriver()">setCacheDriver</a>(Doctrine\Common\Cache\Cache cacheDriver)</p><p class="description">Sets the cache driver used by the factory to cache ClassMetadata instances.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#setMetadataFor()">setMetadataFor</a>(string className, <a href="../../../doctrine/orm/mapping/classmetadata.html">ClassMetadata</a> class)</p><p class="description">Sets the metadata descriptor for a specific class.
|
|
</p></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2 id="detail_constr">Constructor Detail</h2>
|
|
<div class="location">/Doctrine/ORM/Mapping/ClassMetadataFactory.php at line 61</div>
|
|
<h3 id="ClassMetadataFactory()">ClassMetadataFactory</h3>
|
|
<code class="signature">public <strong>ClassMetadataFactory</strong>(mixed em, $driver The)</code>
|
|
<div class="details">
|
|
<p>Creates a new factory instance that uses the given metadata driver implementation.</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>The - metadata driver to use.</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<h2 id="detail_method">Method Detail</h2>
|
|
<div class="location">/Doctrine/ORM/Mapping/ClassMetadataFactory.php at line 97</div>
|
|
<h3 id="getAllMetadata()">getAllMetadata</h3>
|
|
<code class="signature">public array <strong>getAllMetadata</strong>()</code>
|
|
<div class="details">
|
|
<p>Forces the factory to load the metadata of all classes known to the underlying
|
|
mapping driver.</p><dl>
|
|
<dt>Returns:</dt>
|
|
<dd>The ClassMetadata instances of all mapped classes.</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/ORM/Mapping/ClassMetadataFactory.php at line 81</div>
|
|
<h3 id="getCacheDriver()">getCacheDriver</h3>
|
|
<code class="signature">public Doctrine\Common\Cache\Cache <strong>getCacheDriver</strong>()</code>
|
|
<div class="details">
|
|
<p>Gets the cache driver used by the factory to cache ClassMetadata instances.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/ORM/Mapping/ClassMetadataFactory.php at line 86</div>
|
|
<h3 id="getLoadedMetadata()">getLoadedMetadata</h3>
|
|
<code class="signature">public void <strong>getLoadedMetadata</strong>()</code>
|
|
<div class="details">
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/ORM/Mapping/ClassMetadataFactory.php at line 129</div>
|
|
<h3 id="getMetadataFor()">getMetadataFor</h3>
|
|
<code class="signature">public Doctrine\ORM\Mapping\ClassMetadata <strong>getMetadataFor</strong>(string className)</code>
|
|
<div class="details">
|
|
<p>Gets the class metadata descriptor for a class.</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>className - The name of the class.</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/ORM/Mapping/ClassMetadataFactory.php at line 176</div>
|
|
<h3 id="hasMetadataFor()">hasMetadataFor</h3>
|
|
<code class="signature">public boolean <strong>hasMetadataFor</strong>(string className)</code>
|
|
<div class="details">
|
|
<p>Checks whether the factory has the metadata for a class loaded already.</p><dl>
|
|
<dt>Returns:</dt>
|
|
<dd>TRUE if the metadata of the class in question is already loaded, FALSE otherwise.</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/ORM/Mapping/ClassMetadataFactory.php at line 71</div>
|
|
<h3 id="setCacheDriver()">setCacheDriver</h3>
|
|
<code class="signature">public void <strong>setCacheDriver</strong>(Doctrine\Common\Cache\Cache cacheDriver)</code>
|
|
<div class="details">
|
|
<p>Sets the cache driver used by the factory to cache ClassMetadata instances.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/ORM/Mapping/ClassMetadataFactory.php at line 189</div>
|
|
<h3 id="setMetadataFor()">setMetadataFor</h3>
|
|
<code class="signature">public void <strong>setMetadataFor</strong>(string className, <a href="../../../doctrine/orm/mapping/classmetadata.html">ClassMetadata</a> class)</code>
|
|
<div class="details">
|
|
<p>Sets the metadata descriptor for a specific class.</p><p>NOTE: This is only useful in very special cases, like when generating proxy classes.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="header">
|
|
<h1>Doctrine</h1>
|
|
<ul>
|
|
<li><a href="../../../overview-summary.html">Overview</a></li>
|
|
<li><a href="../../../doctrine/orm/mapping/package-summary.html">Namespace</a></li>
|
|
<li class="active">Class</li>
|
|
<li><a href="../../../doctrine/orm/mapping/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/classmetadatafactory.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> |