Zend Framework 0.8 | Zend Framework Migration Notes Programmer's Reference Guide | Zend Framework Coding Standard for PHP

# Zend Framework 0.6

When upgrading from a previous release to Zend Framework 0.6 or higher you should note the following migration notes.

# Zend_Controller

The most basic usage of the MVC components has not changed; you can still do each of the following:

1. Zend_Controller_Front::run('/path/to/controllers');

1. /* -- create a router -- */
2. $router = new Zend_Controller_RewriteRouter();
3. $router->addRoute('user',
4. 'user/:username',
5. array('controller' => 'user', 'action' => 'info')
6. );
8. /* -- set it in a controller -- */
9. $ctrl = Zend_Controller_Front::getInstance();
10. $ctrl->setRouter($router);
12. /* -- set controller directory and dispatch -- */
13. $ctrl->setControllerDirectory('/path/to/controllers');
14. $ctrl->dispatch();

We encourage use of the Response object to aggregate content and headers. This will allow for more flexible output format switching (for instance, JSON or XML instead of XHTML) in your applications. By default, dispatch() will render the response, sending both headers and rendering any content. You may also have the front controller return the response using returnResponse(), and then render the response using your own logic. A future version of the front controller may enforce use of the response object via output buffering.

There are many additional features that extend the existing API, and these are noted in the documentation.

The main changes you will need to be aware of will be found when subclassing the various components. Key amongst these are:

- Zend_Controller_Front::dispatch() by default traps exceptions in the response object, and does not render them, in order to prevent sensitive system information from being rendered. You can override this in several ways:

  - Set throwExceptions() in the front controller:

    1. $front->throwExceptions(true);

  - Set renderExceptions() in the response object:

    1. $response->renderExceptions(true);
    2. $front->setResponse($response);
    3. $front->dispatch();
    5. // or:
    6. $front->returnResponse(true);
    7. $response = $front->dispatch();
    8. $response->renderExceptions(true);
    9. echo $response;

- Zend_Controller_Dispatcher_Interface::dispatch() now accepts and returns a The Request Object instead of a dispatcher token.

- Zend_Controller_Router_Interface::route() now accepts and returns a The Request Object instead of a dispatcher token.

- Zend_Controller_Action changes include:

  - The constructor now accepts exactly three arguments, Zend_Controller_Request_Abstract $request, Zend_Controller_Response_Abstract $response, and Array $params (optional). Zend_Controller_Action::__construct() uses these to set the request, response, and invokeArgs properties of the object, and if overriding the constructor, you should do so as well. Better yet, use the init() method to do any instance configuration, as this method is called as the final action of the constructor.

  - run() is no longer defined as final, but is also no longer used by the front controller; its sole purpose is for using the class as a page controller. It now takes two optional arguments, a Zend_Controller_Request_Abstract $request and a Zend_Controller_Response_Abstract $response.

  - indexAction() no longer needs to be defined, but is encouraged as the default action. This allows using the RewriteRouter and action controllers to specify different default action methods.

  - __call() should be overridden to handle any undefined actions automatically.

  - _redirect() now takes an optional second argument, the HTTP code to return with the redirect, and an optional third argument, $prependBase, that can indicate that the base URL registered with the request object should be prepended to the url specified.

  - The $_action property is no longer set. This property was a Zend_Controller_Dispatcher_Token, which no longer exists in the current incarnation. The sole purpose of the token was to provide information about the requested controller, action, and URL parameters. This information is now available in the request object, and can be accessed as follows:

    1. // Retrieve the requested controller name
    2. // Access used to be via: $this->_action->getControllerName().
    3. // The example below uses getRequest(), though you may also directly
    4. // access the $_request property; using getRequest() is recommended as
    5. // a parent class may override access to the request object.
    6. $controller = $this->getRequest()->getControllerName();
    8. // Retrieve the requested action name
    9. // Access used to be via: $this->_action->getActionName().
    10. $action = $this->getRequest()->getActionName();
    12. // Retrieve the request parameters
    13. // This hasn't changed; the _getParams() and _getParam() methods simply
    14. // proxy to the request object now.
    15. $params = $this->_getParams();
    16. // request 'foo' parameter, using 'default' as default value if not found
    17. $foo = $this->_getParam('foo', 'default');

  - noRouteAction() has been removed. The appropriate way to handle non-existent action methods should you wish to route them to a default action is using __call():

    1. public function __call($method, $args)
    2. {
    3. // If an unmatched 'Action' method was requested, pass on to the
    4. // default action method:
    5. if ('Action' == substr($method, -6)) {
    6. return $this->defaultAction();
    7. }
    9. throw new Zend_Controller_Exception('Invalid method called');
    10. }

- Zend_Controller_RewriteRouter::setRewriteBase() has been removed. Use Zend_Controller_Front::setBaseUrl() instead (or Zend_Controller_Request_Http::setBaseUrl(), if using that request class).

- Zend_Controller_Plugin_Interface was replaced by Zend_Controller_Plugin_Abstract. All methods now accept and return a The Request Object instead of a dispatcher token.

Zend Framework 0.8 | Zend Framework Migration Notes Programmer's Reference Guide | Zend Framework Coding Standard for PHP