JsTree.php

<?php

/**
 * JsTree widget is a Yii2 wrapper for the jsTree jQuery plugin with extended
 * functions.
 *
 * @author Nils Menrad
 * @since 1.0
 * @see http://jstree.com
 */

namespace kasoft\jstree;

use Yii;
use yii\helpers\Html;
use yii\helpers\Json;
use yii\base\Widget;
use yii\web\View;
use yii\web\Response;
use yii\helpers\Url;
use kasoft\jstree\JsTreeAsset;

class JsTree extends Widget
{

    // Basic Settings Model/Column Names

    /*
     * @var object the yii2 active record model which should be used. set to false
     * if the tree should be build from a json url. note: only with a model, the
     * move, delete, sort, and create functions can be used
     */
    public $modelName = false;

    /*
     * @var string URL that will generate the needed json for buildung the tree.
     * Only needed when you DON'T set the modelName Property. Otherwise not needed.
     */
    public $jsonUrl = false;

    /*
     * @var int ID where the Tree should start loading stuff, can be NULL too
     */
    public $modelFirstParentId;

    /*
     * @var string Name of the PrimaryKey Column e.g. 'id'
     */
    public $modelPropertyId;

    /*
     * @var string Column Name of the Parent Key e.g. 'parent_id'
     */
    public $modelPropertyParentId;

    /*
     * @var string Column Name of the Title/Name e.g. 'title'
     */
    public $modelPropertyName;

    /*
     * @var string Column Name of the Position attribute e. g. 'position'
     */
    public $modelPropertyPosition;

    /*
     * @var string Column Name for a Type attribute. This can be used to give each
     * Tree item a different Type which will be used for displaying icons, prevent
     * creation of child elements, etc. See jsTree Docs for explanations.
     */
    public $modelPropertyType = NULL;

    /*
     * @var boolean Disables the ability to cascade deleting. User maybe delete
     * a Tree with mutltiple Elements by accident
     * !!! NOT IMPLEMENTED YET - Cascading is not possible !!!!!
     */
    public $noCascadingDelete = true;

    /*
     * @var array Allows to define different Types of Nodes wich can have restrictions
     * in creating child Elements or which have diffenet icons. See jsTree Docs for
     * more informations.
     */
    public $jstreeType = [];

    /*@var array Messages for Userinteractions which can be set to individual Text
     */
    public $jstreeMsg = NULL;

    /*
     * @var array Configuration for Context Menu. It is possible to choose which Elements
     * should apear in the Menu. Also you can set the Text and Icons of this Elements.
     * Create, Edit, Rename and Delete are possible. For Create it is possible to set up
     * a Submenu which create a Node with a specific Type (See $modelPropertyType)
     */
    public $jstreeContextMenue = [];


    /*
     * @var string Name of the Controller used for calling ajax actions.
     */
    public $controller;           // controller name for ajax call "cms"

    /*
     * @var string Name of the Action that should be called when node is clicked
     */
    public $action_click;

    /*
     * @var string Default Action for Tree (e.g. index)
     */
    public $action_default;

    public $jstreeIcons=NULL;

    public $jstreePlugins;
    /*
     * @var string ID oder Class of the JsTree Div
     * If not set, it will become #jstree
     */
    public $jstreeDiv;

    /*
     * With this state key, jstree sets a cookie to remember the state of the
     * tree (e.g. which bracnhes are open, etc.)
     */
    public $jstreestatekey;

    /**
     * @var array Configure which plugins will be active on an instance. Should be an array of strings, where each element is a plugin name.
     */
    public $plugins = ["checkbox"];

    /**
     * @var int Open the Node with this id (e.g. 33)
     */
    public $initialOpenId = false;

    // NOT IMPLEMENTED, DEVEPOLMENT
    public $showIcons;              // Show Type/Icons in Tree
    public $modelCondition;         // not implementes yet, additionl conditions
    public $modelAddCondition;      // not implementes yet, additionl conditions

    /**
     * @inheritdoc
     */

