bytic / utility

src/Traits/NameWorksTrait.php

<?php

namespace Nip\Utility\Traits;

/**
 * Class NameWorksTrait
 * @package Nip\Utility\Traits
 */
trait NameWorksTrait
{
    /**
     * @var null|boolean
     */
    protected $className = null;

    /**
     * @var null|array
     */
    protected $classNameParts = null;

    /**
     * @var null|boolean
     */
    protected $classFirstName = null;

    /**
     * @var null|string
     */
    protected $namespacePath = null;

    /**
     * @var null|boolean
     */
    protected $isNamespaced = null;

    /**
     * @return string
     */
    public function getClassName()
    {
        if ($this->className === null) {
            $this->setClassName($this->generateClassName());

$this->generateClassName() of type string is incompatible with the type boolean|null expected by parameter $className of Nip\Utility\Traits\NameWorksTrait::setClassName().

        }

        return $this->className;

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

    }

    /**
     * @param bool|null $className
     */
    public function setClassName($className)
    {
        $this->className = $className;
    }

    /**
     * @return string
     */
    protected function generateClassName()
    {
        return get_class($this);
    }

    /**
     * @return mixed|null
     */
    public function getNamespaceParentFolder()
    {
        if (!$this->isNamespaced()) {
            return null;
        }
        $parts = $this->getClassNameParts();
        array_pop($parts);
        return end($parts);
    }

    /**
     * @return bool
     */
    public function isNamespaced()
    {
        if ($this->isNamespaced === null) {
            $class = $this->getClassName();

            $this->isNamespaced = strpos($class, '\\') !== false;
        }

        return $this->isNamespaced;
    }

    /**
     * @return array|null
     */
    public function getClassNameParts()
    {
        if ($this->classNameParts === null) {
            $this->initClassNameParts();
        }
        return $this->classNameParts;
    }

    /**
     * @param array|null $classNameParts
     */
    public function setClassNameParts($classNameParts)
    {
        $this->classNameParts = $classNameParts;
    }

    protected function initClassNameParts()
    {
        $class = $this->getClassName();
        $parts = explode('\\', $class);
        $this->setClassNameParts($parts);
    }

    /**
     * @return null|string
     */
    public function getNamespacePath()
    {
        if ($this->namespacePath === null) {
            $this->initNamespacePath();
        }
        return $this->namespacePath;
    }

    protected function initNamespacePath()
    {
        $this->namespacePath = '';
        if ($this->isNamespaced()) {
            $parts = $this->getClassNameParts();
            array_pop($parts);
            $this->namespacePath = implode('\\', $parts);
        }
    }

    /**
     * @return bool|null
     */
    public function getClassFirstName()
    {
        if ($this->classFirstName === null) {
            $this->initClassFirstName();
        }

        return $this->classFirstName;
    }

    protected function initClassFirstName()
    {
        $parts = $this->getClassNameParts();
        $this->classFirstName = array_pop($parts);
    }
}