How can I access the configuration of a Zend Framework application from a controller?

Question

I have a Zend Framework application based on the quick-start setup.

I've gotten the demos working and am now at the point of instantiating a new model class to do some real work. In my controller I want to pass a configuration parameter (specified in the application.ini) to my model constructor, something like this:

class My_UserController extends Zend_Controller_Action { public function indexAction() { $options = $this->getFrontController()->getParam('bootstrap')->getApplication()->getOptions(); $manager = new My_Model_Manager($options['my']); $this->view->items = $manager->getItems(); } }

The example above does allow access to the options, but seems extremely round-about. Is there a better way to access the configuration?

Stefan Gehrig · Accepted Answer · 2009-11-05 15:24:29Z

48

I always add the following init-method to my bootstrap to pass the configuration into the registry.

protected function _initConfig() { $config = new Zend_Config($this->getOptions(), true); Zend_Registry::set('config', $config); return $config; }

This will shorten your code a little bit:

class My_UserController extends Zend_Controller_Action { public function indexAction() { $manager = new My_Model_Manager(Zend_Registry::get('config')->my); $this->view->items = $manager->getItems(); } }

answered Nov 5, 2009 at 15:24

Stefan Gehrig

83.9k24 gold badges162 silver badges193 bronze badges

Sign up to request clarification or add additional context in comments.

5 Comments

Alister Bulman Over a year ago

That will take a little work to re-parse the array into an object. If you prefer having the config as an array, it's just "Zend_Registry::set('config', $this->getOptions());" though you'll have to get it out into a variable before getting the value.

Stefan Gehrig Over a year ago

@Alister: You're right, the faster way would be to store the options-array inside the registry - but storing the array each time you'd like to retrieve a single value can be cumbersome.

Hendy Irawan Over a year ago

This is no different than the $GLOBALS['application'] idea below, with the added benefit that $GLOBALS['application'] works probably 99% of the time.

Hendy Irawan Over a year ago

On the other hand, Zend_Registry::get('config') requires the controller/module developer to coordinate with Bootstrap to get the config into registry.

Stefan Gehrig Over a year ago

Sure, a singleton is always some OOP-way of a global variable. Nevertheless the Registry pattern is a common and recognized way of distributing resources throughout an application. The use of Zend_Registry allows you to provide a custom object as its repository to extend its functionality into a service locator or dependency injection container. All those things are not possible with the GLOBALS approach. I don't see why the Zend_Registry approach should not work 100% of the time by the way.

yarson · Accepted Answer · 2011-01-25 09:55:00Z

Since version 1.8 you can use the below code in your Controller:

$my = $this->getInvokeArg('bootstrap')->getOption('my');

wimvds · Accepted Answer · 2009-11-17 08:43:16Z

Alternatively, instead of using Zend_Registry you could also create a singleton Application class that will contain all application info, with public member functions that allow you to access the relevant data. Below you can find a snippet with relevant code (it won't run as is, just to give you an idea how it can be implemented) :

final class Application { /** * @var Zend_Config */ private $config = null; /** * @var Application */ private static $application; // snip /** * @return Zend_Config */ public function getConfig() { if (!$this->config instanceof Zend_Config) { $this->initConfig(); } return $this->config; } /** * @return Application */ public static function getInstance() { if (self::$application === null) { self::$application = new Application(); } return self::$application; } /** * Load Configuration */ private function initConfig() { $configFile = $this->appDir . '/config/application.xml'; if (!is_readable($configFile)) { throw new Application_Exception('Config file "' . $configFile . '" is not readable'); } $config = new Zend_Config_Xml($configFile, 'test'); $this->config = $config; } // snip /** * @param string $appDir */ public function init($appDir) { $this->appDir = $appDir; $this->initConfig(); // snip } public function run ($appDir) { $this->init($appDir); $front = $this->initController(); $front->dispatch(); } }

Your bootstrap would look like this :

require 'Application.php'; try { Application::getInstance()->run(dirname(dirname(__FILE__))); } catch (Exception $e) { header("HTTP/1.x 500 Internal Server Error"); trigger_error('Application Error : '.$e->getMessage(), E_USER_ERROR); }

When you want to access the configuration you would use the following :

$var = Application::getInstance()->getConfig()->somevar;

sra · Accepted Answer · 2012-03-31 07:48:31Z

3

In most ZF apps, the application object is declared in the global scope (see public/index.php in apps created with ZFW_DISTRIBUTION/bin/zf.sh).

It's not exactly the ZF way, but you can access the object with $GLOBALS['application']. It kinda feels like cheating, but if you're after performance, this will likely be the quickest option.

$manager = new My_Model_Manager($GLOBALS['application']->getOption('my'));

edited Mar 31, 2012 at 7:48

sra

24k8 gold badges59 silver badges89 bronze badges

answered Apr 20, 2010 at 22:45

Chris Trahey

18.3k1 gold badge44 silver badges55 bronze badges

3 Comments

Seth Battin Over a year ago

It's always possible to circumvent the framework and all its abstractions. A solution like this should be a all-else-fails hack, not a go-to solution. Performance is unlikely to be critical in any case; a config variable need not be fetched inside a performance-critical loop.

zardilior Over a year ago

What's the My_Model_Manager??

Chris Trahey Over a year ago

@zardilior my best guess (4 years on) is that it is a hypothetical user-land class that depends on a hypothetical user-defined option 'my'. Both of these are gleened from the SO question ;-)

bstpierre · Accepted Answer · 2011-04-25 18:00:16Z

1

$this->getInvokeArg('bootstrap')->getOptions(); // or $configDb = $this->getInvokeArg('bootstrap')->getOption('db');

edited Apr 25, 2011 at 18:00

bstpierre

31.5k16 gold badges74 silver badges105 bronze badges

answered Apr 25, 2011 at 14:21

SLIM

111 bronze badge

Comments

XUE Can · Accepted Answer · 2010-02-06 16:38:34Z

I've define a short hand in some place I require_once() in the beginning of boostrap:

function reg($name, $value=null) { (null===$value) || Zend_Registry::set($name, $value); return Zend_Registry::get($name); }

and in the bootstrap I have a:

protected function _initFinal() { reg('::app', $this->getApplication()); }

then I can get the Application instance anywhere by use:

$app = reg('::app');

Milan · Accepted Answer · 2017-10-19 15:44:55Z

A really simple way to access the configuration options is by directly accessing the globally defined $application variable.

class My_UserController extends Zend_Controller_Action { public function indexAction() { global $application; $options = $application->getOptions(); } }

Collectives™ on Stack Overflow

How can I access the configuration of a Zend Framework application from a controller?

7 Answers 7

5 Comments

Comments

Comments

3 Comments

Comments

Comments

Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

7 Answers 7

5 Comments

Comments

Comments

3 Comments

Comments

Comments

Comments

Linked

Related