Search code examples
zend-frameworkmodulezend-controllerzend-autoloader

Zend Framework - Extend Module Controller


I have the following directory structure:

modules/
  api/
    controllers/
      ApiController.php
      InventoryController.php
      OtherController.php

The init() method is common amongst multiple Controllers so I want to refactor that into a parent Controller class such as:

class Api_ApiController extends Zend_Controller_Action
{
    public function init()
    {
        // common code
    }
}

When I try:

class Api_InventoryController extends Api_ApiController

I get:

Fatal error: Class 'Api_ApiController' not found in /application/modules/api/controllers/InventoryController.php on line 4

Why does Zend Framework not map Api_ApiController to modules/api/controllers/ApiController.php?

I have figure out a way around this by putting the ApiController in the library/ and registering the namespace but it seems like a hack to me.


Solution

  • The "problem" is, that ZF does not register the controllers directory in the autoloader as the controllers normally are loaded via the Zend_Controller_Dispatcher. The Zend_Application_Module_Autoloader, that's instantiated in the bootstrapper on the other hand only registers

            'dbtable' => array(
                'namespace' => 'Model_DbTable',
                'path'      => 'models/DbTable',
            ),
            'mappers' => array(
                'namespace' => 'Model_Mapper',
                'path'      => 'models/mappers',
            ),
            'form'    => array(
                'namespace' => 'Form',
                'path'      => 'forms',
            ),
            'model'   => array(
                'namespace' => 'Model',
                'path'      => 'models',
            ),
            'plugin'  => array(
                'namespace' => 'Plugin',
                'path'      => 'plugins',
            ),
            'service' => array(
                'namespace' => 'Service',
                'path'      => 'services',
            ),
            'viewhelper' => array(
                'namespace' => 'View_Helper',
                'path'      => 'views/helpers',
            ),
            'viewfilter' => array(
                'namespace' => 'View_Filter',
                'path'      => 'views/filters',
            )
    

    So either you include your base controller script with require_once or you modifiy your autoloader to also include the controller directories.