Check permissions in ZF2 Zend/Navigation with ZfcRbac

ZfcRbac is not tailored to work with Zend/Navigation. There aren’t any builded native solutions that gives ZfcRbac permission to enable or disable entry of menu. The solution for that problem is quite simple.

I found solution in this blog: http://blog.webdevilopers.net/check-zend-navigation-page-permissions-with-zfcrbac/. I based on it. But this solution caused a problem. Positions in menu are displayed only if perrmision is defined. If permission is not defined, menu’s posiotin is displayed.

I’ll show you how to implement checking perrmisions and enabled / disabled menu positions with ZfcRbac. There is only one change in RbacListener:

class RbacListener

{

  protected $authorizationService;

  public function __construct(AuthorizationServiceInterface $authorizationService)

  {

      $this->authorizationService = $authorizationService;

  }

  public function accept(EventInterface $event)

  {

      $page = $event->getParam('page');

      if (! $page instanceof AbstractPage) {

          return;

      }

      $permission = $page->getPermission();

      if (is_null($permission)) {

          $event->stopPropagation();

          return false;

      }

      $event->stopPropagation();

      return $this->authorizationService->isGranted($permission);

  }

}

Session expire under Zend Framework 2

Few days ago I met a problem with session expire under Zend Framework 2. I set gc_maxlifetime in SessionManager but my session didn’t expire. Ok, you’ll say that I can set session.gc_maxlifetime in php.ini. Yes, I can and it’s one of the solutions. But in my solution, I want to manage session lifetime in application configuration. I looked deeper in ZF2 session implementation to find the problem and solutions. This is what I found.

My configuration looks like this:
<?php
//…
'session' => [
        'config' => [
            'class' => 'Zend\Session\Config\SessionConfig',
            'options' => [
                'name' => 'session_name',
                'use_cookies' => true,
                'gc_maxlifetime' => 1800
            ]
        ],
        'storage' => 'Zend\Session\Storage\SessionArrayStorage'
    ],
//…

And my SessionManager factory:

<?php
//…
class SessionManagerFactory implements FactoryInterface
{

    public function createService(ServiceLocatorInterface $serviceLocator)
    {
        $config = $serviceLocator->get('config');

        if (isset($config['session'])) {
            $session = $config['session'];

            $sessionConfig = null;
            if (isset($session['config'])) {
                $class = isset($session['config']['class']) ? $session['config']['class'] : 'Zend\Session\Config\SessionConfig';
                $options = isset($session['config']['options']) ? $session['config']['options'] : array();
                $sessionConfig = new $class();
                $sessionConfig->setOptions($options);
            }

            $sessionStorage = null;
            if (isset($session['storage'])) {
                $class = $session['storage'];
                $sessionStorage = new $class();
            }

            $sessionSaveHandler = null;
            if (isset($session['save_handler'])) {
                will require constructor arguments
                $sessionSaveHandler = $serviceLocator->get($session['save_handler']);
            }

            $sessionManager = new SessionManager($sessionConfig, $sessionStorage, $sessionSaveHandler);
        } else {
            $sessionManager = new SessionManager();
        }

        return $sessionManager;
    }
}

Ok, next step, I created session Container:

$sessionManager = $serviceLocator->get('my_project\SessionManager');        $container = new Container(’container_name’, sessionManager);

And what happened after 30 minutes? Nothing. My session still existed.

Let’s go deeper.

After first request Container will be created. If we print $_SESSION we will see something like this:
…
__ZF =>
[’container_name’] =>
['EXPIRE'] => 1423757542
…

After 30 minutes $_SESSION looks like this:
__ZF =>
[’container_name’] => null


And finally, my implementation to check if session has expired looks like this:

//...
abstract class ContainerFactoryAbstract implements FactoryInterface
{

    private $containerName;

    private $config;

    private $sessionManager;

    public function createService(ServiceLocatorInterface $serviceLocator)
    {
        if (is_null($this->containerName)) {
            throw new RuntimeException('Is not set name of container!');
        }

        $this->config = $serviceLocator->get('Config');
        $this->sessionManager = $serviceLocator->get('SysSession\SessionManager');

        $container = $this->getContainer();

        if ($this->isSessionExpired($this->containerName)) {
            $this->sessionManager->destroy();
        }

        if ($this->getSessionMaxLifeTime()) {
            $container->setExpirationSeconds($this->getSessionMaxLifeTime());
        }

        return $container;
    }

    public function setContainerName($name)
    {
        $this->containerName = $name;
    }

