Merge pull request #6 from MatthiasKuehneEllerhold/master

ZF3 Support, Short array syntax
jhuet · Jul 28, 2016 · 8a021b4 · 8a021b4
2 parents b0f20b4 + 4d339a8
commit 8a021b4
Show file tree

Hide file tree

Showing 12 changed files with 141 additions and 167 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+/composer.lock
+/vendor/
+/.idea/
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 JhuZdtLoggerModule
 ==================
 
-A ZF2 module to log data using [Zend\Log](http://framework.zend.com/manual/2.1/en/modules/zend.log.overview.html) and write them to [ZendDeveloperTools](https://github.com/zendframework/ZendDeveloperTools) toolbar. If you already have a logger in your application (that is an instance of `Zend\Log\Logger`) it will integrate well with it so you still will only have to use your logger.
+A ZF3 module to log data using [Zend\Log](http://framework.zend.com/manual/2.1/en/modules/zend.log.overview.html) and write them to [ZendDeveloperTools](https://github.com/zendframework/ZendDeveloperTools) toolbar. If you already have a logger in your application (that is an instance of `Zend\Log\Logger`) it will integrate well with it so you still will only have to use your logger.
 ___
 
 Installation

diff --git a/composer.json b/composer.json
@@ -1,20 +1,19 @@
 {
     "name":         "jhuet/zdt-logger-module",
-    "description":  "A ZF2 module to log data using Zend_Log and write them to ZendDeveloperTools toolbar.",
+    "description":  "A ZF3 module to log data using Zend\\Log and write them to ZendDeveloperTools toolbar.",
     "type":         "library",
     "license":      "MIT",
-    "keywords":     ["zf2", "log", "zdt", "module"],
+    "keywords":     ["zf3", "log", "zdt", "module"],
     "homepage":     "https://github.com/jhuet/JhuZdtLoggerModule",
     "authors":      [ {
         "name":     "Jérémy Huet",
         "email":    "jeremy.huet@gmail.com",
         "homepage": "https://github.com/jhuet/"
     } ],
-    "minimum-stability": "dev",
     "require":      {
-        "php": ">=5.3.3",
         "zendframework/zend-log":  "2.*",
-        "zendframework/zend-developer-tools": "dev-master"
+        "zendframework/zend-developer-tools": "^1.1.0",
+        "zendframework/zend-servicemanager": "3.*"
     },
     "require-dev": {
         "atoum/atoum": "dev-master"
@@ -24,4 +23,4 @@
             "Jhu\\ZdtLoggerModule\\": "src/"
         }
     }
-}
+}
diff --git a/config/jhu-zdt-logger.global.php.dist b/config/jhu-zdt-logger.global.php.dist
@@ -5,7 +5,7 @@
  * If you have a ./config/autoload/ directory set up for your project, you can
  * drop this config file in it and change the values as you wish.
  */
-$settings = array(
+$settings = [
     /**
      * The logger that will be used. This module will only add a writer to it
      * so if you already have a logger in your application, you can set it here.
@@ -14,13 +14,13 @@ $settings = array(
      * and be an instance or extend Zend\Log\Logger.
      */
     'logger' => 'Zend\Log\Logger'
-);
+];
 
 /**
  * You do not need to edit below this line
  */
-return array(
-    'jhu' => array(
+return [
+    'jhu' => [
         'zdt_logger' => $settings
-    )
-);
+    ]
+];
diff --git a/config/module.config.php b/config/module.config.php
@@ -1,29 +1,29 @@
 <?php
-return array(
-    'jhu' => array(
-        'zdt_logger' => array(
+return [
+    'jhu' => [
+        'zdt_logger' => [
             'logger' => 'Zend\Log\Logger'
-        ),
-    ),
+        ],
+    ],
 
     // zendframework/zend-developer-tools specific settings
 
-    'view_manager' => array(
-        'template_map' => array(
+    'view_manager' => [
+        'template_map' => [
             'zend-developer-tools/toolbar/jhu-zdt-logger' => __DIR__ . '/../view/zend-developer-tools/toolbar/jhu-zdt-logger.phtml',
-        ),
-    ),
+        ],
+    ],
 
-    'zenddevelopertools' => array(
-        'profiler' => array(
-            'collectors' => array(
+    'zenddevelopertools' => [
+        'profiler' => [
+            'collectors' => [
                 'jhu_zdt_logger' => 'Jhu\ZdtLoggerModule\Collector',
-            ),
-        ),
-        'toolbar' => array(
-            'entries' => array(
+            ],
+        ],
+        'toolbar' => [
+            'entries' => [
                 'jhu_zdt_logger' => 'zend-developer-tools/toolbar/jhu-zdt-logger',
-            ),
-        ),
-    ),
-);
+            ],
+        ],
+    ],
+];
diff --git a/src/Jhu/ZdtLoggerModule/Collector/ZendWriterCollector.php b/src/Jhu/ZdtLoggerModule/Collector/ZendWriterCollector.php
@@ -4,9 +4,7 @@
 
 use ZendDeveloperTools\Collector\CollectorInterface;
 use ZendDeveloperTools\Collector\AutoHideInterface;
