File: Yaf_Controller_Abstract.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (151 lines) | stat: -rw-r--r-- 6,834 bytes parent folder | download | duplicates (2)
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="Yaf_Controller_Abstract" namespace="" name="Yaf_Controller_Abstract">
  <member name="actions" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="You can also define a action method in a separate PHP script by using this property and Yaf_Action_Abstract. define action in a separate file &lt;?php class IndexController extends Yaf_Controller_Abstract { protected $actions = array( /** now dummyAction is defined in a separate file */ &quot;dummy&quot; =&gt; &quot;actions/Dummy_action.php&quot;, ); /* action method may have arguments */ public indexAction($name, $id) { /* $name and $id are unsafe raw data */ assert($name == $this-&gt;getRequest()-&gt;getParam(&quot;name&quot;)); assert($id == $this-&gt;_request-&gt;getParam(&quot;id&quot;)); } } ?&gt; Dummy_action.php &lt;?php class DummyAction extends Yaf_Action_Abstract { /* a action class shall define this method as the entry point */ public execute() { } } ?&gt;"/>
    </docblock>
  </member>
  <member name="_module" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact="module name"/>
    </docblock>
  </member>
  <member name="_name" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact="controller name"/>
    </docblock>
  </member>
  <member name="_request" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact="current request object"/>
    </docblock>
  </member>
  <member name="_response" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact="current response object"/>
    </docblock>
  </member>
  <member name="_invoke_args" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact=""/>
    </docblock>
  </member>
  <member name="_view" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact="view engine object"/>
    </docblock>
  </member>
  <method name="__clone" abstract="false" static="false" final="true">
    <docblock>
      <description compact="Yaf_Controller_Abstract can not be cloned"/>
      <return type="void"/>
    </docblock>
  </method>
  <constructor name="__construct" abstract="false" static="false" final="true">
    <docblock>
      <description compact="Yaf_Controller_Abstract constructor"/>
      <return type="void"/>
    </docblock>
  </constructor>
  <method name="display" abstract="false" static="false" visibility="protected" final="false">
    <docblock>
      <description compact="The display purpose"/>
      <return type="bool"/>
    </docblock>
    <parameter name="tpl" optional="false" byreference="false" type="string"/>
    <parameter name="parameters" optional="true" byreference="false" type="object" class="array"/>
  </method>
  <method name="forward" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Foward to another action">forward current execution process to other action. this method doesn't switch to the destination action immediately, it will take place after current flow finish.</description>
      <return type="void"/>
    </docblock>
    <parameter name="action" optional="false" byreference="false" type="string"/>
    <parameter name="paramters" optional="true" byreference="false" type="object" class="array"/>
  </method>
  <method name="getInvokeArg" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="The getInvokeArg purpose"/>
      <return type="void"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
  </method>
  <method name="getInvokeArgs" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="The getInvokeArgs purpose"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="getModuleName" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get module name"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getRequest" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Retrieve current request object"/>
      <return type="Yaf_Request_Abstract"/>
    </docblock>
  </method>
  <method name="getResponse" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Retrieve current response object"/>
      <return type="Yaf_Response_Abstract"/>
    </docblock>
  </method>
  <method name="getView" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Retrieve the view engine"/>
      <return type="Yaf_View_Interface"/>
    </docblock>
  </method>
  <method name="getViewpath" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="The getViewpath purpose"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="init" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Controller initializer"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="initView" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="The initView purpose"/>
      <return type="void"/>
    </docblock>
    <parameter name="options" optional="true" byreference="false" type="object" class="array"/>
  </method>
  <method name="redirect" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Redirect to a URL"/>
      <return type="bool"/>
    </docblock>
    <parameter name="url" optional="false" byreference="false" type="string"/>
  </method>
  <method name="render" abstract="false" static="false" visibility="protected" final="false">
    <docblock>
      <description compact="Render view template"/>
      <return type="string"/>
    </docblock>
    <parameter name="tpl" optional="false" byreference="false" type="string"/>
    <parameter name="parameters" optional="true" byreference="false" type="object" class="array"/>
  </method>
  <method name="setViewpath" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="The setViewpath purpose"/>
      <return type="void"/>
    </docblock>
    <parameter name="view_directory" optional="false" byreference="false" type="string"/>
  </method>
</class>