Develop (#2)

* refactoring

Author: n3vrax

CHANGELOG.md

@@ -0,0 +1,15 @@
+## 0.1.0 - 2017-03-09
+
+Initial tagged release
+
+### Added
+* Everything
+
+### Deprecated
+* Nothing
+
+### Removed
+* Nothing
+
+### Fixed
+* Nothing

README.md

@@ -16,38 +16,38 @@ Next, make sure you merge the `ConfigProvider` to your application's configurati
 
 In any controller, you can access the plugin by calling
 ```php
-$this->flashMessenger()->...
+$this->messenger()->...
 ```
 
 The methods defined by this plugin are
 ```php
-$this->flashMessenger()->addMessage($namespace, $value);
+$this->messenger()->addMessage($namespace, $value);
 ```
 Adds a session message to at the requested namespace
 
 ```php
-$this->flashMessenger()->addData($key, $data);
+$this->messenger()->addData($key, $data);
 ```
 Almost the same as the addMessage method, but named differently in order to reserve this function for adding general session data.
 
 There are also some shortcuts to the addMessage method which are using predefined namespaces
 ```php
-$this->flashMessenger()->addError($error);
+$this->messenger()->addError($error);
 
-$this->flashMessenger()->addWarning($message);
+$this->messenger()->addWarning($message);
 
-$this->flashMessenger()->addInfo($message);
+$this->messenger()->addInfo($message);
 
-$this->flashMessenger()->addSuccess($message);
+$this->messenger()->addSuccess($message);
 ```
 
 Also, the getter methods
 ```php
-$this->flashMessenger()->getMessages($namespace = null);
+$this->messenger()->getMessages($namespace = null);
 ```
 Gets all messages under a namespace, or if namespace is not specified it will return all namespaces with all messages
 
 ```php
-$this->flashMessenger()->getData($key);
+$this->messenger()->getData($key);
 ```
-Gets the data stored at the specified key
+Gets the data stored at the specified key

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "dotkernel/dot-controller-plugin-flashmessenger",
   "type": "library",
-  "description": "Flashmessenger DK controller plugin",
+  "description": "DotKernel flash messenger controller plugin",
   "license": "MIT",
   "authors": [
     {
@@ -10,15 +10,15 @@
     }
   ],
   "require": {
-    "php": "^5.6 || ^7.0",
+    "php": "^7.1",
     "container-interop/container-interop": "^1.1",
-    "dotkernel/dot-controller": "0.6.x-dev"
+
+    "dotkernel/dot-controller": "~0.1",
+    "dotkernel/dot-flashmessenger": "~0.1"
   },
   "require-dev": {
     "phpunit/phpunit": "^4.8",
-    "squizlabs/php_codesniffer": "^2.3",
-
-    "dotkernel/dot-flashmessenger": "0.6.x-dev"
+    "squizlabs/php_codesniffer": "^2.3"
   },
   "autoload": {
     "psr-4": {
@@ -32,7 +32,7 @@
   },
   "extra": {
     "branch-alias": {
-      "dev-master": "0.6-dev"
+      "dev-master": "0.2-dev"
     }
   }
 }

src/ConfigProvider.php

@@ -7,6 +7,8 @@
  * Time: 6:49 PM
  */
 
+declare(strict_types = 1);
+
 namespace Dot\Controller\Plugin\FlashMessenger;
 
 use Dot\Controller\Plugin\FlashMessenger\Factory\FlashMessengerPluginFactory;
@@ -20,13 +22,13 @@ class ConfigProvider
     /**
      * @return array
      */
-    public function __invoke()
+    public function __invoke(): array
     {
         return [
             'dot_controller' => [
                 'plugin_manager' => [
                     'factories' => [
-                        'flashMessenger' => FlashMessengerPluginFactory::class,
+                        'messenger' => FlashMessengerPluginFactory::class,
                     ],
                 ],
             ],

src/Factory/FlashMessengerPluginFactory.php

@@ -7,6 +7,8 @@
  * Time: 6:50 PM
  */
 
+declare(strict_types = 1);
+
 namespace Dot\Controller\Plugin\FlashMessenger\Factory;
 
 use Dot\Controller\Plugin\FlashMessenger\FlashMessengerPlugin;

src/FlashMessengerPlugin.php

@@ -7,6 +7,8 @@
  * Time: 6:49 PM
  */
 
+declare(strict_types = 1);
+
 namespace Dot\Controller\Plugin\FlashMessenger;
 
 use Dot\Controller\Plugin\PluginInterface;
@@ -31,70 +33,80 @@ public function __construct(FlashMessengerInterface $flashMessenger)
     }
 
     /**
-     * @param string $namespace
+     * @param string $type
+     * @param string $channel
      * @param mixed $value
      */
-    public function addMessage($namespace, $value)
+    public function addMessage(string $type, $value, string $channel = FlashMessengerInterface::DEFAULT_CHANNEL)
     {
-        $this->flashMessenger->addMessage($namespace, $value);
+        $this->flashMessenger->addMessage($type, $value, $channel);
     }
 
     /**
-     * @param $key
-     * @param $value
+     * @param string $key
+     * @param string $channel
+     * @param mixed $value
      */
-    public function addData($key, $value)
+    public function addData(string $key, $value, string $channel = FlashMessengerInterface::DEFAULT_CHANNEL)
     {
-        $this->flashMessenger->addData($key, $value);
+        $this->flashMessenger->addData($key, $value, $channel);
     }
 
     /**
-     * @param $error
+     * @param mixed $error
+     * @param string $channel
      */
-    public function addError($error)
+    public function addError($error, string $channel = FlashMessengerInterface::DEFAULT_CHANNEL)
     {
-        $this->flashMessenger->addError($error);
+        $this->flashMessenger->addError($error, $channel);
     }
 
     /**
-     * @param $message
+     * @param mixed $message
+     * @param string $channel
      */
-    public function addWarning($message)
+    public function addWarning($message, string $channel = FlashMessengerInterface::DEFAULT_CHANNEL)
     {
-        $this->flashMessenger->addWarning($message);
+        $this->flashMessenger->addWarning($message, $channel);
     }
 
     /**
-     * @param $message
+     * @param mixed $message
+     * @param string $channel
      */
-    public function addInfo($message)
+    public function addInfo($message, string $channel = FlashMessengerInterface::DEFAULT_CHANNEL)
     {
-        $this->flashMessenger->addInfo($message);
+        $this->flashMessenger->addInfo($message, $channel);
     }
 
     /**
-     * @param $message
+     * @param mixed $message
+     * @param string $channel
      */
-    public function addSuccess($message)
+    public function addSuccess($message, string $channel = FlashMessengerInterface::DEFAULT_CHANNEL)
     {
-        $this->flashMessenger->addSuccess($message);
+        $this->flashMessenger->addSuccess($message, $channel);
     }
 
     /**
-     * @param $namespace
-     * @return array|null
+     * @param string $type
+     * @param string $channel
+     * @return array
      */
-    public function getMessages($namespace = null)
-    {
-        return $this->flashMessenger->getMessages($namespace);
+    public function getMessages(
+        string $type = null,
+        string $channel = FlashMessengerInterface::DEFAULT_CHANNEL
+    ): array {
+        return $this->flashMessenger->getMessages($type, $channel);
     }
 
     /**
-     * @param $key
+     * @param string $key
+     * @param string $channel
      * @return mixed
      */
-    public function getData($key)
+    public function getData(string $key, string $channel = FlashMessengerInterface::DEFAULT_CHANNEL)
     {
-        return $this->flashMessenger->getData($key);
+        return $this->flashMessenger->getData($key, $channel);
     }
 }