Merge pull request #2 from shershennm/staging

3.1.0 Update
shershennm · May 10, 2018 · ec4f561 · ec4f561
2 parents a071474 + 3a4db76
commit ec4f561
Show file tree

Hide file tree

Showing 6 changed files with 109 additions and 50 deletions.
diff --git a/OnePageSeoController.php b/OnePageSeoController.php
@@ -0,0 +1,50 @@
+<?php
+
+namespace shershennm\seo;
+
+use Yii;
+
+abstract class OnePageSeoController extends SeoController
+{
+    /**
+     * @var array Array of routes with titles
+     */
+    protected $titles = [];
+
+    /**
+     * @var array Array of routes with titles. Routes are regular expressions in this case
+     */
+    protected $wildcardTitles = [];
+
+    /**
+     * Default action for one page controller.
+     *
+     * @return array
+     */
+    public function actionIndex()
+    {
+        $this->setTitle(Yii::$app->request->pathInfo);
+
+        return [];
+    }
+
+    /**
+     * @param $route
+     */
+    protected function setTitle($route)
+    {
+        if (isset($this->titles[$route])) {
+            $this->title = $this->titles[$route];
+
+            return;
+        }
+
+        foreach ($this->wildcardTitles as $wildcardRoute => $wildcardTitle) {
+            if (preg_match($wildcardRoute, $route)) {
+                $this->title = $wildcardTitle;
+
+                return;
+            }
+        }
+    }
+}
diff --git a/README.md b/README.md
@@ -1,19 +1,13 @@
 # yii2-seo
 
-Yii2 module for easy creating meta tags 
+Yii2 module for easy creating meta tags
 
 # Installation
-
-Yii <= 2.0.12
-
-`composer require shershennm/yii2-seo:"^2.0"`
-
-Yii >= 2.0.13
-
 `composer require shershennm/yii2-seo:"^3.0"`
 # Usage
-in config file:
-```sh
+In config file:
+```php
+<?php
 ...
 'bootstrap' => ['log', 'seo'], // add seo component to application bootstrap
 ...
