File: yaf-bootstrap-abstract.xml

package info (click to toggle)
php-doc 20140201-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 74,084 kB
  • ctags: 4,040
  • sloc: xml: 998,137; php: 20,812; cpp: 500; sh: 177; makefile: 63; awk: 28
file content (113 lines) | stat: -rw-r--r-- 2,958 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 327529 $ -->

<phpdoc:classref xml:id="class.yaf-bootstrap-abstract" 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_Bootstrap_Abstract class</title>
 <titleabbrev>Yaf_Bootstrap_Abstract</titleabbrev>

 <partintro>

<!-- {{{ Yaf_Bootstrap_Abstract intro -->
  <section xml:id="yaf-bootstrap-abstract.intro">
   &reftitle.intro;
   <para>
     Bootstrap is a mechanism used to do some intial config before a
     Application run.
   </para>
   <para>
     User may define their own Bootstrap class by inheriting
     <classname>Yaf_Bootstrap_Abstract</classname>
   </para>
   <para>
     Any method declared in Bootstrap class with leading "_init", will be
     called by <methodname>Yaf_Application::bootstrap</methodname> one by one 
     according to their defined order. 
   </para>
  </section>
<!-- }}} -->

 <section role="examples">
  &reftitle.examples;
  <example>
   <title>Bootstrap example</title>
   <programlisting role="php">
<![CDATA[
<?php
   /* bootstrap class should be defined under ./application/Bootstrap.php */
   class Bootstrap extends Yaf_Bootstrap_Abstract {
        public function _initConfig(Yaf_Dispatcher $dispatcher) {
            var_dump(__METHOD__);
        }
        public function _initPlugin(Yaf_Dispatcher $dispatcher) {
            var_dump(__METHOD__);
        }
   }

   $config = array(
       "application" => array(
           "directory" => dirname(__FILE__) . "/application/",
       ),
   );
 
   $app = new Yaf_Application($config);
   $app->bootstrap();
?>
]]>
   </programlisting>
   &example.outputs.similar;
   <screen>
<![CDATA[
string(22) "Bootstrap::_initConfig"
string(22) "Bootstrap::_initPlugin"
]]>
   </screen>
  </example>
 </section>

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

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

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <modifier>abstract</modifier>
      <classname>Yaf_Bootstrap_Abstract</classname>
     </ooclass>
    </classsynopsisinfo>
    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
    
    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
   </classsynopsis>
<!-- }}} -->

  </section>

 </partintro>

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