luyadev/luya-module-admin

<?php

namespace luya\admin\folder;

use luya\admin\storage\ItemAbstract;
use Yii;

/**
 * Storage Folder Item.
 *
 * @property integer $id The unique folder id.
 * @property string $name The name of the Folder.
 * @property integer $parentId The id of the parent folder.
 * @property integer filesCount The number of files inside the folder.
 *
 * @author Basil Suter <basil@nadar.io>
 * @since 1.0.0
 */
class Item extends ItemAbstract
{
    /**
     * The unique folder id.
     *
     * @return integer The folder ID.
     */
    public function getId()
    {
        return (int) $this->getKey('id');
    }

    /**
     * The name of the Folder.
     *
     * @return string Returns the name of the Folder.
     */
    public function getName()
    {
        return $this->getKey('name');
    }

    /**
     * The parent folder Id.
     *
     * If not parent folder exists the value is `0`.
     *
     * @return integer The parent folders id, 0 if no parent exists.
     */
    public function getParentId()
    {
        return (int) $this->getKey('parent_id');
    }

    /**
     * Whether the current folder has a parent or not.
     *
     * @return boolean Whether a parent folder exists or is root node (false).
     */
    public function hasParent()
    {
        return !empty($this->getParentId());
    }

    /**
     * Whether the current folder has at least one child folder.
     *
     * @return boolean Whether a child folder exists or not.
     */
    public function hasChild()
    {
        return ((new \luya\admin\folder\Query())->where(['is_deleted' => 0, 'parent_id' => $this->getId()])->count() > 0 ? true : false);
    }

    /**
     * Get the parent folder object.
     *
     * @return boolean|\luya\admin\folder\Item The item object or false if not found.
     */
    public function getParent()
    {
        return (!empty($this->getParentId())) ? Yii::$app->storage->getFolder($this->getParentId()) : false;
    }

    /**
     * The number of files inside the Current Folder.
     * @return integer
     */
    public function getFilesCount()
    {
        return (int) $this->getKey('filesCount');
    }

    /**
     * @inheritdoc
     */
    public function fields()
    {
        return ['id', 'name', 'parentId', 'filesCount'];
    }
}