<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/book.yaf.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'class.yaf-loader.php',
    1 => 'Yaf_Loader',
    2 => 'A classe Yaf_Loader',
  ),
  'up' => 
  array (
    0 => 'book.yaf.php',
    1 => 'Yaf',
  ),
  'prev' => 
  array (
    0 => 'yaf-view-simple.setscriptpath.php',
    1 => 'Yaf_View_Simple::setScriptPath',
  ),
  'next' => 
  array (
    0 => 'yaf-loader.autoload.php',
    1 => 'Yaf_Loader::autoload',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/yaf/yaf-loader.xml',
  ),
  'history' => 
  array (
  ),
  'extra_header_links' => 
  array (
    'rel' => 'alternate',
    'href' => '/manual/en/feeds/class.yaf-loader.atom',
    'type' => 'application/atom+xml',
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="class.yaf-loader" class="reference">

 <h1 class="title">A classe Yaf_Loader</h1>
 

 <div class="partintro"><p class="verinfo">(Yaf &gt;=1.0.0)</p>


  <div class="section" id="yaf-loader.intro">
   <h2 class="title">Introdução</h2>
   <p class="para">
    <span class="classname"><strong class="classname">Yaf_Loader</strong></span> introduz uma solução compreensiva de
    carregamento automático para o Yaf.
   </p>
   <p class="para">
    Na primeira vez que uma instância de <span class="classname"><a href="class.yaf-application.php" class="classname">Yaf_Application</a></span> for recuperada,
    <span class="classname"><strong class="classname">Yaf_Loader</strong></span> instanciará um singleton e se registrará com
    spl_autoload. Uma instância é recuperada usando <span class="methodname"><a href="yaf-loader.getinstance.php" class="methodname">Yaf_Loader::getInstance()</a></span>.
   </p>
   <p class="para">
    <span class="classname"><strong class="classname">Yaf_Loader</strong></span> tenta carregar uma classe em apenas uma tentativa.
    Se falhar, dependerá de <a href="yaf.configuration.php#ini.yaf.use-spl-autoload" class="link">yaf.use_spl_autoload</a>. Se esta
    configuração estiver ativada, <span class="methodname"><a href="yaf-loader.autoload.php" class="methodname">Yaf_Loader::autoload()</a></span> retornará
    <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>, dando assim a chance para outra função de carregamento automático. Se estiver desligada
    (por padrão), <span class="methodname"><a href="yaf-loader.autoload.php" class="methodname">Yaf_Loader::autoload()</a></span> retornará
    <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> e o mais importante é que um alerta será acionado
    (muito útil para descobrir por que uma classe não pôde ser carregada).
    <blockquote class="note"><p><strong class="note">Nota</strong>: 
     <p class="para">
      A configuração yaf.use_spl_autoload deve ser mantida desativada, a menos que haja alguma biblioteca
      com seu próprio mecanismo de carregamento automático e seja impossível reescrevê-lo.
     </p>
    </p></blockquote>
   </p>
   <p class="para">
    Por padrão, <span class="classname"><strong class="classname">Yaf_Loader</strong></span> assume que todas as bibliotecas (script
    definido por classe) são armazenadas no <a href="yaf.configuration.php#ini.yaf.library" class="link">diretório de
    biblioteca global</a>, que é definido no php.ini (yaf.library).
   </p>

   <p class="para">
    Se for desejado que o <span class="classname"><strong class="classname">Yaf_Loader</strong></span> pesquise algumas
    classes (bibliotecas) no <a href="class.yaf-loader.php#yaf-loader.props.library" class="link">diretório de classes
    local</a> (que é definido no application.ini e por padrão
    é <a href="yaf.appconfig.php#configuration.yaf.directory" class="link">application.directory</a> . &quot;/library&quot;),
    o prefixo da classe deve ser registrado usando
    <span class="methodname"><a href="yaf-loader.registerlocalnamespace.php" class="methodname">Yaf_Loader::registerLocalNameSpace()</a></span>.
   </p>

   <p class="para">
    Vejamos alguns exemplo (assumindo que APPLICATION_PATH seja <a href="yaf.appconfig.php#configuration.yaf.directory" class="link">application.directory</a>):
    <div class="example" id="example-1">
     <p><strong>Exemplo #1 Exemplo de configuração</strong></p>
      <div class="example-contents">
<div class="shellcode"><pre class="shellcode">// Assumindo a configuração a seguir no php.ini:
yaf.library = &quot;/global_dir&quot;

// Assumindo a configuração a seguir no application.ini
application.library = APPLICATION_PATH &quot;/library&quot;</pre>
</div>
     </div>

    </div>

    Supondo que o seguinte namespace local esteja registrado:
    <div class="example" id="example-2">
     <p><strong>Exemplo #2 Registrando namespace local</strong></p>
     <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">class </span><span style="color: #0000BB">Bootstrap </span><span style="color: #007700">extends </span><span style="color: #0000BB">Yaf_Bootstrap_Abstract </span><span style="color: #007700">{<br />     public function </span><span style="color: #0000BB">_initLoader</span><span style="color: #007700">(</span><span style="color: #0000BB">$dispatcher</span><span style="color: #007700">) {<br />          </span><span style="color: #0000BB">Yaf_Loader</span><span style="color: #007700">::</span><span style="color: #0000BB">getInstance</span><span style="color: #007700">()-&gt;</span><span style="color: #0000BB">registerLocalNameSpace</span><span style="color: #007700">(array(</span><span style="color: #DD0000">"Foo"</span><span style="color: #007700">, </span><span style="color: #DD0000">"Bar"</span><span style="color: #007700">));<br />     }<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
     </div>

    </div>

    A seguir, exemplos de carregamento automático:
    <div class="example" id="example-3">
     <p><strong>Exemplo #3 Exemplo de carregamento de classe</strong></p>
      <div class="example-contents">
<div class="shellcode"><pre class="shellcode">class Foo_Bar_Test =&gt;
  // APPLICATION_PATH/library/Foo/Bar/Test.php

class GLO_Name  =&gt;
  // /global_dir/Glo/Name.php

class BarNon_Test
  // /global_dir/Barnon/Test.php</pre>
</div>
      </div>

    </div>

   <div class="example" id="example-4">
    <p><strong>Exemplo #4 Exemplo de carregamento de classe de namespace</strong></p>
    <div class="example-contents">
<div class="shellcode"><pre class="shellcode">class \Foo\Bar\Dummy =&gt;
   // APPLICATION_PATH/library/Foo/Bar/Dummy.php

class \FooBar\Bar\Dummy =&gt;
   // /global_dir/FooBar/Bar/Dummy.php</pre>
</div>
    </div>

   </div>
  </p>

  <p class="para">
   Observe que todos os diretórios têm a primeira letra maiúscula. Eles podem ficar em letras
   minúsculas definindo <a href="yaf.configuration.php#ini.yaf.lowcase-path" class="link">yaf.lowcase_path</a> para &quot;On&quot; no php.ini.
  </p>

  <p class="para">
   <span class="classname"><strong class="classname">Yaf_Loader</strong></span> também é projetado para carregar as classes MVC,
   e a regra é:
   <div class="example" id="example-5">
    <p><strong>Exemplo #5 Exemplo de carregamento de classes MVC</strong></p>
    <div class="example-contents">
<div class="shellcode"><pre class="shellcode">Controller Classes =&gt;
// APPLICATION_PATH/controllers/

Model Classes =&gt;
// APPLICATION_PATH/models/

Plugin Classes =&gt;
// APPLICATION_PATH/plugins/</pre>
</div>
    </div>

   </div>

   Yaf identifica o sufixo de uma classe (isto é padrão, o sufixo
   pode ser alterado pela configuração <a href="yaf.configuration.php#ini.yaf.name-suffix" class="link">yaf.name_suffix</a>) para decidir se é
   uma classe MVC:
   <div class="example" id="example-6">
    <p><strong>Exemplo #6 Distinções de classes MVC</strong></p>
   <div class="example-contents">
<div class="shellcode"><pre class="shellcode">Controller Classes =&gt;
    // ***Controller

Model Classes =&gt;
    // ***Model

Plugin Classes =&gt;
    // ***Plugin</pre>
</div>
   </div>

  </div>

   Alguns exemplos:
   <div class="example" id="example-7">
    <p><strong>Exemplo #7 Exemplo de carregamento MVC</strong></p>
    <div class="example-contents">
<div class="shellcode"><pre class="shellcode">class IndexController
    // APPLICATION_PATH/controllers/Index.php

class DataModel =&gt;
   // APPLICATION_PATH/models/Data.php

class DummyPlugin =&gt;
  // APPLICATION_PATH/plugins/Dummy.php

class A_B_TestModel =&gt;
  // APPLICATION_PATH/models/A/B/Test.php</pre>
</div>
    </div>

  </div>

  <blockquote class="note"><p><strong class="note">Nota</strong>: 
   <p class="para">
    A partir do Yaf 2.1.18, é oferecido suporte ao carregamento automático de controladores para o lado do script do usuário
    (isto é, o carregamento automático é acionado pelo script PHP do usuário, por exemplo: acessar uma
    propriedade estática do controlador no Bootstrap ou em Plugins),
    mas o carregador automático apenas tenta localizar o script da classe do controlador sob o pasta
    padrão do módulo, que é &quot;APPLICATION_PATH/controllers/&quot;.
   </p>
  </p></blockquote>
   Além disso, o diretório será afetado por <a href="yaf.configuration.php#ini.yaf.lowcase-path" class="link">yaf.lowcase_path</a>.
  </p>
  </div>


  <div class="section" id="yaf-loader.synopsis">
   <h2 class="title">Resumo da classe</h2>


   <div class="classsynopsis">
    <span class="ooclass"><strong class="classname"></strong></span>


    <div class="classsynopsisinfo">
     <span class="ooclass">
      <span class="modifier">class</span> <strong class="classname">Yaf_Loader</strong>
     </span>
     {</div>

    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Propriedades */</div>
    <div class="fieldsynopsis">
     <span class="modifier">protected</span>
      <var class="varname"><a href="class.yaf-loader.php#yaf-loader.props.local-ns">$<var class="varname">_local_ns</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">protected</span>
      <var class="varname"><a href="class.yaf-loader.php#yaf-loader.props.library">$<var class="varname">_library</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">protected</span>
      <var class="varname"><a href="class.yaf-loader.php#yaf-loader.props.global-library">$<var class="varname">_global_library</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">static</span>
      <var class="varname"><a href="class.yaf-loader.php#yaf-loader.props.instance">$<var class="varname">_instance</var></a></var>;</div>



    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Métodos */</div>
    <div class="constructorsynopsis dc-description">
   <span class="modifier">private</span> <span class="methodname"><a href="yaf-loader.construct.php" class="methodname">__construct</a></span>()</div>

    <div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-loader.autoload.php" class="methodname">autoload</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-loader.clearlocalnamespace.php" class="methodname">clearLocalNamespace</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">static</span> <span class="methodname"><a href="yaf-loader.getinstance.php" class="methodname">getInstance</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-loader.getlibrarypath.php" class="methodname">getLibraryPath</a></span>(<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$is_global</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></span></span>): <span class="type"><a href="class.yaf-loader.php" class="type Yaf_Loader">Yaf_Loader</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-loader.getnamespaces.php" class="methodname">getLocalNamespace</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-loader.getnamespacepath.php" class="methodname">getNamespacePath</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$namespaces</code></span>): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><strong>getNamespaces</strong></span>(): <span class="type"><a href="language.types.array.php" class="type array">array</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">static</span> <span class="methodname"><a href="yaf-loader.import.php" class="methodname">import</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-loader.islocalname.php" class="methodname">isLocalName</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-loader.registerlocalnamespace.php" class="methodname">registerLocalNamespace</a></span>(<span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$prefix</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-loader.registernamespace.php" class="methodname">registerNamespace</a></span>(<span class="methodparam"><span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.array.php" class="type array">array</a></span></span> <code class="parameter">$namespaces</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$path</code><span class="initializer"> = ?</span></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-loader.setlibrarypath.php" class="methodname">setLibraryPath</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$directory</code></span>, <span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$is_global</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></span></span>): <span class="type"><a href="class.yaf-loader.php" class="type Yaf_Loader">Yaf_Loader</a></span></div>

   }</div>


  </div>



  <div class="section" id="yaf-loader.props">
   <h2 class="title">Propriedades</h2>
   <dl>
    
     <dt id="yaf-loader.props.local-ns"><var class="varname">_local_ns</var></dt>
     <dd>
      <p class="para"/>
     </dd>
    
    
     <dt id="yaf-loader.props.library"><var class="varname">_library</var></dt>
     <dd>
      <p class="para">
       Por padrão, este valor é <a href="yaf.appconfig.php#configuration.yaf.directory" class="link">application.directory</a> . &quot;/library&quot;.
       Ele pode ser alterado no application.ini (application.library) ou com uma chamada a
      <span class="methodname"><a href="yaf-loader.setlibrarypath.php" class="methodname">Yaf_Loader::setLibraryPath()</a></span>
      </p>
     </dd>
    
    
     <dt id="yaf-loader.props.global-library"><var class="varname">_global_library</var></dt>
     <dd>
      <p class="para"/>
     </dd>
    
    
     <dt id="yaf-loader.props.instance"><var class="varname">_instance</var></dt>
     <dd>
      <p class="para"/>
     </dd>
    
   </dl>
  </div>



 </div>


 



























































































