yoanm / php-jsonrpc-server-doc-sdk

src/Model/JsonRpcParamDocBackup.php

<?php
namespace Yoanm\JsonRpcServerDoc\Model;

/**
 * Class JsonRpcParamDoc
 */
class JsonRpcParamDocBackup
{
    const TYPE_SCALAR = 'scalar';
    const TYPE_STRING = 'string';
    const TYPE_BOOL = 'bool';
    const TYPE_FLOAT = 'float';
    const TYPE_INT = 'int';
    const TYPE_ARRAY = 'array';
    const TYPE_OBJECT = 'object';

    public static $allowedTypeList = [
        self::TYPE_SCALAR,
        self::TYPE_STRING,
        self::TYPE_BOOL,
        self::TYPE_FLOAT,
        self::TYPE_INT,
        self::TYPE_ARRAY,
        self::TYPE_OBJECT,
    ];

    /** @var null|string|integer */
    private $name = null;
    /** @var null|string */
    private $type;

    /** @var bool */
    private $required = false;
    /** @var null|bool */
    private $nullable = null;

    /** @var null|bool */
    private $blankAllowed = null;
    /** @var null|string */
    private $format = null;


    /** @var JsonRpcParamDoc[] */
    private $validItemList = [];
    /** @var bool */
    private $allOfValidItemList = false;

    /** @var JsonRpcParamDoc[] */
    private $siblingList = [];
    /** @var bool */
    private $allowExtraSibling = true;
    /** @var bool */
    private $allowMissingSibling = true;



    /** @var null|mixed */
    private $expectedValue;

    /**
     * @param bool|false $isRoot
     */
    public function __construct(bool $isRoot = false)
    {
        $this->isRoot = $isRoot;

The property isRoot does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }

    /**
     * @param string|null $type
     *
     * @return JsonRpcParamDoc
     */
    public function setType($type) : JsonRpcParamDoc
    {
        $this->type = $type;

        return $this;

The expression return $this returns the type Yoanm\JsonRpcServerDoc\Model\JsonRpcParamDocBackup which is incompatible with the type-hinted return Yoanm\JsonRpcServerDoc\Model\JsonRpcParamDoc.

    }

    /**
     * @param null|string|integer $name
     */
    public function setName($name)
    {
        $this->name = $name;
    }

    /**
     * @param bool $required
     *
     * @return JsonRpcParamDoc
     */
    public function setRequired(bool $required) : JsonRpcParamDoc
    {
        $this->required = $required;

        return $this;

The expression return $this returns the type Yoanm\JsonRpcServerDoc\Model\JsonRpcParamDocBackup which is incompatible with the type-hinted return Yoanm\JsonRpcServerDoc\Model\JsonRpcParamDoc.

    }

    /**
     * @param bool $nullable
     *
     * @return JsonRpcParamDoc
     */
    public function setNullable(bool $nullable) : JsonRpcParamDoc
    {
        $this->nullable = $nullable;

        return $this;

The expression return $this returns the type Yoanm\JsonRpcServerDoc\Model\JsonRpcParamDocBackup which is incompatible with the type-hinted return Yoanm\JsonRpcServerDoc\Model\JsonRpcParamDoc.

    }

    /**
     * @param bool $blankAllowed
     *
     * @return JsonRpcParamDoc
     */
    public function setBlankAllowed(bool $blankAllowed) : JsonRpcParamDoc
    {
        $this->blankAllowed = $blankAllowed;

        return $this;

The expression return $this returns the type Yoanm\JsonRpcServerDoc\Model\JsonRpcParamDocBackup which is incompatible with the type-hinted return Yoanm\JsonRpcServerDoc\Model\JsonRpcParamDoc.

    }

    /**
     * @param boolean $allOfValidItemList
     */
    public function setAllOfValidItemList(bool $allOfValidItemList)
    {
        $this->allOfValidItemList = $allOfValidItemList;
    }

    /**
     * @param mixed|null $expectedValue
     */
    public function setExpectedValue($expectedValue)
    {
        $this->expectedValue = $expectedValue;
    }

