app\components\ExtensionModule

Complexity

Total Complexity

12

Size/Duplication

Total Lines	180
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	installModule()	0	10	1
A	updateModule()	0	22	2
A	uninstallModule()	0	21	1
A	getMigrationsPath()	0	9	1
A	getMigrationTable()	0	4	1
A	updateConfig()	0	30	3
A	removeConfig()	0	33	3

<?php

namespace app\components;

use app;
use app\modules\config\models\Configurable;
use app\modules\config\helpers\ConfigurationUpdater;
use devgroup\TagDependencyHelper\ActiveRecordHelper;
use Symfony\Component\Process\Process;
use Yii;

/**
 * Class ExtensionModule is the base module that must use all DotPlant2 extensions
 *
 * @package app\components
 */
abstract class ExtensionModule extends \yii\base\Module
{
    /**
     * @var string Path to migrations folder inside extension root source directory
     */
    public $migrationsFolder = 'migrations';

    /**
     * ID of module for application config.
     * You must override it in your extension.
     */
    public static $moduleId = 'temporary-module';

    /**
     * Installs module
     * @param bool $applyAppMigrations
     * @param bool $updateComposer
     * @return mixed

Consider making the return type a bit more specific; maybe use boolean.

     */
    public static function installModule($applyAppMigrations = true, $updateComposer = true)
    {
        Yii::$app->setModule(
            static::$moduleId,
            static::className()

static::className() is of type string, but the function expects a object<yii\base\Module>|array|null.

The method yii\base\BaseObject::className() has been deprecated with message: since 2.0.14. On PHP >=5.5, use `::class` instead.

        );
        /** @var ExtensionModule $module */
        $module = Yii::$app->getModule(static::$moduleId);
        return $module->updateModule($applyAppMigrations, $updateComposer, true);
    }

    /**
     * Updates/installs module
     *
     * @param bool $applyAppMigrations True if we need to apply app migrations
     * @param bool $updateComposer True if we need to update composer
     */
    public function updateModule($applyAppMigrations = true, $updateComposer = true, $updateConfig = true)
    {
        // apply migrations
        $migrationPath = $this->getMigrationsPath();

        /** @var Process $process */
        $process = Yii::$app->updateHelper
            ->applyMigrations(
                $migrationPath,
                $this->getMigrationTable(),
                $applyAppMigrations,
                $updateComposer
            );
        $process->mustRun();


        if ($updateConfig === true) {
            $this->updateConfig();
        }

        return $process->getExitCode() === 0;
    }

    /**
     * Uninstalls module
     * @return bool True if ok
     */
    public function uninstallModule()
    {

        $this->removeConfig();

        // apply migrations
        $migrationPath = $this->getMigrationsPath();

        /** @var Process $process */
        $process = Yii::$app->updateHelper
            ->applyMigrations(
                $migrationPath,
                $this->getMigrationTable(),
                false,
                false,
                true
            );
        $process->mustRun();

        return $process->getExitCode() === 0;
    }

    /**
     * @return string Full real path to module migrations
     */
    public function getMigrationsPath()
    {
        $reflectionClass = new \ReflectionClass($this);
        $directory = dirname($reflectionClass->getFileName());

        return realpath(
            "$directory/{$this->migrationsFolder}/"
        );
    }

    /**
     * @return string Returns name of migration table
     */
    public function getMigrationTable()
    {
        return 'migrations_' . md5($this->className());

The method yii\base\BaseObject::className() has been deprecated with message: since 2.0.14. On PHP >=5.5, use `::class` instead.

    }

    /**
     * Update configurable config if it exists.
     * Unexistent values will be filled with default values.
     */
    public function updateConfig()
    {
        if ($this->getBehavior('configurableModule') !== null) {
            // This extension has config behavior

            // Find corresponding configurable
            $configurable = Configurable::find()
                ->where(['module' => $this->id])
                ->one();

            if ($configurable !== null) {
                // We should save default values of it
                $array = [$configurable];
                ConfigurationUpdater::updateConfiguration(
                    $array,

$array is of type array<integer,object<yii\db\ActiveRecord>|array,{"0":"object<yii\\db\\ActiveRecord>|array"}>, but the function expects a array<integer,object<app\modules\config\models\Configurable>>.

                    false
                );

            }


        }
        \yii\caching\TagDependency::invalidate(
            Yii::$app->cache,
            [
                ActiveRecordHelper::getCommonTag(Configurable::className()),

The method yii\base\BaseObject::className() has been deprecated with message: since 2.0.14. On PHP >=5.5, use `::class` instead.

            ]
        );
    }

    /**
     * Remove module configuration from config files.
     */
    public function removeConfig()
    {
        if ($this->getBehavior('configurableModule') !== null) {
            // This extension has config behavior

            // Find corresponding configurable
            $configurables = Configurable::find()
                ->where('module!=:module', [':module' => $this->id])
                ->all();

            if ($configurables !== null) {
                // The trick is to use previous saved values from other configurables
                // and exclude current module from configuration
                // that is done by setting not to load existing configuration

                ConfigurationUpdater::updateConfiguration(
                    $configurables,
                    false,
                    false
                );

            }


        }
        \yii\caching\TagDependency::invalidate(
            Yii::$app->cache,
            [
                ActiveRecordHelper::getCommonTag(Configurable::className()),

The method yii\base\BaseObject::className() has been deprecated with message: since 2.0.14. On PHP >=5.5, use `::class` instead.

            ]
        );
    }


}