<h2>Índice</h2><ul class="chunklist chunklist_reference"><li><a href="yaf-loader.autoload.php">Yaf_Loader::autoload</a> — autoload</li><li><a href="yaf-loader.clearlocalnamespace.php">Yaf_Loader::clearLocalNamespace</a> — clearLocalNamespace</li><li><a href="yaf-loader.construct.php">Yaf_Loader::__construct</a> — __construct</li><li><a href="yaf-loader.getinstance.php">Yaf_Loader::getInstance</a> — getInstance</li><li><a href="yaf-loader.getlibrarypath.php">Yaf_Loader::getLibraryPath</a> — Obtem o caminho da biblioteca</li><li><a href="yaf-loader.getlocalnamespace.php">Yaf_Loader::getLocalNamespace</a> — getLocalNamespace</li><li><a href="yaf-loader.getnamespacepath.php">Yaf_Loader::getNamespacePath</a> — Obt&eacute;m o caminho do namespace registrado</li><li><a href="yaf-loader.getnamespaces.php">Yaf_Loader::getLocalNamespace</a> — Obt&eacute;m informa&ccedil;&atilde;o de todos os namespaces registrados</li><li><a href="yaf-loader.import.php">Yaf_Loader::import</a> — import</li><li><a href="yaf-loader.islocalname.php">Yaf_Loader::isLocalName</a> — isLocalName</li><li><a href="yaf-loader.registerlocalnamespace.php">Yaf_Loader::registerLocalNamespace</a> — Registra prefixo de classe local</li><li><a href="yaf-loader.registernamespace.php">Yaf_Loader::registerNamespace</a> — Registra namespace com caminho de pesquisa</li><li><a href="yaf-loader.setlibrarypath.php">Yaf_Loader::setLibraryPath</a> — Altera o caminho da biblioteca</li></ul>
</div>
<?php manual_footer($setup); ?>