update migration, improve validation rules in the CmsModel

Author: Igor Chepurnoy

components/PageUrlRule.php

@@ -27,16 +27,14 @@ class PageUrlRule extends UrlRule
      * @param \yii\web\UrlManager $manager
      * @param \yii\web\Request $request
      *
-     * @return boolean
+     * @return array|bool
      */
     public function parseRequest($manager, $request)
     {
         $pathInfo = $request->getPathInfo();
-        // get path without '/' in end
         $url = preg_replace("#/$#", "", $pathInfo);
-        // find page by url in db
         $page = (new CmsModel())->findPage($url);
-        // redirect to page
+
         if (!empty($page)) {
             $params['pageAlias'] = $url;
             $params['pageId'] = $page->id;

migrations/m150212_182851_init_cms.php

@@ -1,8 +1,10 @@
 <?php
 
-use yii\db\Schema;
 use yii\db\Migration;
 
+/**
+ * Class m150212_182851_init_cms
+ */
 class m150212_182851_init_cms extends Migration
 {
     public function up()
@@ -14,17 +16,17 @@ public function up()
         }
 
         $this->createTable('{{%Cms}}', [
-            'id' => Schema::TYPE_PK,
-            'url' => Schema::TYPE_STRING . '(255)',
-            'title' => Schema::TYPE_STRING . '(255)',
-            'content' => Schema::TYPE_TEXT,
-            'status' => Schema::TYPE_SMALLINT,
-            'commentAvailable' => 'TINYINT(1) DEFAULT 0',
-            'metaTitle' => Schema::TYPE_TEXT,
-            'metaDescription' => Schema::TYPE_TEXT,
-            'metaKeywords' => Schema::TYPE_TEXT,
-            'createdAt' => Schema::TYPE_INTEGER . ' NOT NULL',
-            'updatedAt' => Schema::TYPE_INTEGER . ' NOT NULL',
+            'id' => $this->primaryKey(),
+            'url' => $this->string()->notNull(),
+            'title' => $this->string()->notNull(),
+            'content' => $this->text()->notNull(),
+            'status' => $this->smallInteger()->notNull()->defaultValue(1),
+            'commentAvailable' => $this->smallInteger()->notNull()->defaultValue(0),
+            'metaTitle' => $this->text()->notNull(),
+            'metaDescription' => $this->text(),
+            'metaKeywords' => $this->text(),
+            'createdAt' => $this->integer()->notNull(),
+            'updatedAt' => $this->integer()->notNull()
         ], $tableOptions);
 
     }
@@ -33,4 +35,4 @@ public function down()
     {
         $this->dropTable('{{%Cms}}');
     }
-}
+}

models/CmsModel.php

@@ -5,6 +5,7 @@
 use Yii;
 use yii\db\ActiveRecord;
 use yii2mod\cms\models\enumerables\CmsStatus;
