<?php
declare(strict_types=1);

/**
 * BEdita, API-first content management framework
 * Copyright 2019 ChannelWeb Srl, Chialab Srl
 *
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * See LICENSE.LGPL or <http://gnu.org/licenses/lgpl-3.0.html> for more details.
 */

namespace BEdita\Core\Model\Entity;

use BEdita\Core\Utility\JsonApiSerializable;
use Cake\Datasource\Exception\RecordNotFoundException;
use Cake\ORM\Entity;
use Cake\Utility\Hash;

/**
 * Category Entity
 *
 * @property int $id
 * @property int|null $object_type_id
 * @property string $name
 * @property array|null $labels
 * @property int|null $parent_id
 * @property int|null $tree_left
 * @property int|null $tree_right
 * @property bool $enabled
 * @property \Cake\I18n\Time $created
 * @property \Cake\I18n\Time $modified
 *
 * @property \BEdita\Core\Model\Entity\ObjectType $object_type
 * @property \BEdita\Core\Model\Entity\Category $parent_category
 * @property \BEdita\Core\Model\Entity\Category[] $child_categories
 * @property \BEdita\Core\Model\Entity\ObjectCategory[] $object_categories
 */
class Category extends Entity implements JsonApiSerializable
{
    use JsonApiModelTrait;
    use ObjectTypeNameTrait;

    /**
     * @inheritDoc
     */
    protected $_accessible = [
        '*' => true,
        'created' => false,
        'modified' => false,
    ];

    /**
     * @inheritDoc
     */
    protected $_hidden = [
        'object_type_id',
        'object_type',
        '_joinData',
        'object',
        'parent',
    ];

    /**
     * @inheritDoc
     */
    protected $_virtual = [
        'label',
        'object_type_name',
        'object',
        'parent',
    ];

    /**
     * Getter for `object` virtual property.
     *
     * @return string|null
     */
    protected function _getObject(): ?string
    {
        return $this->_getObjectTypeName();
    }

    /**
     * Setter for `object` virtual property.
     *
     * @param string $object Object type name.
     * @return string|null
     */
    protected function _setObject(string $object): ?string
    {
        return $this->_setObjectTypeName($object);
    }

    /**
     * Getter for `parent` virtual property.
     *
     * @return string|null
     */
    protected function _getParent(): ?string
    {
        if (empty($this->parent_id)) {
            return null;
        }
        if (empty($this->parent_category)) {
            try {
                $this->parent_category = $this->getTable()->get($this->parent_id);
            } catch (RecordNotFoundException $e) {
                return null;
            }
        }

        return $this->parent_category->name;
    }

    /**
     * Setter for `parent` virtual property.
     *
     * @param string|null $parentName Parent category name.
     * @return string|null
     */
    protected function _setParent(?string $parentName): ?string
    {
        if (empty($parentName)) {
            $this->parent_category = null;
            $this->parent_id = null;

            return null;
        }

        try {
            $this->parent_category = $this->getTable()->find()
                ->where([
                    'name' => $parentName,
                    'object_type_id' => $this->object_type_id,
                ])
                ->firstOrFail();
            $this->parent_id = $this->parent_category->id;
        } catch (RecordNotFoundException $e) {
            $this->parent_category = null;
            $this->parent_id = null;

            return null;
        }

        return $this->parent_category->name;
    }

    /**
     * Getter for `label` virtual property.
     *
     * @return string|null
     */
    protected function _getLabel(): ?string
    {
        $label = (string)Hash::get((array)$this->labels, 'default');

        return empty($label) ? null : $label;
    }

    /**
     * Setter for `label` virtual property.
     *
     * @param string $label Label to set.
     * @return void
     */
    protected function _setLabel(string $label): void
    {
        $this->labels = array_merge((array)$this->labels, ['default' => $label]);
    }
}
