<?php
/*
 * PSX is an open source PHP framework to develop RESTful APIs.
 * For the current version and information visit <https://phpsx.org>
 *
 * Copyright 2010-2022 Christoph Kappestein <christoph.kappestein@gmail.com>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace PSX\Schema\Generator\Code;

use PSX\Schema\Type\TypeAbstract;
use PSX\Schema\TypeInterface;

/**
 * Property
 *
 * @author  Christoph Kappestein <christoph.kappestein@gmail.com>
 * @license http://www.apache.org/licenses/LICENSE-2.0
 * @link    https://phpsx.org
 */
class Property
{
    /**
     * @var string
     */
    private $name;

    /**
     * @var string
     */
    private $type;

    /**
     * @var string
     */
    private $docType;

    /**
     * @var bool
     */
    private $required;

    /**
     * @var TypeInterface
     */
    private $origin;

    public function __construct(string $name, string $type, string $docType, bool $required, TypeInterface $origin)
    {
        $this->name = $name;
        $this->type = $type;
        $this->docType = $docType;
        $this->required = $required;
        $this->origin = $origin;
    }

    /**
     * @return string
     */
    public function getName(): string
    {
        return $this->name;
    }
    
    /**
     * @return string
     */
    public function getType(): string
    {
        return $this->type;
    }

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

    /**
     * @return bool
     */
    public function isRequired(): bool
    {
        return $this->required;
    }

    /**
     * @return string
     */
    public function getComment(): ?string
    {
        return $this->origin instanceof TypeAbstract ? $this->origin->getDescription() : null;
    }

    /**
     * @return bool
     */
    public function isNullable(): ?bool
    {
        return $this->origin instanceof TypeAbstract ? $this->origin->isNullable() : null;
    }

    /**
     * @return bool
     */
    public function isDeprecated(): ?bool
    {
        return $this->origin instanceof TypeAbstract ? $this->origin->isDeprecated() : null;
    }

    /**
     * @return bool
     */
    public function isReadonly(): ?bool
    {
        return $this->origin instanceof TypeAbstract ? $this->origin->isReadonly() : null;
    }

    /**
     * @return TypeInterface
     */
    public function getOrigin(): TypeInterface
    {
        return $this->origin;
    }
}
