luyadev/luya-module-admin

<?php

namespace luya\admin\aws;

use luya\admin\models\StorageFile;
use luya\admin\models\Tag;
use luya\admin\models\TagRelation;
use luya\admin\Module;
use luya\admin\ngrest\base\ActiveWindow;

/**
 * Create an Active Window where you can assign tags to a row of the underlying table via a ref table.
 *
 * Use $alias to define the headline in the Active Window
 *
 * Usage example of registering the Tag Active Window:
 *
 * ```php
 * public function ngRestActiveWindows()
 * {
 *     return [
 *          ['class' => TaggableActiveWindow::class]
 *     ];
 * }
 * ```
 *
 * If you have assigned the {{luya\admin\aws\TaggableActiveWindow}} aws to an ngrest model you can use the {{luya\admin\traits\TaggableTrait}} to access the data.
 *
 * For example when the {{luya\admin\traits\TaggableTrait}} is used you can get the data for an active record:
 *
 * ```php
 * $tags = Model::findOne(1)->tags;
 * ```
 *
 * or you can also get all tags assigned for this table:
 *
 * ```php
 * $allTags = Model::findTags();
 * ```
 *
 * @property string $tableName Define a table name if not automaticaly alocated from model.
 *
 * @author Basil Suter <basil@nadar.io>
 * @since 1.2.2
 */
class TaggableActiveWindow extends ActiveWindow
{
    /**
     * @var string The name of the module where the ActiveWindow is located in order to find the view path.
     */
    public $module = '@admin';

    /**
     * When removing Tag Active Window in 2.0 this can be removed.
     */
    public function getViewFolderName()
    {
        return 'taggable';
    }

    private $_tableName;

    /**
     * Getter tableName.
     *
     * @return string
     */
    public function getTableName()
    {
        if ($this->_tableName === null) {
            $this->_tableName = $this->model->tableName();
        }

        return $this->_tableName;
    }

    /**
     * Setter tableName.
     *
     * @param string $tableName
     */
    public function setTableName($tableName)
    {
        $this->_tableName = $tableName;
    }

    /**
     * The default action which is going to be requested when clicking the ActiveWindow.
     *
     * @return string The response string, render and displayed trough the angular ajax request.
     */
    public function index()
    {
        return $this->render('index');
    }

    /**
     * @inheritdoc
     */
    public function defaultLabel()
    {
        return Module::t('menu_system_item_tags');
    }

    /**
     * @inheritdoc
     */
    public function defaultIcon()
    {
        return 'tag';
    }

    /**
     * Get all tags
     *
     * @return array
     */
    public function callbackLoadTags()
    {
        return Tag::find()->asArray()->all();
    }

    /**
     * Get only tags for the current record.
     *
     * @return array|\yii\db\ActiveRecord[]
     */
    public function callbackLoadRelations()
    {
        return TagRelation::find()->where(['table_name' => StorageFile::cleanBaseTableName($this->tableName), 'pk_id' => $this->getItemId()])->asArray()->all();
    }

    /**
     * Save or delete a given tag id from the list of tags.
     *
     * @param integer $tagId The id of the tag.
     * @return number
     */
    public function callbackSaveRelation($tagId)
    {
        $find = TagRelation::find()->where(['tag_id' => $tagId, 'table_name' => StorageFile::cleanBaseTableName($this->tableName), 'pk_id' => $this->getItemId()])->one();

        if ($find) {
            TagRelation::deleteAll(['tag_id' => $tagId, 'table_name' => StorageFile::cleanBaseTableName($this->tableName), 'pk_id' => $this->getItemId()]);
            return 0;
        } else {
            $model = new TagRelation();
            $model->setAttributes([
                'tag_id' => $tagId,
                'table_name' => StorageFile::cleanBaseTableName($this->tableName),
                'pk_id' => $this->getItemId(),
            ]);
            $model->insert(false);
            return 1;
        }
    }

    /**
     * Save new tag to the list of tags.
     *
     * @param string $tagName
     * @return boolean|number
     */
    public function callbackSaveTag($tagName)
    {
        $model = Tag::find()->where(['name' => $tagName])->exists();

        if ($model) {
            return false;
        }

        $model = new Tag();
        $model->name = $tagName;
        $model->save();

        return $model->id;
    }
}