ReflectionConstant::getDocCommentFromFile() - Code Metrics - Speicher210/Reflection - Measure and Improve Code Quality continuously with Scrutinizer

ReflectionConstant::getDocCommentFromFile() B
last analyzed 2017-02-15 09:14 UTC

↳ Parent: ReflectionConstant

Complexity

Conditions	5
Paths	4

Size

Total Lines	27
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	16
CRAP Score	5

Importance

Changes

Metric	Value
dl	0
loc	27
ccs	16
cts	16
cp	1
rs	8.439
c	0
b	0
f	0
cc	5
eloc	15
nc	4
nop	1
crap	5

<?php

namespace Wingu\OctopusCore\Reflection;

/**
 * Reflection about a class constant.
 */
class ReflectionConstant implements \Reflector
{

    use ReflectionDocCommentTrait;

    /**
     * The name of the constant.
     *
     * @var string
     */
    protected $name;

    /**
     * The value of the constant.
     *
     * @var mixed
     */
    protected $value;

    /**
     * The class where the constant has been declared.
     *
     * @var \Wingu\OctopusCore\Reflection\ReflectionClass
     */
    protected $declaringClass;

    /**
     * Constructor.
     *
     * @param string $class The name of the class where the constant has been declared.
     * @param string $name The name of the constant to reflect.
     */
    public function __construct($class, $name)
    {
        $this->declaringClass = new ReflectionClass($class);
        $this->name = $name;
        $this->value = $this->declaringClass->getConstant($name);
    }

    /**
     * Get a reflection of the class where the constant has been declared.
     *
     * @return \Wingu\OctopusCore\Reflection\ReflectionClass
     */
    public function getDeclaringClass()
    {
        return $this->declaringClass;
    }

    /**
     * Get the value of the constant.
     *
     * @return mixed
     */
    public function getValue()
    {
        return $this->value;
    }

    /**
     * Get the name of the constant.
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Export the current constant reflection.
     *
     * @param string $className The class name where the constant is defined.
     * @param string $constantName The name of the constant.
     * @param boolean $return Flag if the export should be returned or not.
     * @return string
     */
    public static function export($className, $constantName, $return = false)
    {
        $export = new self($className, $constantName);
        $export = (string)$export;
        if ($return === true) {
            return $export;
        } else {
            echo $export;

            return null;
        }
    }

    /**
     * Return the string representation of the ReflectionConstant object.
     *
     * @return string
     */
    public function __toString()
    {
        return 'Constant [ ' . gettype($this->value) . ' const ' . $this->getName() . ' ] { ' . $this->value . ' }';
    }

    /**
     * Return the string containing the current constant comment or false if there's no comment.
     *
     * @return string
     */
    public function getDocComment()
    {
        $fileName = $this->getDeclaringClass()->getFileName();
        if ($fileName === false) {
            return false;
        } else {
            return $this->getDocCommentFromFile($fileName);
        }
    }

    /**
     * Returns the doc comment from an existing filename or false if empty.
     *
     * @param string $fileName an existing filename
     * @return string
     */
    private function getDocCommentFromFile($fileName)
    {
        $lines = file($fileName, FILE_IGNORE_NEW_LINES);

        $declaringClassStartLine = $this->getDeclaringClass()->getStartLine() - 1;
        $declaringClassLength = $this->getDeclaringClass()->getEndLine() - $declaringClassStartLine + 1;

        $currentClassLines = array_slice($lines, $declaringClassStartLine, $declaringClassLength, true);

        // Need the php open tag to tokenize the class.
        $tokens = token_get_all("<?php\n" . implode("\n", $currentClassLines));

        $return = false;
        $constDeclarationKey = $this->getCurrentConstantKeyFromClassTokens($tokens);

        // Now we have the key value of the constant declaration, we have to pick up the comment before the declaration (if it exists).
        for ($constDeclarationKey--; $constDeclarationKey > 0; $constDeclarationKey--) {
            if ($tokens[$constDeclarationKey][0] !== T_WHITESPACE && $tokens[$constDeclarationKey][0] !== T_DOC_COMMENT) {
                break;
            } elseif ($tokens[$constDeclarationKey][0] === T_DOC_COMMENT) {
                $return = $tokens[$constDeclarationKey][1];
                break;
            }
        }

        return $return;
    }

    /**
     * Returns the current constant declaration key in the list of given tokens. Returns 0 if not found.
     *
     * @param array $tokens the array of tokens (see http://www.php.net/manual/en/ref.tokenizer.php)
     * @return int
     */
    private function getCurrentConstantKeyFromClassTokens($tokens)
    {
        $parsingStateConstDeclarationFound = false;
        $constDeclarationKey = 0;

        foreach ($tokens as $key => $token) {
            if (is_array($token) === true && $token[0] === T_CONST) {
                $parsingStateConstDeclarationFound = true;
                $constDeclarationKey = $key;
            }

            if ($parsingStateConstDeclarationFound === true && $token[0] === T_STRING) {
                if ($token[1] === $this->getName()) {
                    break;
                } else {
                    $parsingStateConstDeclarationFound = false;
                }
            }
        }

        return $constDeclarationKey;
    }
}


