Yaf_Action_Abstract
abstract class Yaf_Action_Abstract extends Yaf_Controller_Abstract (View source)
A action can be defined in a separate file in Yaf(see Yaf_Controller_Abstract). that is a action method can also be a Yaf_Action_Abstract class.
Since there should be a entry point which can be called by Yaf (as of PHP 5.3, there is a new magic method __invoke, but Yaf is not only works with PHP 5.3+, Yaf choose another magic method execute), you must implement the abstract method Yaf_Action_Abstract::execute() in your custom action class.
Properties
| array | $actions | from Yaf_Controller_Abstract | |
| protected string | $_module | from Yaf_Controller_Abstract | |
| protected string | $_name | from Yaf_Controller_Abstract | |
| protected Yaf_Request_Abstract | $_request | from Yaf_Controller_Abstract | |
| protected Yaf_Response_Abstract | $_response | from Yaf_Controller_Abstract | |
| protected array | $_invoke_args | from Yaf_Controller_Abstract | |
| protected Yaf_View_Interface | $_view | from Yaf_Controller_Abstract | |
| protected Yaf_Controller_Abstract | $_controller |
Methods
No description
No description
forward current execution process to other action.
Note:
this method doesn't switch to the destination action immediately, it will take place after current flow finish.
Notice, there are 3 available method signatures:
Yaf_Controller_Abstract::forward ( string $module , string $controller , string $action [, array $parameters ] )
Yaf_Controller_Abstract::forward ( string $controller , string $action [, array $parameters ] )
Yaf_Controller_Abstract::forward ( string $action [, array $parameters ] )
Yaf_Controller_Abstract::__construct() is final, which means users can not override it. but users can define Yaf_Controller_Abstract::init(), which will be called after controller object is instantiated.
Yaf_Controller_Abstract::__construct() is final, which means it can not be overridden. You may want to see Yaf_Controller_Abstract::init() instead.
user should always define this method for a action, this is the entry point of an action. Yaf_Action_Abstract::execute() may have arguments.
Note:
The value retrieved from the request is not safe. you should do some filtering work before you use it.
retrieve current controller object.
No description
Details
protected string|null|bool
render(string $tpl, array|null $parameters = null)
No description
protected bool
display(string $tpl, array|null $parameters = null)
No description
Yaf_Request_Abstract
getRequest()
retrieve current request object
Yaf_Response_Abstract
getResponse()
retrieve current response object
string
getModuleName()
get the controller's module name
Yaf_View_Interface
getView()
retrieve view engine
string|null
getName()
No description
Yaf_Response_Abstract
initView(array|null $options = null)
deprecated
deprecated
No description
bool
setViewpath(string $view_directory)
No description
string
getViewpath()
No description
bool
forward(string $module, string $controller = null, string $action = null, array|null $parameters = null)
forward current execution process to other action.
Note:
this method doesn't switch to the destination action immediately, it will take place after current flow finish.
Notice, there are 3 available method signatures:
Yaf_Controller_Abstract::forward ( string $module , string $controller , string $action [, array $parameters ] )
Yaf_Controller_Abstract::forward ( string $controller , string $action [, array $parameters ] )
Yaf_Controller_Abstract::forward ( string $action [, array $parameters ] )
bool
redirect(string $url)
redirect to a URL by sending a 302 header
array
getInvokeArgs()
No description
mixed
getInvokeArg(string $name)
No description
void
init()
Yaf_Controller_Abstract::__construct() is final, which means users can not override it. but users can define Yaf_Controller_Abstract::init(), which will be called after controller object is instantiated.
__construct(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response, Yaf_View_Interface $view, array|null $args = null)
Yaf_Controller_Abstract::__construct() is final, which means it can not be overridden. You may want to see Yaf_Controller_Abstract::init() instead.
abstract mixed
execute(mixed ...$args)
user should always define this method for a action, this is the entry point of an action. Yaf_Action_Abstract::execute() may have arguments.
Note:
The value retrieved from the request is not safe. you should do some filtering work before you use it.
Yaf_Controller_Abstract
getController()
retrieve current controller object.
string
getControllerName()
No description