SilverLeague\IDEAnnotator\AnnotateClassInfo

Complexity

Total Complexity

4

Size/Duplication

Total Lines	52
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getModuleName()	0	6	1
A	getDocComment()	0	3	1
A	getClassFilePath()	0	3	1
A	__construct()	0	5	1

<?php

namespace SilverLeague\IDEAnnotator;

use ReflectionClass;
use ReflectionException;
use SilverStripe\Core\Manifest\ModuleLoader;

/**
 * Class AnnotateClassInfo
 * We will need this for phpDocumentor as well.
 */
class AnnotateClassInfo
{
    /**
     * @var string
     */
    protected $className = '';

    /**
     * @var ReflectionClass
     */
    protected $reflector;

    /**
     * AnnotateClassInfo constructor.
     *
     * @param $className
     * @throws ReflectionException
     */
    public function __construct($className)
    {
        $this->className = $className;

        $this->reflector = new ReflectionClass($className);
    }

    /**
     * Where module name is a folder in the webroot.
     *
     * @return string
     */
    public function getModuleName()
    {
        $relativePath = str_replace(BASE_PATH . DIRECTORY_SEPARATOR, '', $this->reflector->getFileName());
        list($moduleName) = explode(DIRECTORY_SEPARATOR, $relativePath);

        return (string)$moduleName;
    }

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

    /**
     * @return string
     */
    public function getDocComment()
    {
        return $this->reflector->getDocComment();
    }
}