    /**
     * @param null $min

Are you sure the doc-type for parameter $min is correct as it would always require null to be passed?

     */
    public function setMin($min)
    {
        $this->min = $min;

The property min does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }

    /**
     * @param null $max

Are you sure the doc-type for parameter $max is correct as it would always require null to be passed?

     */
    public function setMax($max)
    {
        $this->max = $max;

The property max does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }

    /**
     * @param boolean $inclusiveMax
     */
    public function setInclusiveMax($inclusiveMax)
    {
        $this->inclusiveMax = $inclusiveMax;

The property inclusiveMax does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }

    /**
     * @param boolean $inclusiveMin
     */
    public function setInclusiveMin($inclusiveMin)
    {
        $this->inclusiveMin = $inclusiveMin;

The property inclusiveMin does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }

    /**
     * @param null $format

Are you sure the doc-type for parameter $format is correct as it would always require null to be passed?

     */
    public function setFormat($format)
    {
        $this->format = $format;
    }

    /**
     * @param boolean $allowExtraSibling
     */
    public function setAllowExtraSibling(bool $allowExtraSibling)
    {
        $this->allowExtraSibling = $allowExtraSibling;
    }

    /**
     * @param boolean $allowMissingSibling
     */
    public function setAllowMissingSibling(bool $allowMissingSibling)
    {
        $this->allowMissingSibling = $allowMissingSibling;
    }

    /**
     * @param JsonRpcParamDoc $doc
     */
    public function addSibling(JsonRpcParamDoc $doc)
    {
        $this->siblingList[] = $doc;
    }

    /**
     * @param JsonRpcParamDoc $validItem
     */
    public function addValidItem(JsonRpcParamDoc $validItem)
    {
        $this->validItemList[] = $validItem;
    }

    /**
     * @param mixed|null $default
     */
    public function setDefault($default)
    {
        $this->default = $default;

The property default does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }

    /**
     * @param mixed|null $example
     */
    public function setExample($example)
    {
        $this->example = $example;

The property example does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }

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

    /**
     * @return null|string
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * @return int|null|string
     */
    public function getName()
    {
        return $this->name;
    }

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

    /**
     * @return bool|null
     */
    public function isNullable()
    {
        return $this->nullable;
    }

    /**
     * @return bool|null
     */
    public function isBlankAllowed()
    {
        return $this->blankAllowed;
    }

    /**
     * @return null
     */
    public function getMin()
    {
        return $this->min;
    }

    /**
     * @return null
     */
    public function getMax()
    {
        return $this->max;
    }

    /**
     * @return boolean
     */
    public function isInclusiveMin()
    {
        return $this->inclusiveMin;
    }

    /**
     * @return boolean
     */
    public function isInclusiveMax()
    {
        return $this->inclusiveMax;
    }

    /**
     * @return null
     */
    public function getFormat()
    {
        return $this->format;

The expression return $this->format also could return the type string which is incompatible with the documented return type null.

    }

    /**
     * @return JsonRpcParamDoc[]
     */
    public function getSiblingList()
    {
        return $this->siblingList;
    }

    /**
     * @return mixed|null
     */
    public function getExpectedValue()
    {
        return $this->expectedValue;
    }

    /**
     * @return boolean
     */
    public function isAllowExtraSibling()
    {
        return $this->allowExtraSibling;
    }

    /**
     * @return boolean
     */
    public function isAllowMissingSibling()
    {
        return $this->allowMissingSibling;
    }

    /**
     * @return boolean
     */
    public function isAllOfValidItemList()
    {
        return $this->allOfValidItemList;
    }

    /**
     * @return JsonRpcParamDoc[]
     */
    public function getValidItemList()
    {
        return $this->validItemList;
    }

    /**
     * @return mixed|null
     */
    public function getDefault()
    {
        return $this->default;
    }

    /**
     * @return mixed|null
     */
    public function getExample()
    {
        return $this->example;
    }
}