Blendable::makeHistory() - Code Metrics - Inspection of "Cleaned up a few unneeded @TODOs" - LippertComponents/Blend - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed
Push — master ( 7c77cf...a1eff0 )

by Josh
created 2018-10-15 16:11 UTC
Blendable::makeHistory() A

↳ Parent: Blendable
Complexity

Conditions	1
Paths	1
Size

Total Lines	15
Code Lines	8
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	8
nc	1
nop	0
dl	0
loc	15
rs	10
c	0
b	0
f	0
<?php
/**
 * Created by PhpStorm.
 * User: joshgulledge
 * Date: 3/5/18
 * Time: 11:14 AM
 */

namespace LCI\Blend\Blendable;

use LCI\Blend\Blender;
use LCI\Blend\Exception\BlendableException;
filter:
    dependency_paths: ["lib/*"]

abstract class Blendable implements BlendableInterface
{
    /** @var  \modx */
filter:
    dependency_paths: ["lib/*"]
    protected $modx;

    /** @var  Blender */
    protected $blender;

    /** @var string ~ blend or revert */
    protected $type = 'blend';

    /** @var string  */
    protected $opt_cache_key = '';

    /** @var array  */
    protected $seedCacheOptions = [];

    /** @var array  */
    protected $historyCacheOptions = [];

    /** @var string */
    protected $seeds_dir = '';

    /** @var int $cache_life in seconds, 0 is forever */
    protected $cache_life = 0;

    /** @var bool  */
    protected $error = false;

    /** @var array  */
    protected $error_messages = [];

    /** @var null|\xPDOSimpleObject  */
filter:
    dependency_paths: ["lib/*"]
    protected $xPDOSimpleObject = null;

    /** @var string ex: modResource */
    protected $xpdo_simple_object_class = '';

    /** @var string  */
    protected $unique_key_column = 'name';

    /** @var array set when a change of name/alias has been done */
    protected $unique_key_history = [];

    /** @var array ~ this should match data to be inserted via xPDO, ex [column_name => value, ...] */
    protected $blendable_xpdo_simple_object_data = [
        'name' => ''
    ];

    /** @var array ~ ['setMethodName' => 'setMethodActualName', 'setDoNotUseMethod' => false] overwrite in child classes */
    protected $load_from_array_aliases = [];

    /** @var array ~ list any fields/columns to be ignored on making seeds, like id */
    protected $ignore_seed_fields = ['id'];

    /** @var array ~ xPDOSimpleObject->fromArray() */
    protected $current_xpdo_simple_object_data = [];

    /** @var array  */
    protected $related_data = [];

    /** @var bool  */
    protected $exists = false;

    /** @var bool  */
    protected $debug = false;

    /**
     * Blendable constructor.
     *
     * @param \modx $modx
     * @param Blender $blender
     * @param string|array $unique_value
     */
    public function __construct(\modx $modx, Blender $blender, $unique_value = '')
    {
        $this->modx = $modx;
        $this->blender = $blender;
        if (method_exists($this, 'loadProperties')) {
            $this->loadProperties();
        }

        $this->seedCacheOptions = [
            \xPDO::OPT_CACHE_KEY => $this->opt_cache_key,
filter:
    dependency_paths: ["lib/*"]
            \xPDO::OPT_CACHE_PATH => $this->blender->getSeedsPath()
        ];

        $this->historyCacheOptions = [
            \xPDO::OPT_CACHE_KEY => $this->opt_cache_key,
            \xPDO::OPT_CACHE_PATH => $this->blender->getHistoryPath()
        ];

        $this->setUniqueCriteria($unique_value);
        if (!empty($unique_value)) {
            $this->loadObject();
        }
    }

    /**
     * @return bool
     */
    public function isDebug()
    {
        return $this->debug;
    }

    /**
     * @param bool $debug
     *
     * @return $this
     */
    public function setDebug($debug)
    {
        $this->debug = $debug;
        return $this;
    }

    /**
     * @return string
     */
    public function getSeedsDir()
    {
        return $this->seeds_dir;
    }

    /**
     * @param string $dir ~ will be the directory name for seeds and history
     *
     * @return $this
     */
    public function setSeedsDir($dir)
    {
        $this->seeds_dir = (string)$dir;
        if (!empty($this->seeds_dir)) {
            $this->seedCacheOptions[\xPDO::OPT_CACHE_PATH] = $this->blender->getSeedsPath().$dir.'/';
            $this->historyCacheOptions[\xPDO::OPT_CACHE_PATH] = $this->blender->getHistoryPath().$dir.'/';
        }
        return $this;
    }

    /**
     * @return bool
     */
    public function isExists()
    {
        return $this->exists;
    }

    /**
     * @return bool
     */
    public function isError()
    {
        return $this->error;
    }