-
 use Zend\Mvc\MvcEvent;
-
 use Jhu\ZdtLoggerModule\Writer\Stack as StackWriter;
 
 /**
@@ -24,7 +22,7 @@ class ZendWriterCollector implements CollectorInterface, AutoHideInterface
     const PRIORITY = 10;
 
     /**
-     * @var \Jhu\ZdtLoggerModule\Writer\Stack
+     * @var StackWriter
      */
     protected $zendWriter;
 
@@ -34,13 +32,13 @@ class ZendWriterCollector implements CollectorInterface, AutoHideInterface
     protected $name;
 
     /**
-     * @param Jhu\ZdtLoggerModule\Writer\Stack  $zendWriter
-     * @param string                            $name
+     * @param StackWriter  $zendWriter
+     * @param string       $name
      */
     public function __construct(StackWriter $zendWriter, $name)
     {
         $this->zendWriter = $zendWriter;
-        $this->name = (string) $name;
+        $this->name       = (string) $name;
     }
 
     /**

diff --git a/src/Jhu/ZdtLoggerModule/Module.php b/src/Jhu/ZdtLoggerModule/Module.php
@@ -43,7 +43,7 @@ public function init(ModuleManagerInterface $manager)
     public function onBootstrap(EventInterface $e)
     {
         $application = $e->getParam('application');
-        $config = $application->getServiceManager()->get('Config');
+        $config      = $application->getServiceManager()->get('Config');
 
         // If the default logger is different and ZDT's toolbar is activated,
         // we initialize ours to add our functionalities
@@ -60,16 +60,16 @@ public function onBootstrap(EventInterface $e)
      */
     public function getAutoloaderConfig()
     {
-        return array(
-            'Zend\Loader\ClassMapAutoloader' => array(
+        return [
+            'Zend\Loader\ClassMapAutoloader' => [
                 __DIR__ . '/../../../autoload_classmap.php',
-            ),
-            'Zend\Loader\StandardAutoloader' => array(
-                'namespaces' => array(
+            ],
+            'Zend\Loader\StandardAutoloader' => [
+                'namespaces' => [
                     __NAMESPACE__ => __DIR__ . '/../../../src/' . __NAMESPACE__,
-                ),
-            ),
-        );
+                ],
+            ],
+        ];
     }
 
     /**
@@ -85,21 +85,21 @@ public function getConfig()
      */
     public function getServiceConfig()
     {
-        return array(
-            'invokables' => array(
-                'Jhu\ZdtLoggerModule\Writer'    => 'Jhu\ZdtLoggerModule\Writer\Stack',
-                'Zend\Log\Logger'               => 'Zend\Log\Logger'
-            ),
+        return [
+            'invokables' => [
+                'Jhu\ZdtLoggerModule\Writer'    => Writer\Stack::class,
+                'Zend\Log\Logger'               => \Zend\Log\Logger::class,
+            ],
 
-            'factories' => array(
+            'factories' => [
                 'Jhu\ZdtLoggerModule\Logger'    => new ServiceFactory\LoggerFactory(),
                 'Jhu\ZdtLoggerModule\Collector' => new ServiceFactory\CollectorFactory(),
                 'Jhu\ZdtLoggerModule\Options'   => new ServiceFactory\ModuleOptionsFactory(),
-            ),
+            ],
 
-            'aliases' => array(
+            'aliases' => [
                 'jhu.zdt_logger' => 'Jhu\ZdtLoggerModule\Logger',
-            ),
-        );
+            ],
+        ];
     }
 }
diff --git a/src/Jhu/ZdtLoggerModule/ServiceFactory/CollectorFactory.php b/src/Jhu/ZdtLoggerModule/ServiceFactory/CollectorFactory.php
@@ -2,9 +2,10 @@
 
 namespace Jhu\ZdtLoggerModule\ServiceFactory;
 
+use Interop\Container\ContainerInterface;
 use Jhu\ZdtLoggerModule\Collector\ZendWriterCollector;
-use Zend\ServiceManager\ServiceLocatorInterface;
-use Zend\ServiceManager\FactoryInterface;
+use Jhu\ZdtLoggerModule\Writer\Stack as StackWriter;
+use Zend\ServiceManager\Factory\FactoryInterface;
 
 /**
  * Zdt Collector factory
@@ -22,10 +23,10 @@ class CollectorFactory implements FactoryInterface
      *
      * @return \Jhu\ZdtLoggerModule\Collector\ZendWriterCollector
      */
