AnnotateClassInfo::getModuleName() - Code Metrics - Inspection of "Support short names" - silverleague/silverstripe-ideannotator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#107)

by Simon

created 2018-05-27 01:34 UTC

AnnotateClassInfo::getModuleName() A

↳ Parent: AnnotateClassInfo

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	3
nc	1
nop	0
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0

<?php

namespace SilverLeague\IDEAnnotator\Helpers;

use ReflectionClass;
use ReflectionException;
use SilverStripe\Control\Director;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Core\Manifest\ModuleManifest;

/**
 * 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()
    {
        /** @var ModuleManifest $moduleManifest */
        $moduleManifest = Injector::inst()->createWithArgs(ModuleManifest::class, [Director::baseFolder()]);
        $module = $moduleManifest->getModuleByPath($this->reflector->getFileName());

        return $module->getName();
    }

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


1			<?php
2
3			namespace SilverLeague\IDEAnnotator\Helpers;
4
5			use ReflectionClass;
6			use ReflectionException;
7			use SilverStripe\Control\Director;
8			use SilverStripe\Core\Injector\Injector;
9			use SilverStripe\Core\Manifest\ModuleManifest;
10
11			/**
12			* Class AnnotateClassInfo
13			* We will need this for phpDocumentor as well.
14			*/
15			class AnnotateClassInfo
16			{
17			/**
18			* @var string
19			*/
20			protected $className = '';
21
22			/**
23			* @var ReflectionClass
24			*/
25			protected $reflector;
26
27			/**
28			* AnnotateClassInfo constructor.
29			*
30			* @param $className
31			* @throws ReflectionException
32			*/
33			public function __construct($className)
34			{
35			$this->className = $className;
36
37			$this->reflector = new ReflectionClass($className);
38			}
39
40			/**
41			* Where module name is a folder in the webroot.
42			*
43			* @return string
44			*/
45			public function getModuleName()
46			{
47			/** @var ModuleManifest $moduleManifest */
48			$moduleManifest = Injector::inst()->createWithArgs(ModuleManifest::class, [Director::baseFolder()]);
49			$module = $moduleManifest->getModuleByPath($this->reflector->getFileName());
50
51			return $module->getName();
52			}
53
54			/**
55			* @return string
56			*/
57			public function getClassFilePath()
58			{
59			return $this->reflector->getFileName();
60			}
61			}
62

silverleague / silverstripe-ideannotator

Pull Request — master (#107)

AnnotateClassInfo::getModuleName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like