    /**
     * @return array
     */
    public function getErrorMessages()
    {
        return $this->error_messages;
    }

    /**
     * @param string $type ~ seed or revert
     * @return string
     */
    public function getSeedKey($type = 'seed')
    {
        $name = $this->blendable_xpdo_simple_object_data[$this->unique_key_column];
        if (method_exists($this, 'getFieldName')) {
            $name = $this->getFieldName();
        }
        $key = $this->blender->getSeedKeyFromName($name);

        switch ($type) {
            case 'revert':
                $seed_key = 'revert-'.$key;
                break;

            case 'seed':
                // no break
            default:
                $seed_key = $key;
        }

        return $seed_key;
    }

    /**
     * @return null|\xPDOSimpleObject
     */
    public function getXPDOSimpleObject()
    {
        return $this->xPDOSimpleObject;
    }

    /**
     * @param array $data ~ must be in the format: array('columns' => [], 'primaryKeyHistory' => [], 'related' => [])
     * @param bool $overwrite
     * @return bool
     */
    public function blendFromArray($data, $overwrite = false)
    {
        if (isset($data['columns'])) {
            $this->blendable_xpdo_simple_object_data = $data['columns'];
        }
        if (isset($data['primaryKeyHistory']) && $data['primaryKeyHistory']) {
            $this->unique_key_history = $data['primaryKeyHistory'];
        } else {
            $this->unique_key_history = [];
        }

        if (isset($data['related']) && $data['related']) {
            $this->related_data = $data['related'];
        } else {
            $this->related_data = [];
        }

        return $this->blend($overwrite);
    }
    /**
     * @param string $seed_key
     * @param bool $overwrite
     *
     * @return bool
     */
    public function blendFromSeed($seed_key, $overwrite = false)
    {
        $this->loadObjectDataFromSeed($seed_key);
        return $this->blend($overwrite);
    }

    /**
     * @param bool $overwrite
     *
     * @return bool
     */
    public function blend($overwrite = false)
    {
        if ($this->type == 'blend') {
            /** @var \LCI\Blend\Blendable\Blendable $currentVersion */
            $currentVersion = $this->getCurrentVersion();
            $currentVersion
                ->setRelatedData($this->related_data)
                ->makeHistory();
        }

        $this->modx->invokeEvent(
            'OnBlendBeforeSave',
            [
                'blender' => $this->blender,
                'blendable' => $this,
                'data' => &$this->blendable_xpdo_simple_object_data,
                'type' => $this->type,
                'xPDOClass' => $this->xpdo_simple_object_class,
                'xPDOSimpleObject' => &$this->xPDOSimpleObject
            ]
        );

        $save = $this->save($overwrite);

        if ($save) {
            $this->modx->invokeEvent(
                'OnBlendAfterSave',
                [
                    'blender' => $this->blender,
                    'blendable' => $this,
                    'data' => &$this->blendable_xpdo_simple_object_data,
                    'type' => $this->type,
                    'xPDOClass' => $this->xpdo_simple_object_class,
                    'xPDOSimpleObject' => &$this->xPDOSimpleObject
                ]
            );
        }

        return $save;
    }

    /**
     * @param bool $make_revert_seed
     * @return bool
     */
    public function delete($make_revert_seed = true)
    {
        if ($make_revert_seed) {
            $this->makeHistory();
        }
        $removed = false;
        if (!is_object($this->xPDOSimpleObject)) {
            $this->blender->out($this->blendable_xpdo_simple_object_data[$this->unique_key_column].' of xPDO class '.
                $this->xpdo_simple_object_class.' was not found, could not be removed/deleted', true);
                $this->xpdo_simple_object_class.' was not found, could not be removed/deleted', /** @scrutinizer ignore-type */ true);

        } elseif ($this->xPDOSimpleObject->remove()) {
            $this->onDeleteRevertRelatedPieces();
            if ($this->isDebug()) {
                $this->blender->out($this->blendable_xpdo_simple_object_data[$this->unique_key_column].' has been removed/deleted');
            }
            $removed = true;

        } else {
            if ($this->isDebug()) {
                $this->blender->out($this->blendable_xpdo_simple_object_data[$this->unique_key_column].' did not remove/delete', true);
            }
        }