    public function init() {
        parent::init();
        $this->registerAssets();

        if (empty($this->jstreeDiv))
            $this->jstreeDiv  = "#jstree";

        if ($this->jstreeIcons===NULL)
            $this->jstreeIcons = true;

        if (empty($this->jstreePlugins)) {
            $this->jstreePlugins = [
                "contextmenu", "dnd", "search","state", "types", "wholerow", "changed"
            ];
        }


        $standardMsg = [
            "confirmdelete" => "Löschen? Sine Sie sicher?",
            "nothere" => "An dieser Stelle leider nicht möglich!",
            "itemnotexisting" => "Das Element existiert nicht!",
            "itemcantdel" => "Das Element kann nicht gelöscht werden!",
            "itemnodeletchildren" => "Das Element hat weitere Unterebenen und kann daher nicht gelöscht werden!",
            "newNode" => "New Entry"
        ];

        if(!empty($this->jstreeMsg))
            $this->jstreeMsg = array_merge($standardMsg,$this->jstreeMsg);
        else
            $this->jstreeMsg = $standardMsg;


        if(empty($this->jstreeContextMenue)) {
            $this->jstreeContextMenue = [
                "edit" => [
                    "text" => "Bearbeiten",
                    "icon" => "glyphicon glyphicon-pencil"
                ],
                "create" => [
                    "text" => "Neu",
                    "icon" => "glyphicon glyphicon-th-list"
                ],
                "rename" => [
                    "text" => "Umbenennen",
                    "icon" => "glyphicon glyphicon-transfer"
                ],
                "remove" => [
                    "text" => "Löschen",
                    "icon" => "glyphicon glyphicon-trash"
                ],
            ];
        }

        if (empty($this->jstreeType)) {
            $this->jstreeType = [
                "#" => [
                    "max_children" => -1,
                    "max_depth" => -1,
                    "valid_children" => -1,
                    "icon" => "glyphicon glyphicon-th-list"
                ],
                "default" => [
                    "max_children" => -1,
                    "max_depth" => -1,
                    "valid_children" => -1,
                    "icon" => "glyphicon glyphicon-list-alt"
                ],
                "online" => [
                    "max_children" => 0,
                    "max_depth" => 0,
                    "valid_children" => 0,
                    "icon" => "glyphicon glyphicon-ok-sign"
                ],
                "offline" => [
                    "max_children" => 0,
                    "max_depth" => 0,
                    "valid_children" => 0,
                    "icon" => "glyphicon glyphicon-minus-sign"
                ],
            ];
        }

        $this->getView()->registerJs("var jstreediv = '" . $this->jstreeDiv . "';", View::POS_HEAD);
        $this->getView()->registerJs("var jstreetype = " . Json::encode($this->jstreeType) . ";", View::POS_HEAD);
        $this->getView()->registerJs("var jstreeplugins = " . Json::encode($this->jstreePlugins) . ";", View::POS_HEAD);
        $this->getView()->registerJs("var jstreeicons = " . Json::encode($this->jstreeIcons) . ";", View::POS_HEAD);
        $this->getView()->registerJs("var jstreeContextMenue = " . Json::encode($this->jstreeContextMenue) . ";", View::POS_HEAD);
        $this->getView()->registerJs("var jstreeMsg = " . Json::encode($this->jstreeMsg) . ";", View::POS_HEAD);
        $this->getView()->registerJs("var initialOpenId = " . Json::encode($this->initialOpenId) . ";", View::POS_HEAD);


        // Use with ActiveRecord Model and all Actions
        if ($this->modelName) {

            $this->controller = Yii::$app->controller->id;

            if (empty($this->action_default))
                $this->action_default = "index";

            if (empty($this->action_click))
                $this->action_click = "update";

            // Create Needed URLs for JS
            // e.g. /index.php?r=site/index
            // or /site/index
            $baseUrl = Url::to();
            $this->getView()->registerJs("var url_default = '" . Url::to([$this->controller."/".$this->action_default]) . "';", View::POS_HEAD);
            $this->getView()->registerJs("var url_click = '" . Url::to([$this->controller."/".$this->action_click]) . "';", View::POS_HEAD);

            if(empty($this->jstreestatekey))
                $this->jstreestatekey = $this->controller;
            $this->getView()->registerJs("var jstreestatekey = " . Json::encode($this->jstreestatekey) . ";", View::POS_HEAD);

            if (!isset($this->showIcons))
                $this->showIcons = true;

            if (empty($this->modelPropertyName))
                $this->modelPropertyName = "name";

            if (empty($this->modelPropertyId))
                $this->modelPropertyId = "id";

            if (empty($this->modelPropertyParentId))
                $this->modelPropertyParentId = "parent_id";

            if (empty($this->modelPropertyPosition))
                $this->modelPropertyPosition = "sort";

            if (empty($this->modelPropertyType))
                $this->modelPropertyType = "type";

            // Only Display Tree with loading Data via JSON URL
        } else {
            $this->getView()->registerJs("var jsonurl = '" . $this->jsonUrl . "';", View::POS_HEAD);
        }

        if (isset($_REQUEST["easytree"])) {
            $this->treeaction();
        }

    }

    public function run() {
        parent::run();
    }

    /**
     * Registers the needed assets
     */
    public function registerAssets() {
        $view = $this->getView();
        JsTreeAsset::register($view);
    }


