How to use Zend Auth to make values globally available in each action & layout.phtml

Question

I have implemented Zend Auth by creating a getServiceConfig()-like AuthenticationService Object in Module.php:

'AuthService' => function($sm) {
                    $dbAdapter = $sm->get('Zend\Db\Adapter\Adapter');
                    $dbTableAuthAdapter = new DbTableAuthAdapter($dbAdapter, 'tblUSRUsers', 'Email', 'Password', "MD5(?)");

                    $authService = new AuthenticationService();
                    $authService->setAdapter($dbTableAuthAdapter);
                    $authService->setStorage($sm->get('Application\Model\MyAuthStorage'));

                    return $authService;
                },

In the controller action, I am getting this object by

$this->getServiceLocator()
                    ->get('AuthService');

For authentication I obtain the values using

$authservice    = $this->getServiceLocator()->get('AuthService');
$arrUserDetails = $authservice->getIdentity();

Its working fine, these values are available.

But the problem is that ServiceLocator is not available in the Controller constructor so can't write the above code there. Writing this code in each and every action doesn't seem to be a good practice. Could anyone help out with this?

Adrian · Answer 1 · 2013-09-26T17:44:33.600

There are a couple of ways to do it. You can overload the ControllerConfig method in the Module class so you can instantiate the controllers however you like. Or you can write a controller plugin that will handle the authentication & return the identity.

EDIT

Should have provided these links earlier, but didn't have much access from the phone ;).

To understand ControllerConfig take a look at this blog post. There's an explanation about half way down of the getControllerConfig method in the Module class. This is a method the Module Manager looks for when instantiating the Module classes which allows you to customize the instantiation of a Controller in that Module. Once you return the Controller class, the Controller Manager then injects the rest of the Controller dependencies (plugins, etc.)

Controller plugins are small classes that get injected to every controller and which can be invoked from an action to do some common bit of code. When you use $this->getServiceLocator() in a controller action, you're using a plugin.

I am not familiar with these. Could you please explain in detail? — Bhuvi, Sep 26 '13 at 10:34
See my edit. You might also want to look at https://github.com/ZF-Commons/ZfcUser and how they structure their Module class. — Adrian, Sep 26 '13 at 17:48

score 0 · Accepted Answer · edited Sep 26 '13 at 11:54

0

Possible solution would be to have a route event handler, where you set user credentials:

class Module
{
    public function onBootstrap(MvcEvent $e)
    {
        $eventManager = $e->getApplication()
            ->getEventManager ();

        $eventManager->attach (
            MvcEvent::EVENT_ROUTE,
            function  (MvcEvent $e)
            {
                $auth = $e->getApplication()
                          ->getServiceManager()
                          ->get('AuthService');

                $e->setParam('userinfo', $auth->getUserInfo());
                // update 
                $layout = $e->getViewModel();
                $layout->userinfo = $auth->getUserInfo();           
       });
    }

and then access then in the controller like this:

class IndexController extends AbstractActionController
{
    public function indexAction ()
    {
        $this->getEvent()->getParam('userinfo');

edited Sep 26 '13 at 11:54

mihaidoru

327
2
10

answered Sep 26 '13 at 10:36

akond

15,865
4
35
55

Suppose i have to pass Logged in user's name to layout.phtml. I want to set this information through constructor for Layout. But, $this->getEvent()->getParam('userinfo'); is also not available in constructor. So, forcing me to put it in each action. – Bhuvi Sep 26 '13 at 11:25
Thanks. I also want to redirect user to login page if unauthenticated. For it i am writing if(!$auth->hasIdentity()) { $controller = $e->getTarget(); return $controller->plugin('redirect')->toRoute('login'); } in onBootstrap function itself. But, it is showing "Fatal error: Call to undefined method Zend\Mvc\Application::redirect()" Could you please also specify how it can be achieved? – Bhuvi Sep 26 '13 at 12:22

How to use Zend Auth to make values globally available in each action & layout.phtml

2 Answers2

EDIT