    private function getContainer()
    {
        return new Container($this->containerName, $this->sessionManager);
    }

    private function isSetInitialSecureData(Container $container)
    {
        return isset($container->init);
    }

    private function isSessionExpired($containerName)
    {
        if (! $this->isSetSessionMaxLifeTime($this->config)) {
            return false;
        }

        return (isset($_SESSION['__ZF'][$containerName]) && (! $this->isSetExpireTimestamp($containerName)));
    }

    private function isSetSessionMaxLifeTime()
    {
        return isset($this->config['session']['config']['options']['gc_maxlifetime']);
    }

    private function getSessionMaxLifeTime()
    {
        if (! $this->isSetSessionMaxLifeTime()) {
            throw new RuntimeException('Is not set value for gc_maxlifetime session!');
        }

        return $this->config['session']['config']['options']['gc_maxlifetime'];
    }

    private function isSetExpireTimestamp($containerName)
    {
        return isset($_SESSION['__ZF'][$containerName]['EXPIRE']);
    }
}

Localizing Zend Framework 2 application with PoEdit

Zend Framework 2 provides Internationalisation (I18N) support. In this post I will give you instructions how to configure Zend Framework 2 to work with translation of your ZF2-Modules using PoEdit step-by-step. It may seem like yet-another Zend Framework 2 and PoEdit instruction. I’m writing it, because I haven’t found any complex instruction from the beginning to the end, how to start with Internationalisation and configuration of localizing in Zend Framework 2.

Configure localizing in Zend Framework 2

In your Application module_config.php add alias to MvcTranslator:

'service_manager' => [

    'aliases' => [

        'translator' => 'MvcTranslator'

    ]

],

This step is not required but it helps you to manage of “translator” configure section in every module. 

Next, add “translator” configure section in your module_config.php:

'translator' => [

    'locale' => 'en_GB',

    'translation_file_patterns' => [

        [

            'type' => 'gettext',

            'base_dir' => __DIR__ . '/../language',

            'pattern' => '%s.mo'

        ]

    ]

],

Do not forget to create “language” directory in module. Your module’s directories should look like this:

/- module

|-/ NAMESPACE

|-/ config

|-/ language

|-/ src

|-/ view

|- Module.php

^

Download and configure PoEdit

First of all, you must download PoEdit from project site and install it. Next, open PoEdit and go to menu: File > Preferences > Extractors tab. Find PHP on list and edit it. Be sure that you have *.phtml in List of extensions, if not, add it.

How to create language files

In this step I will show you how to create *.po files. 

Open PoEdit and go to menu: File > New. 

Select language which you want to translate, example: English (United Kingdom)

Then press OK. After that, save your en_GB.po file (press save) in your module’s “language” directory. Next, you have to set up special properties for en_GB.po - go to menu: Catalogue > Properties. 

In “Translation properties” set up name project:

Open “Source paths” tab and set “Paths” like this:

“/path/MyApp/modules/MyModule” is the path to module in your application which you want to translate.

In “Sources keywords” tab add: translate

This keyword (translate) tells PoEdit that it should find all expressions in your module: translate; PoEdit finds every call of translate helper in your module. 

Press “Update”.

Then, in the “Source text” PoEdit will find and show every text to translate.

Use translate in Controllers

To add keywords to translate in your Controllers you can simply use:

$this->getServiceLocator()->get('translator')->translate('Text to translate');

Of course, it’s possible to translate texts in module class by passing translator object to them, but it’s strongly discouraged. You shouldn’t mix application and business logic.

Recognize of language client

In the end, you would like to set up selected language and translation to a user automatically, when user is visiting website. In Module.php simply add this:

$translator = $e->getApplication()

                ->getServiceManager()

                ->get('translator');

$translator

    ->setLocale(

        \Locale::acceptFromHttp(

            $_SERVER['HTTP_ACCEPT_LANGUAGE']

        )

    )

    ->setFallbackLocale('en_GB');

$_SERVER['HTTP_ACCEPT_LANGUAGE'] - gets the accepted languages from a browser. Module will be translated if application has the same *.po file as language sent by a browser . If not, “en_GB” will be set as a default language in setFallbackLocale('en_GB') method.

To use \Locale be sure that you have the intl-extension running. You must have

extension=php_intl.dll

enabled in your php.ini file.

In Module.php you can set your own methods to set language. It could be automatically set up as I showed you above or you can implement your own policy. It depends on your own preferences and needs.