The Yaf_Controller_Abstract class

(Yaf >=1.0.0)

Introduction

Yaf_Controller_Abstract is the heart of Yaf's system. MVC stands for Model-View-Controller and is a design pattern targeted at separating application logic from display logic.

Every custom controller shall inherit Yaf_Controller_Abstract.

Since Yaf_Controller_Abstract::__construct() is called by Yaf with no arguments, Yaf_Controller_Abstract provides an alternative constructor-like hook: Yaf_Controller_Abstract::init().

If you have defined a init() method in your custom controller, it will be called as long as the controller was instantiated.

Action may have arguments, when a request coming, if there are the same name variable in the request parameters(see Yaf_Request_Abstract::getParam()) after routed, Yaf will pass them to the action method (see Yaf_Action_Abstract::execute()).

Note:
These arguments are directly fetched without filtering, it should be carefully processed before use them.

Class synopsis

abstract class Yaf_Controller_Abstract {

/* Properties */

protected $actions;

protected $_module;

protected $_name;

protected $_request;

protected $_response;

protected $_invoke_args;

protected $_view;

/* Methods */

public function __construct()

protected function display(string $tpl, ?array $parameters = ?): ?bool

public function forward(string $action, ?array $parameters = ?): ?bool

public function getInvokeArg(string $name): ?string

public function getInvokeArgs(): ?array

public function getModuleName(): ?string

public function getName(): ?string

public function getRequest(): ?Yaf_Request_Abstract

public function getResponse(): ?Yaf_Response_Abstract

public function getView(): ?Yaf_View_Interface

public function getViewpath(): ?string

public function init(): void

public function initView(?array $options = ?): ?Yaf_View_Interface

public function redirect(string $url): ?bool

protected function render(string $tpl, ?array $parameters = ?): string|bool|null

public function setViewpath(string $view_directory): ?bool

}

Properties

actions

You can also define an action method in a separate PHP script by using this property and Yaf_Action_Abstract.

Example #1 define action in a separate file

<?php
class IndexController extends Yaf_Controller_Abstract {
    protected $actions = array(
        /** now dummyAction is defined in a separate file */
        "dummy" => "actions/Dummy_action.php",
    );

    /* action method may have arguments */
    public function indexAction($name, $id) {
       /* $name and $id are unsafe raw data */
       assert($name == $this->getRequest()->getParam("name"));
       assert($id   == $this->_request->getParam("id"));
    }
}
?>

Example #2 Dummy_action.php

<?php
class DummyAction extends Yaf_Action_Abstract {
    /* an action class shall define this method as the entry point */
    public function execute() {
    }
}
?>

_module

The name of the module the controller belongs to.

_name

The name of the controller.

_request

The current Yaf_Request_Abstract object.

_response

The current Yaf_Response_Abstract object.

_invoke_args

The invocation arguments passed to the action through Yaf_Controller_Abstract::forward(), as an array keyed by argument name.

_view

The Yaf_View_Interface object used to render views.

Yaf_Controller_Abstract::__construct — Constructor of Yaf_Controller_Abstract
Yaf_Controller_Abstract::display — Render and display a view
Yaf_Controller_Abstract::forward — Forward the current request to another action
Yaf_Controller_Abstract::getInvokeArg — Retrieve one action invocation argument
Yaf_Controller_Abstract::getInvokeArgs — Retrieve all action invocation arguments
Yaf_Controller_Abstract::getModuleName — Get module name
Yaf_Controller_Abstract::getName — Get controller name
Yaf_Controller_Abstract::getRequest — Retrieve current request object
Yaf_Controller_Abstract::getResponse — Retrieve current response object
Yaf_Controller_Abstract::getView — Retrieve the view engine
Yaf_Controller_Abstract::getViewpath — Get the view path
Yaf_Controller_Abstract::init — Controller initializer
Yaf_Controller_Abstract::initView — Initialize the view and return it
Yaf_Controller_Abstract::redirect — Redirect to a URL
Yaf_Controller_Abstract::render — Render view template
Yaf_Controller_Abstract::setViewpath — Set the view path

The Yaf_Controller_Abstract class

Introduction

Class synopsis

Properties

Table of Contents