InstallBlender::assignDescription() - Code Metrics - Inspection of "Fix for SiteTest" - LippertComponents/Blend - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( ccaaed...17ba08 )

by Josh
created 2018-10-08 15:47 UTC
InstallBlender::assignDescription() A

↳ Parent: InstallBlender
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0
<?php

/**
 * Auto Generated from Blender
 * Date: 2017/11/10 at 15:29:37 EST -05:00
 */

use \LCI\Blend\Migrations;

class InstallBlender extends Migrations
{
    /** @var array  */
    protected $blender_table_classes = [
        'BlendMigrations'
    ];

    /** @var array  */
    protected $blender_events = [
        'OnBlendBeforeSave',
        'OnBlendAfterSave',
        'OnBlendSeed',
        'OnBlendLoadRelatedData',
        // @TODO replace:
        'OnBlendSeedSystemSettings'
    ];

    protected $empty_settings = [
        'blend.portable.systemSettings.templates',
        'blend.portable.systemSettings.mediaSources',
        'blend.portable.systemSettings.resources',

        'blend.portable.templateVariables.templates',
        'blend.portable.templateVariables.mediaSources',
        'blend.portable.templateVariables.resources',
    ];

    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        // install DB table:
        $manager = $this->modx->getManager();

        // the class table object name
        $table_class = $this->blender->getBlendClassObject();
        //foreach ($this->blender_table_classes as $table_class) {
            if ($manager->createObjectContainer($table_class)) {
                $this->blender->out($table_class.' table class has been created');

            } else {
                $this->blender->out($table_class.' table class was not created', true);
                $this->blender->out($table_class.' table class was not created', /** @scrutinizer ignore-type */ true);
            }
        //}

        // install events:
        foreach ($this->blender_events as $event_name) {
            $this->createSystemEvents($event_name);
        }

        /** @var \LCI\Blend\Blendable\SystemSetting $systemSetting */
        $systemSetting = $this->blender->getBlendableLoader()->getBlendableSystemSetting('blend.version');
        $systemSetting
            ->setSeedsDir($this->getSeedsDir())
            ->setFieldValue($this->blender->getVersion())
            ->setFieldArea('Blend')
            ->blend();

        foreach ($this->empty_settings as $key) {

            /** @var \LCI\Blend\Blendable\SystemSetting $systemSetting */
            $systemSetting = $this->blender->getBlendableLoader()->getBlendableSystemSetting($key);
            $systemSetting
                ->setSeedsDir($this->getSeedsDir())
                ->setFieldArea('Blend')
                ->blend();
        }

        $this->modx->cacheManager->refresh();
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        // remove DB Table:
        $manager = $this->modx->getManager();

        // the class table object name
        $table_class = $this->blender->getBlendClassObject();
        //foreach ($this->blender_table_classes as $table_class) {
            if ($manager->removeObjectContainer($table_class)) {
                $this->blender->out($table_class.' table class has been dropped');

            } else {
                $this->blender->out($table_class.' table class was not dropped', true);
                $this->blender->out($table_class.' table class was not dropped', /** @scrutinizer ignore-type */ true);
            }
        //}

        // remove events:
        foreach ($this->blender_events as $event_name) {
            $this->removeSystemEvents($event_name);
        }

        /** @var \LCI\Blend\Blendable\SystemSetting $systemSetting */
        $systemSetting = $this->blender->getBlendableLoader()->getBlendableSystemSetting('blend.version');
        $systemSetting
            ->setSeedsDir($this->getSeedsDir())
            ->revertBlend();

        foreach ($this->empty_settings as $key) {
            /** @var \LCI\Blend\Blendable\SystemSetting $systemSetting */
            $systemSetting = $this->blender->getBlendableLoader()->getBlendableSystemSetting($key);
            $systemSetting
                ->setSeedsDir($this->getSeedsDir())
                ->revertBlend();
        }

        $this->modx->cacheManager->refresh();
    }

    /**
     * @param $event_name
     */
    protected function createSystemEvents($event_name)
    {
        $event = $this->modx->getObject('modEvent', ['name' => $event_name]);
        if (is_object($event)) {
            $this->blender->out($event_name.' event has already been installed', true);
            $this->blender->out($event_name.' event has already been installed', /** @scrutinizer ignore-type */ true);
        } else {
            /** @var \modEvent $event */
            $event = $this->modx->newObject('modEvent');
            $event->set('name', $event_name);
            $event->set('service', 1);
            $event->set('groupname', 'Resources');// ??

            if ($event->save()) {
                $this->blender->out($event_name.' event has been installed');

            } else {
                $this->blender->out($event_name.' event did not install', true);
            }
        }
    }

    /**
     * @param $event_name
     */
    protected function removeSystemEvents($event_name)
    {
        $event = $this->modx->getObject('modEvent', ['name' => $event_name]);
        if (is_object($event)) {
            if ($event->remove()) {
                $this->blender->out($event_name . ' event was removed', true);
                $this->blender->out($event_name . ' event was removed', /** @scrutinizer ignore-type */ true);
            } else {
                $this->blender->out($event_name . ' event was not removed', true);
            }
        } else {
            $this->blender->out($event_name . ' event has already been removed', true);
        }
    }

    /**
     * Method is called on construct, please fill me in
     */
    protected function assignDescription()
    {
        $this->description = 'Install of Blender';
    }

    /**
     * Method is called on construct, please fill me in
     */
    protected function assignVersion()
    {
        $this->version = '0.9.0';
    }

    /**
     * Method is called on construct, can change to only run this migration for those types
     */
    protected function assignType()
    {
        $this->type = 'master';
    }

    /**
     * Method is called on construct, Child class can override and implement this
     */
    protected function assignSeedsDir()
    {
        $this->seeds_dir = 'InstallBlender';
    }
}

LippertComponents / Blend

Push — master ( ccaaed...17ba08 )

InstallBlender::assignDescription() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