    // AJAX call for
    // -> load: return full json for tree init
    // -> move: change parent id and position of node
    /*
     * Handelns Ajax calls of different Operations
     * fulljson: return full json for tree init
     * create: create new node
     * rename: change the name of the node
     * position: move the node, change parent id and position of node
     * delete: delete node
     */
    public function treeaction() {

        if (isset($_REQUEST["easytree"])) {
            $operation = $_REQUEST["easytree"];
            if ($operation == "fulljson")
               self::sendJSON(self::treeChildren($this->modelName, $this->modelFirstParentId));
            if ($operation == "move") {
                $modelName = $this->modelName;
                $model = $modelName::findOne($_POST["id"]);
                if ($model) {
                    $model->{$this->modelPropertyParentId} = $_POST["parent"];
                    $model->{$this->modelPropertyPosition} = $_POST["position"];

                    // find all in the same node but without already re-orderd item
                    $sort = $modelName::find()
                            ->where([$this->modelPropertyParentId => $_POST["parent"]])
                            ->andWhere(['!=', $this->modelPropertyId, $_POST["id"]])
                            ->orderBy($this->modelPropertyPosition)
                            ->all();

                    // If moved to top
                    if ($_POST["position"] != 0)
                        $pos = 0;
                    else
                        $pos = 1;

                    foreach ($sort as $s) {
                        if ($pos == $_POST["position"])
                            $pos++;
                        $s->{$this->modelPropertyPosition} = $pos;
                        $s->save();
                        $pos++;
                    }

                    if ($model->save())
                        self::sendJSON(array('status' => 1));
                }
            }
            if ($operation == "create") {

                $modelName = $this->modelName;
                $model = new $modelName;

                if (!empty($_POST["duplicate"])) {
                    $duplicate_model = $modelName::findOne($_POST["duplicate"]);
                    $model->attributes = $duplicate_model->attributes;
                }

                $model->{$this->modelPropertyParentId} = $_POST["parent"];
                $model->{$this->modelPropertyPosition} = $_POST["position"];
                if (!empty($this->modelPropertyType) && !empty($_POST["type"]))
                    $model->{$this->modelPropertyType} = $_POST["type"];

                if (!empty($this->modelPropertyName) && !empty($_POST["text"]))
                    $model->{$this->modelPropertyName} = $_POST["text"];
                else
                    $model->{$this->modelPropertyName} = $this->jstreeMsg["newNode"]??"New Entry";

                if ($model->save())
                    self::sendJSON(array('status' => 1, 'id' => $model->{$this->modelPropertyId}));
                else {
                    $err_txt = "";
                    foreach($model->errors as $err) {
                        $err_txt.=$err[0];
                    }
                    self::sendJSON(array('status' => 0, 'err_msg' => $err_txt));
                }
            }
            if ($operation == "rename") {
                $modelName = $this->modelName;
                $model = $modelName::findOne($_POST["id"]);
                $model->{$this->modelPropertyName} = $_POST["text"];
                if ($model->save())
                    self::sendJSON(array('status' => 1));
                else
                    print_r($model->getErrors());
            }
            if ($operation == "delete") {
                // check for children
                $check = self::treeChildren($this->modelName, $_POST["id"]);
                if (empty($check)) {
                    $modelName = $this->modelName;
                    $model = $modelName::findOne($_POST["id"]);
                    if (!$model) {
                        self::sendJSON(array('status' => 0, 'error' => $this->jstreeMsg['itemnotexisting']??""));
                    }
                    else {
                        if ($model->delete()) {
                            self::sendJSON(array('status' => 1));
                        }
                        else {
                            self::sendJSON(array('status' => 0, 'error' => $this->jstreeMsg['itemcantdel']??""));
                        }
                    }
                }
                else {
                    self::sendJSON(array('status' => 0, 'error' => $this->jstreeMsg['itemnodeletchildren']??""));
                }
            }
        }
        else {
            return false;
        }
    }

    /*
     * Load Childitems of tree
     */

    public function treeChildren($modelName, $parent_id = NULL) {
        $models = $modelName::find()
                ->where([$this->modelPropertyParentId => $parent_id])
                ->orderBy($this->modelPropertyPosition)
                ->all();

        $data = [];
        foreach ($models as $item) {
            $name = $item->{$this->modelPropertyName};

            //if tree entry id is top id, set parent to null
            if ($item->{$this->modelPropertyParentId} == $this->modelFirstParentId)
                $parent = "#";
            else
                $parent = "id" . $item->{$this->modelPropertyParentId};

            $type = $item->{$this->modelPropertyType}??"default";

            $data[] = ['id' => "id" . $item->{$this->modelPropertyId}, 'parent' => $parent, 'type' => $type, 'text' => $name];
            $mixin = self::treeChildren($modelName, $item->{$this->modelPropertyId});
            if (!empty($mixin))
                $data = array_merge($data, $mixin);
        }
        return $data;
    }

    static function sendJSON($json) {
        header("HTTP/1.0 200 OK");
        header('Content-type: text/json; charset=utf-8');
        header("Cache-Control: no-cache, must-revalidate");
        header("Pragma: no-cache");
        echo json_encode($json);
        die();
    }

}

?>