lovata/oc-toolbox-plugin

<?php namespace Lovata\Toolbox\Classes\Event;

use Lovata\Toolbox\Classes\Store\AbstractStoreWithoutParam;
use Lovata\Toolbox\Classes\Store\AbstractStoreWithParam;
use Lovata\Toolbox\Classes\Store\AbstractStoreWithTwoParam;

/**
 * Class ModelHandler
 * @package Lovata\Toolbox\Classes\Event
 * @author Andrey Kharanenka, a.khoronenko@lovata.com, LOVATA Group
 */
abstract class ModelHandler
{
    protected $iPriority = 1000;
    /** @var  \Model */
    protected $obElement;

    protected $obListStore;

    protected $bWithRestore = false;
    protected $sIdentifierField = 'id';

    /**
     * Add listeners
     * @param \Illuminate\Events\Dispatcher $obEvent
     */
    public function subscribe($obEvent)
    {
        $sModelClass = $this->getModelClass();
        $sModelClass::extend(function ($obElement) {

            /** @var \Model $obElement */
            $obElement->bindEvent('model.afterCreate', function () use ($obElement) {
                $this->obElement = $obElement;
                $this->init();
                $this->afterCreate();
            }, $this->iPriority);

            /** @var \Model $obElement */
            $obElement->bindEvent('model.afterSave', function () use ($obElement) {
                $this->obElement = $obElement;
                $this->init();
                $this->afterSave();
            }, $this->iPriority);

            /** @var \Model $obElement */
            $obElement->bindEvent('model.afterDelete', function () use ($obElement) {
                $this->obElement = $obElement;
                $this->init();
                $this->afterDelete();
            }, $this->iPriority);

            if ($this->bWithRestore) {
                /** @var \Model $obElement */
                $obElement->bindEvent('model.afterRestore', function () use ($obElement) {
                    $this->obElement = $obElement;
                    $this->init();
                    $this->afterRestore();
                }, $this->iPriority);
            }
        });
    }

    /**
     * Get model class name
     * @return string
     */
    abstract protected function getModelClass();

    /**
     * Get item class name
     * @return string
     */
    abstract protected function getItemClass();

    /**
     * Init store objects
     */
    protected function init()
    {
    }

    /**
     * After create event handler
     */
    protected function afterCreate()
    {
    }

    /**
     * After save event handler
     */
    protected function afterSave()
    {
        $this->clearItemCache();
    }

    /**
     * After delete event handler
     */
    protected function afterDelete()
    {
        $this->clearItemCache();
    }

    /**
     * After restore event handler
     */
    protected function afterRestore()
    {
    }

    /**
     * Clear item cache
     */
    protected function clearItemCache()
    {
        $sItemClass = $this->getItemClass();
        $sField = $this->sIdentifierField;

        $sItemClass::clearCache($this->obElement->$sField);
    }

    /**
     * If field value was changed, then cache clear by value
     * @param string $sField
     * @param AbstractStoreWithParam|AbstractStoreWithoutParam $obListStore
     */
    protected function checkFieldChanges($sField, $obListStore)
    {
        if (empty($sField) || empty($obListStore) || !$this->isFieldChanged($sField)) {
            return;
        }

        if ($obListStore instanceof AbstractStoreWithoutParam) {
            $obListStore->clear();
        } elseif ($obListStore instanceof AbstractStoreWithParam) {
            $obListStore->clear($this->obElement->$sField);
            $obListStore->clear($this->obElement->getOriginal($sField));
        }
    }

    /**
     * If field has not empty value, then cache clear by value
     * @param string $sField
     * @param AbstractStoreWithParam|AbstractStoreWithoutParam $obListStore
     */
    protected function clearCacheNotEmptyValue($sField, $obListStore)
    {
        if (empty($sField) || empty($obListStore) || empty($this->obElement->$sField)) {
            return;
        }

        if ($obListStore instanceof AbstractStoreWithoutParam) {
            $obListStore->clear();
        } elseif ($obListStore instanceof AbstractStoreWithParam) {
            $obListStore->clear($this->obElement->$sField);
        }
    }

    /**
     * If field has empty value, then cache clear by value
     * @param string $sField
     * @param AbstractStoreWithoutParam $obListStore
     */
    protected function clearCacheEmptyValue($sField, $obListStore)
    {
        if (empty($sField) || empty($obListStore) || !empty($this->obElement->$sField) || ! $obListStore instanceof AbstractStoreWithoutParam) {
            return;
        }

        $obListStore->clear();
    }

    /**
     * If field value was changed, then cache clear by value
     * @param $sField
     * @param $sAdditionalField
     * @param AbstractStoreWithTwoParam $obListStore
     */
    protected function clearCacheNotEmptyTwoValue($sField, $sAdditionalField, $obListStore)
    {
        if (empty($sField) || empty($obListStore) || empty($this->obElement->$sField) || !$obListStore instanceof AbstractStoreWithTwoParam) {
            return;
        }

        $obListStore->clear($this->obElement->$sField);
        if (empty($this->obElement->$sAdditionalField)) {
            return;
        }

        $obListStore->clear($this->obElement->$sField, $this->obElement->$sAdditionalField);
    }

    /**
     * @param $sField
     * @param $sAdditionalField
     * @param AbstractStoreWithTwoParam $obListStore
     */
    protected function checkFieldChangesTwoParam($sField, $sAdditionalField, $obListStore)
    {
        if (empty($sField) || empty($sAdditionalField) || empty($obListStore) || !$obListStore instanceof AbstractStoreWithTwoParam) {
            return;
        }

        if (!$this->isFieldChanged($sField) && $this->isFieldChanged($sAdditionalField)) {
            return;
        }

        $obListStore->clear($this->obElement->$sField);
        $obListStore->clear($this->obElement->$sField, $this->obElement->$sAdditionalField);
        $obListStore->clear($this->obElement->$sField, $this->obElement->getOriginal($sField));

        $obListStore->clear($this->obElement->getOriginal($sField));
        $obListStore->clear($this->obElement->getOriginal($sField), $this->obElement->$sAdditionalField);
        $obListStore->clear($this->obElement->getOriginal($sField), $this->obElement->getOriginal($sField));
    }

    /**
     * Check: field value was change
     * @param string $sField
     * @return bool
     */
    protected function isFieldChanged($sField)
    {
        if (empty($sField)) {
            return false;
        }

        if ($this->obElement->$sField == $this->obElement->getOriginal($sField)) {
            return false;
        }

        return true;
    }
}