php-doc-en/reference/yaf/yaf-application.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<phpdoc:classref xml:id="class.yaf-application" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>The Yaf_Application class</title>
 <titleabbrev>Yaf_Application</titleabbrev>
 <titleabbrev>Yaf\Application</titleabbrev>

 <partintro>

<!-- {{{ Yaf_Application intro -->
  <section xml:id="yaf-application.intro">
   &reftitle.intro;
   <para>
     <classname>Yaf_Application</classname> provides a bootstrapping facility 
     for applications which provides reusable resources, common- and 
     module-based bootstrap classes and dependency checking. 
   </para>
   <para>
    <note>
     <para>
       <classname>Yaf_Application</classname> implements the singleton
       pattern, and <classname>Yaf_Application</classname> can not be
       serialized or unserialized which will cause problem when you try 
       to use PHPUnit to write some test case for Yaf.
      </para>
      <para>
       You may use @backupGlobals annotation of PHPUnit to control the 
       backup and restore operations for global variables. thus can solve 
       this promblem.
     </para>
    </note>
   </para>
  </section>
<!-- }}} -->

  <section xml:id="yaf-application.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>Yaf_Application</classname></ooclass>

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <modifier>final</modifier>
      <classname>Yaf_Application</classname>
     </ooclass>
    </classsynopsisinfo>
<!-- }}} -->
    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>protected</modifier>
     <varname linkend="yaf-application.props.config">config</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>protected</modifier>
     <varname linkend="yaf-application.props.dispatcher">dispatcher</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>protected</modifier>
     <modifier>static</modifier>
     <varname linkend="yaf-application.props.app">_app</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>protected</modifier>
     <varname linkend="yaf-application.props.modules">_modules</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>protected</modifier>
     <varname linkend="yaf-application.props.running">_running</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>protected</modifier>
     <varname linkend="yaf-application.props.environ">_environ</varname>
    </fieldsynopsis>

    
    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.yaf-application')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
   </classsynopsis>
<!-- }}} -->

  </section>

  
<!-- {{{ Yaf_Application properties -->
  <section xml:id="yaf-application.props">
   &reftitle.properties;
   <variablelist>
    <varlistentry xml:id="yaf-application.props.config">
     <term><varname>config</varname></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="yaf-application.props.dispatcher">
     <term><varname>dispatcher</varname></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="yaf-application.props.app">
     <term><varname>_app</varname></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="yaf-application.props.modules">
     <term><varname>_modules</varname></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="yaf-application.props.running">
     <term><varname>_running</varname></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="yaf-application.props.environ">
     <term><varname>_environ</varname></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
<!-- }}} -->


 </partintro>

 &reference.yaf.entities.yaf-application;

</phpdoc:classref>

<!-- 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
-->