-    public function createService(ServiceLocatorInterface $serviceLocator)
+    public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
     {
-        /* @var $writer \Jhu\ZdtLogger\Writer\Zdt */
-        $writer = $serviceLocator->get('Jhu\ZdtLoggerModule\Writer');
+        $writer = $container->get('Jhu\ZdtLoggerModule\Writer');
+        /* @var $writer StackWriter */
 
         return new ZendWriterCollector($writer, 'jhu_zdt_logger');
     }

diff --git a/src/Jhu/ZdtLoggerModule/ServiceFactory/LoggerFactory.php b/src/Jhu/ZdtLoggerModule/ServiceFactory/LoggerFactory.php
@@ -2,9 +2,11 @@
 
 namespace Jhu\ZdtLoggerModule\ServiceFactory;
 
+use Interop\Container\ContainerInterface;
 use Zend\Log\Logger;
-use Zend\ServiceManager\FactoryInterface;
-use Zend\ServiceManager\ServiceLocatorInterface;
+use Zend\ServiceManager\Exception\ServiceNotCreatedException;
+use Zend\ServiceManager\Factory\FactoryInterface;
+use Jhu\ZdtLoggerModule\Writer\Stack as StackWriter;
 
 /**
  * Zdt Logger factory
@@ -20,22 +22,20 @@ class LoggerFactory implements FactoryInterface
     /**
      * {@inheritDoc}
      *
-     * @throws \InvalidArgumentException
-     *
-     * @return \Zend\Log\Logger
+     * @return Logger
      */
-    public function createService(ServiceLocatorInterface $serviceLocator)
+    public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
     {
-        $options = $serviceLocator->get('Jhu\ZdtLoggerModule\Options');
-        /* @var $logger \Zend\Log\Logger */
-        $logger = $serviceLocator->get($options->getLogger());
-
+        $options = $container->get('Jhu\ZdtLoggerModule\Options');
+        $logger  = $container->get($options->getLogger());
         if (! $logger instanceof Logger) {
-            throw new \InvalidArgumentException('`logger` option of JhuZdtLoggerModule has to be an instance or extend Zend\Log\Logger class.');
+            throw new ServiceNotCreatedException(
+                '`logger` option of JhuZdtLoggerModule has to be an instance or extend Zend\Log\Logger class.'
+            );
         }
 
-        /* @var $writer \Jhu\ZdtLogger\Writer\Zdt */
-        $writer = $serviceLocator->get('Jhu\ZdtLoggerModule\Writer');
+        $writer = $container->get('Jhu\ZdtLoggerModule\Writer');
+        /* @var $writer StackWriter */
 
         $logger->addWriter($writer);
 

diff --git a/src/Jhu/ZdtLoggerModule/ServiceFactory/ModuleOptionsFactory.php b/src/Jhu/ZdtLoggerModule/ServiceFactory/ModuleOptionsFactory.php
@@ -2,9 +2,9 @@
 
 namespace Jhu\ZdtLoggerModule\ServiceFactory;
 
+use Interop\Container\ContainerInterface;
 use Jhu\ZdtLoggerModule\Options;
-use Zend\ServiceManager\FactoryInterface;
-use Zend\ServiceManager\ServiceLocatorInterface;
+use Zend\ServiceManager\Factory\FactoryInterface;
 
 /**
  * @since   0.1
@@ -18,12 +18,12 @@ class ModuleOptionsFactory implements FactoryInterface
     /**
      * {@inheritDoc}
      *
-     * @return \Jhu\ZdtLoggerModule\Options\ModuleOptions
+     * @return Options\ModuleOptions
      */
-    public function createService(ServiceLocatorInterface $services)
+    public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
     {
-        $config = $services->get('Configuration');
+        $config = $container->get('Configuration');
 
-        return new Options\ModuleOptions(isset($config['jhu']['zdt_logger']) ? $config['jhu']['zdt_logger'] : array());
+        return new Options\ModuleOptions(isset($config['jhu']['zdt_logger']) ? $config['jhu']['zdt_logger'] : []);
     }
 }
diff --git a/src/Jhu/ZdtLoggerModule/Writer/Stack.php b/src/Jhu/ZdtLoggerModule/Writer/Stack.php
@@ -20,17 +20,7 @@ class Stack extends AbstractWriter
      *
      * @var array
      */
-    protected $stack;
-
-    /**
-     * Constructor
-     */
-    public function __construct($options = null)
-    {
-        parent::__construct($options);
-
-        $this->stack = array();
-    }
+    protected $stack = [];
 
     /**
      * @return array