global refactoring

Author: ZAYEC77

composer.json

@@ -8,17 +8,24 @@
     ],
     "minimum-stability": "dev",
     "require": {
-        "yiisoft/yii2": "*",
-        "yiisoft/yii2-jui": "~2.0.0",
+        "bower-asset/owl.carousel": "2.*",
         "mihaildev/yii2-ckeditor": "*",
         "mihaildev/yii2-elfinder": "*",
-        "nullref/yii2-useful": "*",
-        "nullref/yii2-core": "*",
-        "bower-asset/owl.carousel": "2.*",
+        "nullref/yii2-core": "^0.0.3",
+        "nullref/yii2-useful": ">=0.0.4",
+        "rmrevin/yii2-fontawesome": ">=2.16.0",
         "trntv/yii2-aceeditor": "*",
         "unclead/yii2-multiple-input": ">=1.2.10",
         "wbraganca/yii2-fancytree-widget": "1.0.1",
-        "rmrevin/yii2-fontawesome": ">=2.16.0"
+        "yiisoft/yii2": ">=2.0.13",
+        "yiisoft/yii2-bootstrap": "^2.0@dev",
+        "yiisoft/yii2-jui": "~2.0.0"
+    },
+    "require-dev": {
+        "yiisoft/yii2-gii": "^2.0@dev"
+    },
+    "config": {
+        "sort-packages": true
     },
     "autoload": {
         "psr-4": {

src/Bootstrap.php

@@ -6,12 +6,16 @@
 use Yii;
 use yii\base\BootstrapInterface;
 use yii\base\Event;
-use yii\gii\Module as Gii;
 use yii\i18n\PhpMessageSource;
 use yii\web\Application as WebApplication;
 
 class Bootstrap implements BootstrapInterface
 {
+    /**
+     * Map of classes possible that could be override
+     *
+     * @var array
+     */
     protected $classMap = [
         'Block' => 'nullref\cms\models\Block',
         'BlockQuery' => 'nullref\cms\models\BlockQuery',
@@ -20,23 +24,35 @@ class Bootstrap implements BootstrapInterface
         'PageQuery' => 'nullref\cms\models\PageQuery',
     ];
 
+    /**
+     * Check if application has cms module, if has:
+     * - add module classes to application container
+     * - add url rule for cms pages
+     * - add elFinder controller
+     * - add i18n for module
+     * - add custom generators to gii
+     *
+     * @param \yii\base\Application $app
+     * @throws \yii\base\InvalidConfigException
+     */
     public function bootstrap($app)
     {
         /** @var Module $module */
         if ($app->hasModule('cms') && ($module = $app->getModule('cms')) instanceof Module) {
             $classMap = array_merge($this->classMap, $module->classMap);
             foreach (array_keys($this->classMap) as $item) {
                 $className = '\nullref\cms\models\\' . $item;
-                $cmsClass = $className::className();
                 $definition = $classMap[$item];
-                Yii::$container->set($cmsClass, $definition);
+                Yii::$container->set($className, $definition);
             }
+
             if ($app instanceof WebApplication) {
-                $prefix = $app->getModule('cms')->urlPrefix;
+                $prefix = $module->urlPrefix;
                 $app->urlManager->addRules([Yii::createObject([
-                    'class' => PageUrlRule::className(),
+                    'class' => PageUrlRule::class,
                     'pattern' => $prefix . '/<route:[_a-zA-Z0-9-/]+>',
                 ])]);
+
                 if (!isset($app->controllerMap['elfinder-backend'])) {
                     $app->controllerMap['elfinder-backend'] = [
                         'class' => 'mihaildev\elfinder\Controller',
@@ -64,13 +80,14 @@ public function bootstrap($app)
                 }
 
                 $app->i18n->translations['cms*'] = [
-                    'class' => PhpMessageSource::className(),
+                    'class' => PhpMessageSource::class,
                     'basePath' => '@nullref/cms/messages',
                 ];
             }
-            if (YII_ENV_DEV) {
-                Event::on(Gii::className(), Gii::EVENT_BEFORE_ACTION, function (Event $event) {
-                    /** @var Gii $gii */
+
+            if ($app->hasModule('gii')) {
+                Event::on(\yii\gii\Module::class, yii\gii\Module::EVENT_BEFORE_ACTION, function (Event $event) {
+                    /** @var \yii\gii\Module $gii */
                     $gii = $event->sender;
                     $gii->generators['block-migration-generator'] = [
                         'class' => 'nullref\cms\generators\block_migration\Generator',

src/Module.php

@@ -2,7 +2,6 @@
 
 namespace nullref\cms;
 
-use nullref\cms\components\PageLayoutManager;
 use nullref\core\components\Module as BaseModule;
 use nullref\core\interfaces\IAdminModule;
 use Yii;
@@ -13,7 +12,7 @@
  * @package nullref\blog
  *
  *
- * @property PageLayoutManager $layoutManager
+ * @property components\PageLayoutManager $layoutManager
  *
  */
 class Module extends BaseModule implements IAdminModule
@@ -26,21 +25,33 @@ class Module extends BaseModule implements IAdminModule
 
     public $urlPrefix = '/pages';
 
+    /**
+     * Module constructor.
+     * Init with inner components
+     *
+     * @param $id
+     * @param null $parent
+     * @param array $config
+     */
     public function __construct($id, $parent = null, $config = [])
     {
         $config = ArrayHelper::merge([
             'components' => [
                 'layoutManager' => [
-                    'class' => '\nullref\cms\components\PageLayoutManager',
+                    'class' => components\PageLayoutManager::class,
                 ],
                 'blockManager' => [
-                    'class' => 'nullref\cms\components\BlockManager',
+                    'class' => components\BlockManager::class,
                 ],
             ],
         ], $config);
         parent::__construct($id, $parent, $config);
     }
 
+    /**
+     * Return module menu for admin module
+     * @return array
+     */
     public static function getAdminMenu()
     {
         return [

src/actions/PageView.php

@@ -10,13 +10,24 @@
 
 
 /**
+ * Class PageView
+ * @package nullref\cms\actions
+ *
+ * Action for rendering cms pages
+ *
  * @author    Dmytro Karpovych
  * @copyright 2015 NRE
  */
 class PageView extends Action
 {
     public $view = 'view';
 
+    /**
+     * @return string
+     * @throws NotFoundHttpException
+     * @throws \Exception
+     * @throws \Throwable
+     */
     public function run()
     {
         if (($route = Yii::$app->request->getQueryParam('route')) == null) {

src/blocks/carousel/_form.php

@@ -13,7 +13,7 @@
 
 ?>
 
-<?= $form->field($block, 'content')->widget(CKEditor::className(), [
+<?= $form->field($block, 'content')->widget(CKEditor::class, [
     'id' => 'editor',
     'editorOptions' => [
         'preset' => 'full',

src/blocks/html/_form.php

@@ -60,6 +60,6 @@
 
 $editorConfig['editorOptions'] = ElFinder::ckeditorOptions('elfinder-backend', $editorConfig['editorOptions']);
 
-echo $form->field($block, 'content')->widget(CKEditor::className(), $editorConfig);
+echo $form->field($block, 'content')->widget(CKEditor::class, $editorConfig);
 echo $form->field($block, 'tag')->textInput();
 echo $form->field($block, 'tagClass')->textInput();

src/blocks/image/_form.php

@@ -7,7 +7,7 @@
  * @var $block \nullref\cms\blocks\text\Block
  */
 
-echo $form->field($block, 'image')->widget(InputFile::className(), [
+echo $form->field($block, 'image')->widget(InputFile::class, [
     'language' => 'ru',
     'controller' => 'elfinder-backend',
     'filter' => 'image',

src/blocks/php/_form.php

@@ -62,6 +62,6 @@
 
 $editorConfig['editorOptions'] = ElFinder::ckeditorOptions('elfinder-backend', $editorConfig['editorOptions']);
 
-echo $form->field($block, 'content')->widget(CKEditor::className(), $editorConfig);
+echo $form->field($block, 'content')->widget(CKEditor::class, $editorConfig);
 echo $form->field($block, 'tag')->textInput();
 echo $form->field($block, 'tagClass')->textInput();

src/components/Block.php

@@ -17,6 +17,8 @@ abstract class Block extends Model
      * @param array $config
      * @param string $moduleId
      * @return Widget
+     * @throws \Exception
+     * @throws \yii\base\InvalidConfigException
      */
     public static function getBlock($blockId, $config = [], $moduleId = 'cms')
     {
@@ -25,26 +27,41 @@ public static function getBlock($blockId, $config = [], $moduleId = 'cms')
 
     /**
      * @param string $moduleId
-     * @return BlockManager
+     * @return null|BlockManager
      */
     public static function getManager($moduleId = 'cms')
     {
         return \Yii::$app->getModule($moduleId)->get('blockManager');
     }
 
+    /**
+     * Return name of block
+     * @return mixed
+     */
     public abstract function getName();
 
+    /**
+     * Return path to form class
+     * @return bool|string
+     */
     public function getForm()
     {
         return realpath($this->getDir() . '/' . $this->formFile);
     }
 
+    /**
+     * Get path to directory with block classes
+     * @return string
+     */
     protected function getDir()
     {
         $reflector = new \ReflectionClass(get_class($this));
         return dirname($reflector->getFileName());
     }
 
+    /**
+     * @return array
+     */
     public function getConfig()
     {
         return $this->getAttributes(null, ['formFile']);

src/components/BlockManager.php

@@ -9,6 +9,12 @@
 use yii\caching\TagDependency;
 use yii\helpers\ArrayHelper;
 
+/**
+ * Class BlockManager
+ * Contain list of blocks and management creation of block widgets
+ *
+ * @package nullref\cms\components
+ */
 class BlockManager extends Component
 {
     const CLASS_WIDGET = '\Widget';
@@ -39,10 +45,14 @@ public function register($id, $namespace)
     }
 
     /**
+     * Create instance of block widget by block id
+     *
      * @param $id
      * @param $config
-     * @return \nullref\cms\components\Widget
-     * @throws \yii\base\InvalidConfigException | \Exception
+     * @return Widget
+     * @throws InvalidConfigException
+     * @throws \Exception
+     * @throws \Throwable
      */
     public function getWidget($id, $config = [])
     {
@@ -71,6 +81,7 @@ public function getWidget($id, $config = [])
     }
 
     /**
+     * Return current list of blocks in system
      * @return array
      */
     public function getList()