+use yii2mod\enum\helpers\BooleanEnum;
 
 /**
  * Cms model
@@ -37,12 +38,16 @@ public static function tableName()
     public function rules()
     {
         return [
-            [['url', 'title', 'content', 'metaTitle'], 'required'],
-            [['url'], 'match', 'pattern' => '/^[a-z0-9\/-]+$/'],
+            [['title', 'content', 'url', 'metaTitle', 'metaDescription', 'metaKeywords'], 'trim'],
+            [['title', 'content', 'url', 'metaTitle'], 'required'],
+            ['url', 'match', 'pattern' => '/^[a-z0-9\/-]+$/'],
+            ['url', 'unique'],
             [['content', 'metaTitle', 'metaDescription', 'metaKeywords'], 'string'],
-            [['url'], 'unique'],
+            ['status', 'default', 'value' => CmsStatus::ENABLED],
+            ['status', 'in', 'range' => [CmsStatus::ENABLED, CmsStatus::DISABLED]],
+            ['commentAvailable', 'default', 'value' => BooleanEnum::NO],
             [['status', 'createdAt', 'updatedAt', 'commentAvailable'], 'integer'],
-            [['url', 'title'], 'string', 'max' => 255]
+            [['title', 'url'], 'string', 'max' => 255]
         ];
     }
 

models/CmsQuery.php

@@ -4,7 +4,6 @@
 
 use yii\db\ActiveQuery;
 use yii2mod\cms\models\enumerables\CmsStatus;
-use yii2mod\settings\models\enumerables\SettingStatus;
 
 /**
  * Class CmsQuery

models/enumerables/CmsStatus.php

@@ -10,10 +10,14 @@
  */
 class CmsStatus extends BaseEnum
 {
-    public static $messageCategory = 'yii2mod.cms';
     const ENABLED = 1;
     const DISABLED = 0;
 
+    /**
+     * @var string message category
+     */
+    public static $messageCategory = 'yii2mod.cms';
+
     /**
      * @var array
      */

models/search/CmsModelSearch.php

@@ -22,14 +22,16 @@ public function rules()
     }
 
     /**
-     * Setup search function for filtering and sorting
+     * Creates data provider instance with search query applied
      *
      * @param $params
+     *
      * @return ActiveDataProvider
      */
     public function search($params)
     {
         $query = self::find();
+
         $dataProvider = new ActiveDataProvider([
             'query' => $query,
             'pagination' => [
@@ -41,13 +43,10 @@ public function search($params)
             'defaultOrder' => ['id' => SORT_DESC],
         ]);
 
-
-        // load the search form data and validate
         if (!($this->load($params))) {
             return $dataProvider;
         }
 
-        //adjust the query by adding the filters
         $query->andFilterWhere(['id' => $this->id]);
         $query->andFilterWhere(['status' => $this->status]);
         $query->andFilterWhere(['commentAvailable' => $this->commentAvailable]);

tests/PageActionTest.php

@@ -3,7 +3,6 @@
 namespace yii2mod\cms\tests;
 
 use Yii;
-use yii\web\NotFoundHttpException;
 use yii2mod\cms\actions\PageAction;
 
 /**

tests/TestCase.php

@@ -80,7 +80,6 @@ protected function destroyApplication()
         Yii::$app = null;
     }
 
-
     /**
      * @param array $config controller config.
      * @return Controller controller instance.
@@ -101,16 +100,16 @@ protected function setupTestDbData()
 
         $db->createCommand()->createTable('Cms', [
             'id' => 'pk',
-            'url' => 'string',
-            'title' => 'string',
-            'content' => 'text',
-            'status' => 'integer',
-            'commentAvailable' => 'integer',
-            'metaTitle' => 'text',
+            'url' => 'string not null',
+            'title' => 'string not null',
+            'content' => 'text not null',
+            'status' => 'smallint not null default 1',
+            'commentAvailable' => 'smallint not null default 0',
+            'metaTitle' => 'text not null',
             'metaDescription' => 'text',
             'metaKeywords' => 'text',
-            'createdAt' => 'integer',
-            'updatedAt' => 'integer',
+            'createdAt' => 'integer not null',
+            'updatedAt' => 'integer not null',
         ])->execute();
 
         // Data :
@@ -119,22 +118,22 @@ protected function setupTestDbData()
             'url' => 'about-us',
             'title' => 'about',
             'content' => 'test content',
-            'status' => 1,
-            'commentAvailable' => 0,
             'metaTitle' => 'test content',
             'metaDescription' => 'test content',
-            'metaKeywords' => 'test content'
+            'metaKeywords' => 'test content',
+            'createdAt' => time(),
+            'updatedAt' => time(),
         ])->execute();
 
         $db->createCommand()->insert('Cms', [
             'url' => 'some-url',
             'title' => 'some title',
             'content' => 'My site name is {siteName}',
-            'status' => 1,
-            'commentAvailable' => 0,
             'metaTitle' => 'test content',
             'metaDescription' => 'test content',
-            'metaKeywords' => 'test content'
+            'metaKeywords' => 'test content',
+            'createdAt' => time(),
+            'updatedAt' => time(),
         ])->execute();
     }
 }