File: Yaf_Action_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 (130 lines) | stat: -rw-r--r-- 5,362 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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="Yaf_Action_Abstract" namespace="" name="Yaf_Action_Abstract">
  <extends name="Yaf_Controller_Abstract" full="Yaf_Controller_Abstract"/>
  <member name="_controller" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact=""/>
    </docblock>
  </member>
  <method name="execute" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Action entry point">user should always define this method for a action, this is the entry point of an action. Yaf_Action_Abstract::execute may have agruments. The value retrived from the request is not safe. you should do some filtering work before you use it.</description>
      <return type="mixed"/>
    </docblock>
    <parameter name="arg" optional="true" byreference="false" type="object" class="mixed"/>
    <parameter name="..." optional="true" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="getController" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Retrieve controller object"/>
      <return type="Yaf_Controller_Abstract"/>
    </docblock>
  </method>
  <method name="__clone" abstract="false" static="false" final="true">
    <docblock>
      <description compact=""/>
      <return type="void"/>
    </docblock>
  </method>
  <constructor name="__construct" abstract="false" static="false" final="true">
    <docblock>
      <description compact=""/>
      <return type="void"/>
    </docblock>
  </constructor>
  <method name="display" abstract="false" static="false" visibility="protected" final="false">
    <docblock>
      <description compact=""/>
      <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=""/>
      <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=""/>
      <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=""/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="getModuleName" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getRequest" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="Yaf_Request_Abstract"/>
    </docblock>
  </method>
  <method name="getResponse" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="Yaf_Response_Abstract"/>
    </docblock>
  </method>
  <method name="getView" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="Yaf_View_Interface"/>
    </docblock>
  </method>
  <method name="getViewpath" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="init" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="initView" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <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=""/>
      <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=""/>
      <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=""/>
      <return type="void"/>
    </docblock>
    <parameter name="view_directory" optional="false" byreference="false" type="string"/>
  </method>
</class>