<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.yaf-loader.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'yaf-loader.getinstance.php',
    1 => 'Yaf_Loader::getInstance',
    2 => 'Retrieve the Yaf_Loader instance',
  ),
  'up' => 
  array (
    0 => 'class.yaf-loader.php',
    1 => 'Yaf_Loader',
  ),
  'prev' => 
  array (
    0 => 'yaf-loader.construct.php',
    1 => 'Yaf_Loader::__construct',
  ),
  'next' => 
  array (
    0 => 'yaf-loader.getlibrarypath.php',
    1 => 'Yaf_Loader::getLibraryPath',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/yaf/yaf_loader/getinstance.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="yaf-loader.getinstance" class="refentry">
 <div class="refnamediv">
<h1 class="refname">Yaf_Loader::getInstance</h1>
<p class="verinfo">(Yaf &gt;=1.0.0)</p><p class="refpurpose"><span class="refname">Yaf_Loader::getInstance</span> &mdash; <span class="dc-title">Retrieve the Yaf_Loader instance</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-yaf-loader.getinstance-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public static</span> <span class="modifier">function</span> <span class="methodname"><strong>Yaf_Loader::getInstance</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$local_library_path</code><span class="initializer"> = null</span></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$global_library_path</code><span class="initializer"> = null</span></span>): <span class="type"><span class="type"><a href="class.yaf-loader.php" class="type Yaf_Loader">Yaf_Loader</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="simpara">Retrieve the singleton <span class="classname"><a href="class.yaf-loader.php" class="classname">Yaf_Loader</a></span> instance.</p>
  <p class="simpara">If the library paths are given, they are applied to the existing instance.</p>
 </div>


 <div class="refsect1 parameters" id="refsect1-yaf-loader.getinstance-parameters">
  <h3 class="title">Parameters</h3>
  <dl>
   
    <dt><code class="parameter">local_library_path</code></dt>
    <dd>
<p class="simpara">The local library directory, usually the same as the <code class="literal">application.library.directory</code> ini setting.</p>
    </dd>
   
   
    <dt><code class="parameter">global_library_path</code></dt>
    <dd>
<p class="simpara">The global library directory. If not given, the local one is used.</p>
    </dd>
   
  </dl>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-yaf-loader.getinstance-returnvalues">
  <h3 class="title">Return Values</h3>
<p class="simpara">The <span class="classname"><a href="class.yaf-loader.php" class="classname">Yaf_Loader</a></span> instance, or <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> if the loader has not been initialized (which is normally done by <span class="classname"><a href="class.yaf-application.php" class="classname">Yaf_Application</a></span>).</p>
 </div>


 <div class="refsect1 examples" id="refsect1-yaf-loader.getinstance-examples">
  <h3 class="title">Examples</h3>
  <div class="example" id="example-1">
   <p><strong>Example #1 <span class="methodname"><strong>Yaf_Loader::getInstance()</strong></span> example</strong></p>
   <div class="example-contents">
<div class="phpcode"><pre><code style="color: #000000"><span style="color: #0000BB">&lt;?php
$app </span><span style="color: #007700">= new </span><span style="color: #0000BB">Yaf_Application</span><span style="color: #007700">(</span><span style="color: #0000BB">__DIR__ </span><span style="color: #007700">. </span><span style="color: #DD0000">"/conf/application.ini"</span><span style="color: #007700">);

</span><span style="color: #FF8000">/* Yaf_Application has initialized the loader, so the
 * singleton instance is available now */
</span><span style="color: #0000BB">$loader </span><span style="color: #007700">= </span><span style="color: #0000BB">Yaf_Loader</span><span style="color: #007700">::</span><span style="color: #0000BB">getInstance</span><span style="color: #007700">();
</span><span style="color: #0000BB">$loader</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">registerNamespace</span><span style="color: #007700">(</span><span style="color: #DD0000">"Vendor"</span><span style="color: #007700">, </span><span style="color: #0000BB">APPLICATION_PATH </span><span style="color: #007700">. </span><span style="color: #DD0000">"/library/Vendor"</span><span style="color: #007700">);
</span><span style="color: #0000BB">?&gt;</span></code></pre></div>
   </div>

  </div>
  <div class="example" id="example-2">
   <p><strong>Example #2 <span class="methodname"><strong>Yaf_Loader::getInstance()</strong></span> before initialization</strong></p>
   <div class="example-contents">
<div class="phpcode"><pre><code style="color: #000000"><span style="color: #0000BB">&lt;?php
</span><span style="color: #FF8000">/* no Yaf_Application has been created yet */
</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">Yaf_Loader</span><span style="color: #007700">::</span><span style="color: #0000BB">getInstance</span><span style="color: #007700">());
</span><span style="color: #0000BB">?&gt;</span></code></pre></div>
   </div>

   <div class="example-contents"><p>The above example will output
something similar to:</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">bool(false)</pre>
</div>
   </div>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-yaf-loader.getinstance-seealso">
  <h3 class="title">See Also</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="yaf-loader.setlibrarypath.php" class="methodname" rel="rdfs-seeAlso">Yaf_Loader::setLibraryPath()</a> - Change the library path</span></li>
   <li><span class="methodname"><a href="yaf-loader.getlibrarypath.php" class="methodname" rel="rdfs-seeAlso">Yaf_Loader::getLibraryPath()</a> - Retrieve the library path</span></li>
  </ul>
 </div>

</div><?php manual_footer($setup); ?>