1		<?php
2
3		namespace Wingu\OctopusCore\Reflection;
4
5		/**
6		* Reflection about a class constant.
7		*/
8		class ReflectionConstant implements \Reflector
9		{
10
11		use ReflectionDocCommentTrait;
12
13		/**
14		* The name of the constant.
15		*
16		* @var string
17		*/
18		protected $name;
19
20		/**
21		* The value of the constant.
22		*
23		* @var mixed
24		*/
25		protected $value;
26
27		/**
28		* The class where the constant has been declared.
29		*
30		* @var \Wingu\OctopusCore\Reflection\ReflectionClass
31		*/
32		protected $declaringClass;
33
34		/**
35		* Constructor.
36		*
37		* @param string $class The name of the class where the constant has been declared.
38		* @param string $name The name of the constant to reflect.
39		*/
40	30	public function __construct($class, $name)
41		{
42	30	$this->declaringClass = new ReflectionClass($class);
43	30	$this->name = $name;
44	30	$this->value = $this->declaringClass->getConstant($name);
45	30	}
46
47		/**
48		* Get a reflection of the class where the constant has been declared.
49		*
50		* @return \Wingu\OctopusCore\Reflection\ReflectionClass
51		*/
52	12	public function getDeclaringClass()
53		{
54	12	return $this->declaringClass;
55		}
56
57		/**
58		* Get the value of the constant.
59		*
60		* @return mixed
61		*/
62	3	public function getValue()
63		{
64	3	return $this->value;
65		}
66
67		/**
68		* Get the name of the constant.
69		*
70		* @return string
71		*/
72	15	public function getName()
73		{
74	15	return $this->name;
75		}
76
77		/**
78		* Export the current constant reflection.
79		*
80		* @param string $className The class name where the constant is defined.
81		* @param string $constantName The name of the constant.
82		* @param boolean $return Flag if the export should be returned or not.
83		* @return string
84		*/
85	6	public static function export($className, $constantName, $return = false)
86		{
87	6	$export = new self($className, $constantName);
88	6	$export = (string)$export;
89	6	if ($return === true) {
90	3	return $export;
91		} else {
92	3	echo $export;
93
94	3	return null;
95		}
96		}
97
98		/**
99		* Return the string representation of the ReflectionConstant object.
100		*
101		* @return string
102		*/
103	6	public function __toString()
104		{
105	6	return 'Constant [ ' . gettype($this->value) . ' const ' . $this->getName() . ' ] { ' . $this->value . ' }';
106		}
107
108		/**
109		* Return the string containing the current constant comment or false if there's no comment.
110		*
111		* @return string
112		*/
113	9	public function getDocComment()
114		{
115	9	$fileName = $this->getDeclaringClass()->getFileName();
116	9	if ($fileName === false) {
117	3	return false;
118		} else {
119	6	return $this->getDocCommentFromFile($fileName);
120		}
121		}
122
123		/**
124		* Returns the doc comment from an existing filename or false if empty.
125		*
126		* @param string $fileName an existing filename
127		* @return string
128		*/
129	6	private function getDocCommentFromFile($fileName)
130		{
131	6	$lines = file($fileName, FILE_IGNORE_NEW_LINES);
132
133	6	$declaringClassStartLine = $this->getDeclaringClass()->getStartLine() - 1;
134	6	$declaringClassLength = $this->getDeclaringClass()->getEndLine() - $declaringClassStartLine + 1;
135
136	6	$currentClassLines = array_slice($lines, $declaringClassStartLine, $declaringClassLength, true);
137
138		// Need the php open tag to tokenize the class.
139	6	$tokens = token_get_all("<?php\n" . implode("\n", $currentClassLines));
140
141	6	$return = false;
142	6	$constDeclarationKey = $this->getCurrentConstantKeyFromClassTokens($tokens);
143
144		// Now we have the key value of the constant declaration, we have to pick up the comment before the declaration (if it exists).
145	6	for ($constDeclarationKey--; $constDeclarationKey > 0; $constDeclarationKey--) {
146	6	if ($tokens[$constDeclarationKey][0] !== T_WHITESPACE && $tokens[$constDeclarationKey][0] !== T_DOC_COMMENT) {
147	3	break;
148	6	} elseif ($tokens[$constDeclarationKey][0] === T_DOC_COMMENT) {
149	3	$return = $tokens[$constDeclarationKey][1];
150	3	break;
151		}
152	2	}
153
154	6	return $return;
155		}
156
157		/**
158		* Returns the current constant declaration key in the list of given tokens. Returns 0 if not found.
159		*
160		* @param array $tokens the array of tokens (see http://www.php.net/manual/en/ref.tokenizer.php)
161		* @return int
162		*/
163	6	private function getCurrentConstantKeyFromClassTokens($tokens)
164		{
165	6	$parsingStateConstDeclarationFound = false;
166	6	$constDeclarationKey = 0;
167
168	6	foreach ($tokens as $key => $token) {
169	6	if (is_array($token) === true && $token[0] === T_CONST) {
170	6	$parsingStateConstDeclarationFound = true;
171	6	$constDeclarationKey = $key;
172	2	}
173
174	6	if ($parsingStateConstDeclarationFound === true && $token[0] === T_STRING) {
175	6	if ($token[1] === $this->getName()) {
176	6	break;
177		} else {
178	5	$parsingStateConstDeclarationFound = false;
179		}
180	1	}
181	2	}
182
183	6	return $constDeclarationKey;
184		}
185		}
186

Speicher210 / Reflection

GitHub Access Token became invalid

ReflectionConstant::getDocCommentFromFile() B last analyzed 2017-02-15 09:14 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ReflectionConstant::getDocCommentFromFile() B
last analyzed 2017-02-15 09:14 UTC