Railt\SDL\Base\Definitions\BaseDefinition

Complexity

Total Complexity

13

Size/Duplication

Total Lines	139
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

73.32%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	getDocument()	0	4	1
A	__toString()	0	4	1
A	__debugInfo()	0	4	1
A	jsonSerialize()	0	11	2
A	__sleep()	0	15	1
A	getName()	0	8	1
A	getDescription()	0	4	1
A	getUniqueId()	0	8	2
A	getFileName()	0	4	1
A	getDeclarationLine()	0	4	1
A	getDeclarationColumn()	0	4	1

<?php
/**
 * This file is part of Railt package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
declare(strict_types=1);

namespace Railt\SDL\Base\Definitions;

use Railt\SDL\Base\Behavior\BaseDeprecations;
use Railt\SDL\Contracts\Definitions\Definition;
use Railt\SDL\Contracts\Document;
use Railt\SDL\Support;

/**
 * Class BaseTypeDefinition
 */
abstract class BaseDefinition implements Definition, \JsonSerializable
{
    use Support;
    use BaseDeprecations;

    /**
     * @var string
     */
    protected $name;

    /**
     * @var string
     */
    protected $description = '';

    /**
     * @var string|null
     */
    protected $id;

    /**
     * @var Document
     */
    protected $document;

    /**
     * @return Document
     */
    public function getDocument(): Document
    {
        return $this->document;
    }

    /**
     * @return string
     */
    public function __toString(): string
    {
        return $this->typeToString($this);
    }

    /**
     * @return array
     */
    public function __debugInfo(): array
    {
        return $this->jsonSerialize();
    }

    /**
     * @return array
     */
    public function jsonSerialize(): array
    {
        $data   = $this->__sleep();
        $result = [];

        foreach ($data as $fieldName) {
            $result[$fieldName] = $this->valueToScalar($this->$fieldName);
        }

        return $result;
    }

    /**
     * @return array
     */
    public function __sleep(): array
    {
        return [
            // Self
            'id',
            'document',

            // interface Nameable
            'name',
            'description',

            // trait BaseDeprecations
            'deprecationReason',
        ];
    }

    /**
     * @return string
     */
    public function getName(): string
    {
        \assert($this->name !== null, \vsprintf('Name of %s must be initialized.', [
            \get_class($this),
        ]));

        return (string)$this->name;
    }

    /**
     * @return string
     */
    public function getDescription(): string
    {
        return (string)$this->description;
    }

    /**
     * @return string
     */
    public function getUniqueId(): string
    {
        if ($this->id === null) {
            $this->id = \spl_object_hash($this);
        }

        return $this->id;
    }

    /**
     * @return string
     */
    public function getFileName(): string
    {
        return $this->getDocument()->getFileName();
    }

    /**
     * @return int
     */
    public function getDeclarationLine(): int
    {
        return 0;
    }

    /**
     * @return int
     */
    public function getDeclarationColumn(): int
    {
        return 0;
    }
}