registerlocalnamespace.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 32040dd7e5d98c136502134110681f80443dd000 Maintainer: sergey Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="yaf-loader.registerlocalnamespace" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>Yaf_Loader::registerLocalNamespace</refname>
  <refpurpose>Регистрирует префикс локального класса</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>void</type><methodname>Yaf_Loader::registerLocalNamespace</methodname>
   <methodparam><type>mixed</type><parameter>prefix</parameter></methodparam>
  </methodsynopsis>
  <para>
   Регистрирует префикс локального класса, <classname>Yaf_Loader</classname> ищет
   классы в двух каталогах библиотеки, один из которых настраивается с помощью <link
   linkend="configuration.yaf.library">application.library.directory</link> (в
   application.ini) который называется локальным каталогом библиотек; другой
   настраивается с помощью <link linkend="ini.yaf.library">yaf.library</link> (в
   php.ini), который называется глобальным каталогом библиотеки, так как он может использоваться
   многими приложениями на одном сервере.
  </para>
  <para>
   Когда запускается автозагрузка, <classname>Yaf_Loader</classname> будет
   определять, в каком каталоге библиотеки следует искать, следует искать, проверяя имя префикса
   пропущенного имени класса.

   Если имя префикса зарегистрировано как localnamespack, будет искать в каталоге
   локальной библиотеки, в противном случае — в каталоге глобальной библиотеки.
   <note>
    <para>
     Если yaf.library не настроен, то предполагается, что каталог глобальной библиотеки
     является каталогом локальной библиотеки. В этом случае все автозагрузки
     будут искать каталог локальной библиотеки.

     Но если вы хотите, чтобы ваше приложение Yaf было устойчивым, всегда регистрируйте свои
     собственные классы как локальные.
    </para>
   </note>
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>prefix</parameter></term>
    <listitem>
     <para>
      Строка или массив префиксов имени класса.
      Все префиксы класса с этим префиксом будут загружены в путь локальной библиотеки.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Логический тип (bool)
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Пример использования <function>Yaf_Loader::registerLocalNamespace</function></title>
   <programlisting role="php">
<![CDATA[
<?php
$loader = Yaf_Loader::getInstance('/local/library/', '/global/library');
$loader->registerLocalNamespace("Baidu");
$loader->registerLocalNamespace(array("Sina", "Weibo"));

$loader->autoload("Baidu_Name"); // будет искать в '/local/library/'
$loader->autoload("Sina");       // будет искать в '/local/library/'
$loader->autoload("Global_Name");// будет искать в '/global/library/'
$loader->autoload("Foo_Bar");    // будет искать в '/global/library/'

?>
]]>
   </programlisting>
  </example>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->