DevGroup-ru / dotplant2

application/behaviors/Tree.php

<?php

namespace app\behaviors;

use app\modules\shop\models\Category;
use Yii;
use yii\helpers\ArrayHelper;
use yii\base\Behavior;
use yii\caching\TagDependency;
use yii\db\ActiveRecord;

/**
 * Class Tree
 * @package app\behaviors
 * @property \yii\db\ActiveRecord $owner
 * @property \yii\db\ActiveRecord[] $children
 * @property \yii\db\ActiveRecord $parent
 */
class Tree extends Behavior
{
    public $idAttribute = 'id';
    public $parentIdAttribute = 'parent_id';
    public $sortOrder = ['id' => SORT_ASC];
    public $cascadeDeleting = false; // @todo Set default value equals true and check all models that use Tree behavior
    public $activeAttribute = 'active';

    /**
     * @return ActiveRecord
     */
    public function getParent()
    {
        $cacheKey = 'TreeParent:' . $this->owner->className() . ':' . $this->owner->getAttribute($this->idAttribute);

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

        /** @var $parent ActiveRecord */
        $parent = Yii::$app->cache->get($cacheKey);
        if ($parent === false) {
            $className = $this->owner->className();

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

            $parent = new $className;
            $parent_id = $this->owner->getAttribute($this->parentIdAttribute);
            if ($parent_id < 1) {
                return null;
            }
            /* findById does not have a calling standard and uses different parameters. For example isActive = 1.
             * But we must get a parent model by primary id only.
             * Uncomment this code if you unify findById method.
             */
            // if ($parent->hasMethod('findById')) {
            //     $parent = $parent->findById($parent_id);
            // } else {
            if ($parent instanceof Category) {
                $parent = Category::findById($parent_id, null);
            } else {

                $parent = $parent->findOne($parent_id);
            }
            Yii::$app->cache->set(
                $cacheKey,
                $parent,
                86400,
                new TagDependency(
                    [
                        'tags' => [
                            \devgroup\TagDependencyHelper\ActiveRecordHelper::getCommonTag($className),
                        ]
                    ]
                )
            );

        }
        return $parent;
    }

    /**
     * @return ActiveRecord[]
     */
    public function getChildren()
    {
        $cacheKey = 'TreeChildren:' . $this->owner->className() . ':' . $this->owner->{$this->idAttribute};

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

        $children = Yii::$app->cache->get($cacheKey);
        if ($children === false) {
            /** @var $className ActiveRecord */
            $className = $this->owner->className();

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

            $children = $className::find()
                ->where([$this->parentIdAttribute => $this->owner->{$this->idAttribute}])
                ->orderBy($this->sortOrder);
            if ($this->activeAttribute !== false) {
                $children = $children->andWhere([$this->activeAttribute => 1]);
            }
            $children = $children->all();
            Yii::$app->cache->set(
                $cacheKey,
                $children,
                86400,
                new TagDependency(
                    [
                        'tags' => [
                            \devgroup\TagDependencyHelper\ActiveRecordHelper::getCommonTag($className),
                        ]
                    ]
                )
            );
        }
        return $children;
    }

    /**
     * Helper function - converts 2D-array of rows from db to tree hierarchy for use in Menu widget sorted by parent_id ASC.
     *
     * Attributes needed for use with \yii\widgets\Menu:
     * - name
     * - route or url - if empty, then url attribute of menu item will be unset!
     * - rbac_check _optional_ - will be used to determine if this menu item is allowed to user in rbac
     * - parent_id, id - for hierarchy
     *
     * Optional attributes needed for use with \app\backend\widgets\Menu:
     * - icon
     * - class or css_class
     * - translation_category - if exists and is set then the name will be translated with `Yii::t($item['translation_category'], $item['name'])`
     *
     * For example use see \app\backend\models\BackendMenu::getAllMenu()
     *
     * @param  array  $rows Array of rows. Example query: `$rows = static::find()->orderBy('parent_id ASC, sort_order ASC')->asArray()->all();`
     * @param  integer $start_index Start index of array to go through
     * @param  integer $current_parent_id ID of current parent
     * @param  boolean $native_menu_mode  Use output for \yii\widgets\Menu
     * @return array Tree suitable for 'items' attribute in Menu widget
     */
    public static function rowsArrayToMenuTree($rows, $start_index = 0, $current_parent_id = 0, $native_menu_mode = true)
    {
        $index = $start_index;
        $tree = [];

        while (isset($rows[$index]) === true && $rows[$index]['parent_id'] <= $current_parent_id) {
            if ($rows[$index]['parent_id'] != $current_parent_id) {
                $index++;
                continue;
            }
            $item = $rows[$index];

            $url = isset($item['route']) ? $item['route'] : $item['url'];

            $tree_item = [
                'label' => $item['name'],
                'url' => preg_match("#^(/|https?://)#Usi", $url) ? $url : ['/'.$url],
            ];
            if (empty($url)) {
                unset($tree_item['url']);
            }

            if (array_key_exists('rbac_check', $item)) {
                $tree_item['visible'] = Yii::$app->user->can($item['rbac_check']);
            }

            if ($native_menu_mode === false) {
                $attributes_to_check = ['icon', 'class'];
                foreach ($attributes_to_check as $attribute) {
                    if (array_key_exists($attribute, $item)) {
                        $tree_item[$attribute] = $item[$attribute];
                    }
                }
                if (array_key_exists('css_class', $item)) {
                    $tree_item['class']  = $item['css_class'];
                }

                // translate if translation_category is available
                if (array_key_exists('translation_category', $item)) {
                    $tree_item['label'] = Yii::t($item['translation_category'], $item['name']);
                }
            }
            $index++;
            $tree_item['items'] = static::rowsArrayToMenuTree($rows, $index, $item['id'], $native_menu_mode);

            if (empty($tree_item['visible']) && in_array(true, ArrayHelper::getColumn($tree_item['items'], 'visible'))) {
                $tree_item['visible'] = true;
            }
            $tree[] = $tree_item;
        }
        return $tree;
    }

    /**
     * @inheritdoc
     */
    public function events()
    {
        return [
            ActiveRecord::EVENT_AFTER_DELETE => 'afterDelete',
        ];
    }

    /**
     * After delete event.
     * It deletes children models.
     * @param $event
     * @throws \Exception
     */
    public function afterDelete($event)

The parameter $event is not used and could be removed.

    {
        if ($this->cascadeDeleting) {
            foreach ($this->children as $child) {
                $child->delete();
            }
        }
    }
}