ZF2 – How do I get application config items within my model?

| | August 4, 2015

In my job I am dealing with a legacy app running on ZF2. There is a model which is sending out a variety of different emails to difference addresses. The one thing they have in common is they all need to BCC to one particular address.

At first, in my head I was cursing the previous developer, for foolishly hard coding the email address 20 different times in one file. I assumed that it would be a piece of cake to grab an application config with a simple call $this->config->get(‘x’) (like in Laravel) or something along them lines. Now I find myself feeling bad, because I understand why the previous dev did hard code the email addresses.

So to the question, how the hell do I grab a config item from application.config.php inside the model? I keep reading about how I need to implement the ServiceLocaterAware Interface. Is this really necessary? There must be a way to grab configs easily, surely?!?

2 Responses to “ZF2 – How do I get application config items within my model?”

  1. How the hell do I grab a config item from application.config.php inside the model?

    You shouldn’t do so inside, do it ‘outside‘.

    Register your model class as a service in module.config.php.

    'service_manager' => [
        'factories' => [
            'EmailModelEmailModel' => 'EmailModelEmailModelFactory',
        ]
    ],
    

    Then create the factory EmailModelEmailModelFactory, this uses the service manager to fetch the ’email’ config key and injects it into the model’s constructor.

    namespace EmailModel;
    
    use EmailModelEmailModel;
    use ZendServiceManagerServiceLocatorInterface;
    use ZendServiceManagerFactoryInterface;
    
    class EmailModelFactory implements FactoryInterface
    {
        public function createService(ServiceLocatorInterface $serviceLocator)
        {
            return new EmailModel($this->getEmailOptions($serviceLocator));
        }
    
        // Return the email options
        public function getEmailOptions(ServiceLocatorInterface $serviceLocator)
        {
            $options = $serviceLocator->get('config');
            return $options['email'];
        }
    }
    

    The issue you will now have is all calls to your model classes will have to use $serviceManager->get('EmailModelEmailModel') (rather than new EmailModelEmailModel) in order for the configuration to be injected. Even without seeing any of your legacy application my guess is that this would be difficult.

    The model should not be responsible for sending emails; you could replace it with an service class, e.g. ‘EmailService’ and repeat the injection example above just for this class.

    EmailService::send(EmailModel $email, array $options);
    

    This would keep your model independent and there would be no need to replace the calls to new Model etc.

  2. You need the service locator / service manager

    Within your controller:

    public function xxxAction()
    {
        $sm      = $this->getServiceLocator();
        $config  = $sm->get('config');
    }
    

Leave a Reply