@@ -28,8 +22,8 @@ in config file:
     ],
 ]
 ```
-seo controller example:
-```sh
+Seo controller example:
+```php
 <?php
 
 namespace app\seo\controllers;
@@ -38,7 +32,7 @@ use Yii;
 use shershennm\seo\SeoController;
 
 class SiteController extends SeoController
-{ 
+{
     /**
     * $viewParams array View Params from actionIndex in SiteController
     **/
@@ -54,12 +48,31 @@ class SiteController extends SeoController
             ['name' => 'description', 'content' => 'Cool page!'],
         ];
     }
-    
+
     private function getKeywords()
     {
         // $this->controller instance of current controller
         return implode($this->controller->words, ', ');
     }
 
 	....
-```
+```
+You can use ```OnePagSeoController``` for controller which have ```index``` action for different routes. Example:
+```php
+<?php
+
+namespace frontend\seo\controllers;
+
+use shershennm\seo\OnePageSeoController;
+
+class SiteController extends OnePageSeoController
+{
+    protected $titles = [
+        'site/info' => 'Site Info',
+    ];
+    protected $wildcardTitles = [
+        '/site\/history/' => 'Site History',
+    ];
+}
+```
+Route of ```$titles``` will be applied only to pages with same route. ```$wildcardTitles``` use regular expression as route.
diff --git a/Seo.php b/Seo.php
@@ -3,7 +3,6 @@
 namespace shershennm\seo;
 
 use Yii;
-
 use yii\base\ActionEvent;
 use yii\base\Component;
 use yii\base\ViewEvent;
@@ -13,7 +12,8 @@
 class Seo extends Component
 {
     /**
-     * controller namespace => seo controller namespace
+     * controller namespace => seo controller namespace.
+     *
      * @var array
      */
     public $controllerMapping;
@@ -51,16 +51,15 @@ public function getController()
      */
     public function getReflectionController()
     {
-        if ($this->_reflectionController === null)
-        {
+        if ($this->_reflectionController === null) {
             $this->_reflectionController = $this->buildReflectionController();
         }
 
         return $this->_reflectionController;
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
      */
     public function init()
     {
@@ -69,17 +68,13 @@ public function init()
         parent::init();
     }
 
-    /**
-     * @return void
-     */
     private function initEventBranches()
     {
         ActionEvent::on(Controller::className(), Controller::EVENT_BEFORE_ACTION, [$this, 'eventControllerBeforeAction']);
     }
 
     /**
      * @param $event ActionEvent
-     * @return void
      */
     public function eventControllerBeforeAction($event)
     {
@@ -89,7 +84,7 @@ public function eventControllerBeforeAction($event)
 
     /**
      * @param $event ViewEvent
-     * @return void
+     *
      * @throws \yii\base\InvalidConfigException
      */
     public function eventViewBeforeRender($event)
@@ -101,6 +96,7 @@ public function eventViewBeforeRender($event)
 
     /**
      * @param $viewEvent ViewEvent
+     *
      * @throws \yii\base\InvalidConfigException
      */
     public function setMeta($viewEvent)
@@ -118,16 +114,17 @@ public function setMeta($viewEvent)
 
     /**
      * @param $viewEvent ViewEvent
+     *
      * @return bool
+     *
      * @throws \yii\base\InvalidConfigException
      */
     private function executeSeoControllerAction($viewEvent)
     {
         $seoController = Yii::createObject($this->buildSeoControllerClassName());
         $actionMethod = $this->controller->action->actionMethod;
 
-        if (method_exists($seoController, $actionMethod))
-        {
+        if (method_exists($seoController, $actionMethod)) {
             $seoController->controller = $this->controller;
             $seoController->view = $viewEvent->sender;
 
@@ -144,6 +141,7 @@ private function executeSeoControllerAction($viewEvent)
 
     /**
      * @param $title string
+     *
      * @return string
      */
     protected function buildTitle($title)
@@ -154,7 +152,7 @@ protected function buildTitle($title)
             'defaultAppend' => $this->titleAppend,
         ];
 
-        if(is_array($title)) {
+        if (is_array($title)) {
             $title = new Title(array_merge($title, $defaults));
         } else {
             $title = new Title(array_merge(['title' => $title], $defaults));
@@ -166,7 +164,6 @@ protected function buildTitle($title)
     /**
      * @param $view View
      * @param $metaArray array
-     * @return void
      */
     public function addMeta($view, $metaArray)
     {
@@ -189,7 +186,7 @@ public function addTitle($view, $title = null)
      */
     private function buildReflectionController()
     {
-        return (new \ReflectionClass($this->controller));
+        return new \ReflectionClass($this->controller);
     }
 
     /**
@@ -213,7 +210,7 @@ private function isSeoControllerExists()
      */
     private function isValidController()
     {
-        return (Yii::$app->controller !== null && Yii::$app->controller->action->className() !== 'yii\web\ErrorAction');
+        return Yii::$app->controller !== null && Yii::$app->controller->action->className() !== 'yii\web\ErrorAction';
     }
 
     /**
@@ -223,4 +220,4 @@ private function buildSeoControllerClassName()
     {
         return sprintf('%s\%s', $this->controllerMapping[$this->reflectionController->getNamespaceName()], $this->reflectionController->getShortName());
     }
-}
+}
diff --git a/SeoController.php b/SeoController.php
@@ -7,37 +7,39 @@
 abstract class SeoController extends BaseObject
 {
     /**
-     * @var $title string Page <title> tag value
+     * @var string Page <title> tag value
      */
-	public $title;
+    public $title;
 
     /**
-     * @var $controller \yii\web\Controller Web Controller instance
+     * @var \yii\web\Controller Web Controller instance
      */
-	public $controller;
+    public $controller;
 
     /**
-     * @var $view \yii\web\View Controller View
+     * @var \yii\web\View Controller View
      */
     public $view;
 
     /**
-     * Register <meta> tag in current view
-     * @param  array $options params for View::registerMetaTag method
+     * Register <meta> tag in current view.
+     *
+     * @param array $options params for View::registerMetaTag method
      */
     public function registerMetaTag($options)
     {
         return $this->view->registerMetaTag($options);
     }
 
     /**
-     * Register <link> tag in current view
-     * @param  array $options params for View::registerLinkTag method
+     * Register <link> tag in current view.
+     *
+     * @param array $options params for View::registerLinkTag method
      */
     public function registerLinkTag($options)
     {
         return $this->view->registerLinkTag(array_merge([
             'type' => null,
         ], $options));
     }
-}
+}
diff --git a/Title.php b/Title.php
@@ -49,10 +49,8 @@ public function buildTitle()
      */
     public function getTitle()
     {
-        if ($this->title === null)
-        {
-            if ($this->defaultTitle !== null)
-            {
+        if ($this->title === null) {
+            if ($this->defaultTitle !== null) {
                 return $this->defaultTitle;
             }
 
@@ -89,5 +87,4 @@ public function getAppend()
 
         return $this->append;
     }
-
-}
+}
diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
 	"name": "shershennm/yii2-seo",
 	"description": "Yii2 extension for simple generating keywords and description",
-	"version": "3.0.0",
+	"version": "3.1.0",
 	"type": "yii2-extension",
 	"keywords": ["yii2", "seo", "keywords", "meta", "link"],
 	"homepage": "https://github.com/shershennm/yii2-seo",
@@ -26,4 +26,4 @@
 			"shershennm\\seo\\": ""
 		}
 	}
-}
+}