        return $removed;
    }

    /**
     * @return bool
     */
    public function revertBlend()
    {
        $seed_key = $this->getSeedKey('revert');
        $this->type = 'revert';
        if (!$this->loadObjectDataFromHistorySeed($seed_key) || !$this->blendable_xpdo_simple_object_data) {

            return $this->delete(false);
        }

        return $this->blend(true);
    }

    /**
     * @return string ~ the related seed key
     */
    public function seed()
    {
        // No IDs! must get the alias and get a seed key,
        $seed_key = $this->getSeedKey();

        $data = $this->seedToArray('seed', $seed_key);

        // now cache it:
        $this->modx->cacheManager->set(
            $seed_key,
            $data,
            $this->cache_life,
            $this->seedCacheOptions
        );

        return $seed_key;
    }

    /**
     * @return string ~ the related seed key
     */
    public function makeHistory()
    {
        $seed_key = $this->getSeedKey('revert');

        $data = $this->seedToArray('revert', $seed_key);

        // now cache it:
        $this->modx->cacheManager->set(
            $seed_key,
            $data,
            $this->cache_life,
            $this->historyCacheOptions
        );

        return $seed_key;
    }

    /**
     * @param string $type ~ seed or revert
     * @param string $seed_key
     * @return array
     */
    public function seedToArray($type = 'seed', $seed_key = '')
    {
        if (is_object($this->xPDOSimpleObject)) {
            $this->current_xpdo_simple_object_data = $this->xPDOSimpleObject->toArray();

            foreach ($this->current_xpdo_simple_object_data as $column => $value) {
                if (in_array($column, $this->ignore_seed_fields)) {
                    continue;
                }
                // Any child class can create a seed method, an example for modResource:
                // seedTemplate(1) and would return the string name
                $method = 'seed'.$this->makeStudyCase($column);
                if (method_exists($this, $method)) {
                    $value = $this->$method($value);
                }
                $this->blendable_xpdo_simple_object_data[$column] = $value;
            }

            $this->seedRelated($type);

            $data = [
                'columns' => $this->blendable_xpdo_simple_object_data,
                'primaryKeyHistory' => $this->unique_key_history,
                'related' => $this->related_data
            ];

        } elseif ($type == 'revert') {

            $data = [
                'columns' => false,
                'primaryKeyHistory' => [],
                'related' => []
            ];

            if ($this->isDebug()) {
                $this->blender->out('Data not found to make seed: '.$seed_key);
            }

        } elseif ($type == 'seed') {
            if ($this->isDebug()) {
                $this->blender->out('Data not found to make seed: '.$seed_key);
            }
        }

        // https://docs.modx.com/revolution/2.x/developing-in-modx/other-development-resources/class-reference/modx/modx.invokeevent
        $this->modx->invokeEvent(
            'OnBlendSeed',
            [
                'blender' => $this->blender,
                'blendable' => $this,
                'type' => $type,
                'xPDOClass' => $this->xpdo_simple_object_class,
                'xPDOSimpleObject' => &$this->xPDOSimpleObject,
                'data' => &$data

            ]
        );

        return $data;
    }

    /**
     * @param bool $overwrite
     *
     * @return bool
     */
    protected function save($overwrite = false)
    {
        $saved = false;

        if (is_object($this->xPDOSimpleObject)) {
            if (!$overwrite) {
                $this->error = true;
                $this->error_messages['exits'] = $this->xpdo_simple_object_class.': '.
                    $this->blendable_xpdo_simple_object_data[$this->unique_key_column].' already exists ';
                return $saved;
            }
        } else {
            $this->xPDOSimpleObject = $this->modx->newObject($this->xpdo_simple_object_class);
        }

        $this->xPDOSimpleObject->set($this->unique_key_column, $this->blendable_xpdo_simple_object_data[$this->unique_key_column]);

        foreach ($this->blendable_xpdo_simple_object_data as $column => $value) {
            // Any child class can create a convert method, an example for modResource:
            // convertTemplate('String name') and would return the numeric ID
            $method = 'convert'.$this->makeStudyCase($column);
            if (method_exists($this, $method)) {
                $value = $this->$method($value);
            }
            $this->xPDOSimpleObject->set($column, $value);
        }

        if (method_exists($this, 'getPropertiesData')) {
            $this->xPDOSimpleObject->set('properties', $this->getPropertiesData());
        }

        $this->attachRelatedPieces();

        if ($this->xPDOSimpleObject->save()) {
            $this->attachRelatedPiecesAfterSave();
            if ($this->isDebug()) {
                $this->blender->out($this->blendable_xpdo_simple_object_data[$this->unique_key_column].' has been installed/saved');
            }
            $saved = true;

        } else {
            if ($this->isDebug()) {
                $this->blender->out($this->blendable_xpdo_simple_object_data[$this->unique_key_column].' did not install/update', true);
                $this->blender->out($this->blendable_xpdo_simple_object_data[$this->unique_key_column].' did not install/update', /** @scrutinizer ignore-type */ true);
            }

        }

        return $saved;
    }

    protected function getUniqueCriteria()
    {
        return [
            $this->unique_key_column => $this->blendable_xpdo_simple_object_data[$this->unique_key_column]
        ];
    }

    /**
     * @param string|array $criteria
     */
    protected function setUniqueCriteria($criteria)
    {
        $this->blendable_xpdo_simple_object_data[$this->unique_key_column] = $criteria;
    }

    /**
     * Will load an existing xPDOSimpleObject if it exists, child class needs to class this one
     * @return $this
     */
    protected function loadObject()
    {
        $this->xPDOSimpleObject = $this->modx->getObject($this->xpdo_simple_object_class, $this->getUniqueCriteria());

        if (is_object($this->xPDOSimpleObject)) {
            $this->exists = true;
            $this->current_xpdo_simple_object_data = $this->xPDOSimpleObject->toArray();
            $this->loadFromArray($this->current_xpdo_simple_object_data);
            // load related data:
            $this->loadRelatedData();
        }

        return $this;
    }

    /**
     * @param array $data ~ convert the db data object to blend portable data
     *
     * @return $this
     */
    protected function loadFromArray($data = [])
    {
        foreach ($data as $column => $value) {
            $method_name = 'seed'.$this->makeStudyCase($column);

            if (method_exists($this, $method_name) && !is_null($value)) {
                if ($this->isDebug()) {
                    $this->blender->out(__METHOD__.' call: '.$method_name.' V: '.$value);
                }
                $value = $this->$method_name($value);
            }

            $method_name = 'setField'.$this->makeStudyCase($column);

            if (isset($this->load_from_array_aliases[$method_name])) {
                $method_name = $this->load_from_array_aliases[$method_name];

                if (!$method_name) {
                    continue;
                }
            }

            if (method_exists($this, $method_name) && !is_null($value)) {
                if ($this->isDebug()) {
                    $this->blender->out(__METHOD__.' call: '.$method_name.' V: '.$value);
                }
                $this->$method_name($value);
                
            } elseif ($this->isDebug()) {
                $this->blender->out(__METHOD__.' missing: '.$method_name.' V: '.print_r($value, true), true);
                $this->blender->out(__METHOD__.' missing: '.$method_name.' V: '.print_r($value, true), /** @scrutinizer ignore-type */ true);
            }
        }

        return $this;
    }

    /**
     * Override in child classes
     */
    protected function loadRelatedData()
    {
        $this->modx->invokeEvent(
            'OnBlendLoadRelatedData',
            [
                'blender' => $this->blender,
                'blendable' => $this,
                'data' => &$this->blendable_xpdo_simple_object_data,
                'type' => $this->type,
                'xPDOClass' => $this->xpdo_simple_object_class,
                'xPDOSimpleObject' => &$this->xPDOSimpleObject
            ]
        );
    }

    /**
     * @param string $seed_key
     *
     * @return bool|array
     * @throws BlendableException
     */
    protected function loadObjectDataFromSeed($seed_key)
    {
        $data = $this->modx->cacheManager->get($seed_key, $this->seedCacheOptions);
        if ($data == false) {
            if ($this->type == 'blend') {
                $this->blender->outError('Error: Seed could not be found: '.$seed_key);
                throw new BlendableException('Error: Seed could not be found: '.$seed_key);
            }

        } else {
            $this->blendable_xpdo_simple_object_data = $data['columns'];
            $this->unique_key_history = $data['primaryKeyHistory'];
            $this->related_data = $data['related'];
        }

        return $data;
    }

    /**
     * @param string $seed_key
     * @return mixed
     */
    protected function loadObjectDataFromHistorySeed($seed_key)
    {
        $data = $this->modx->cacheManager->get($seed_key, $this->historyCacheOptions);

        if (is_array($data)) {
            $this->blendable_xpdo_simple_object_data = $data['columns'];
            $this->unique_key_history = $data['primaryKeyHistory'];
            $this->related_data = $data['related'];
        }

        return $data;
    }

    /**
     * @param string $name
     * @return string
     */
    protected function makeStudyCase($name)
    {
        if ($name == 'templatename') {
            $name = 'templateName';
        }

        $StudyName = '';
        $parts = explode('_', $name);
        foreach ($parts as $part) {
            $StudyName .= ucfirst($part);
        }

        return $StudyName;
    }

    /**
     * This method is called just before blend/save()
     */
    protected function attachRelatedPieces()
    {

    }

    /**
     * This method is called just after a successful blend/save()
     */
    protected function attachRelatedPiecesAfterSave()
    {

    }

    /**
     *
     */
    protected function onDeleteRevertRelatedPieces()
    {

    }

    /**
     * @var string $type blend or revert
     */
    protected function seedRelated($type = 'blend')
    {
        // load related data:
        $this->loadRelatedData();

    }

    /**
     * @return array
     */
    public function getRelatedData()
    {
        return $this->related_data;
    }

    /**
     * @param array $data
     *
     * @return $this
     */
    public function setRelatedData($data)
    {
        $this->related_data = $data;
        return $this;
    }

}
LippertComponents / Blend

Push — master ( 7c77cf...a1eff0 )

Blendable::makeHistory() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
