EntityClass::parseDocs() - Code Metrics - frqnck/apix - Measure and Improve Code Quality continuously with Scrutinizer

EntityClass::parseDocs() A
last analyzed 2017-05-17 20:31 UTC

↳ Parent: EntityClass

Complexity

Conditions	3
Paths	3

Size

Total Lines	23
Code Lines	10

Duplication

Lines	10
Ratio	43.48 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
dl	10
loc	23
ccs	0
cts	15
cp	0
rs	9.0856
c	0
b	0
f	0
cc	3
eloc	10
nc	3
nop	0
crap	12

<?php

/**
 *
 * This file is part of the Apix Project.
 *
 * (c) Franck Cassedanne <franck at ouarz.net>
 *
 * @license     http://opensource.org/licenses/BSD-3-Clause  New BSD License
 *
 */

namespace Apix\Entity;

use Apix\Entity,
    Apix\Entity\EntityInterface,
    Apix\Reflection,
    Apix\Router;

/**
 * Represents a class based entity resource.
 */
class EntityClass extends Entity implements EntityInterface
{
    protected $controller;

    private $reflection;

    /**
     * Sets and returns a reflection of the entity class.
     *
     * @return \ReflectionClass|false
     */
    public function reflectedClass()
    {
        if (null === $this->reflection) {
            try {
                $this->reflection = new \ReflectionClass(
                    $this->controller['name']
                );
            } catch (\Exception $Exception) {
                throw new \RuntimeException('Resource entity class not (yet) implemented.', 501);
            }
        }

        return $this->reflection;
    }

    /**
     * {@inheritdoc}
     */
    public function append(array $def)
    {
        parent::_append($def);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}

        if (isset($def['controller'])) {
            $this->controller = $def['controller'];
        }
    }

    /**
     * {@inheritdoc}
     */
    public function underlineCall(Router $route)
    {
        $name = $this->controller['name'];
        $args = $this->controller['args'];

        // if (!isset($entity->controller['name'])) {

        //     $entity->controller['name'] = $route->controller_name;

        // }

        // just created a deependency here!!!!!
        // if (!isset($args)) {

        //     $args = $route->controller_args;

        // }

        $method = $this->getMethod($route);

        $params = $this->getValidatedParams($method, $route->getMethod(), $route->getParams());

        return call_user_func_array(
          array(
            new $name($args),
            $route->getAction()),
            $params
          );
    }

    /**
     * {@inheritdoc}
     */
    public function parseDocs()
    {
        // group class doc
        $docs = Reflection::parsePhpDoc(
            $this->reflectedClass()->getDocComment()
        );

        $actions = $this->getActions();

        // doc for all methods
        foreach ($this->getMethods() as $key => $method) {

            if ( $key = array_search($method->name, $actions) ) {

               $_docs = Reflection::parsePhpDoc( $method );
                $_docs['method'] = $key;

                // temp
                $docs['methods'][$key] = $_docs;
            }
        }

        return $docs;
    }

    /**
     * {@inheritdoc}
     */
    public function getMethod(Router $route)
    {
        $name = $route->getAction();
        if (false === $this->reflectedClass()->hasMethod($name)) {
            throw new \InvalidArgumentException(
                "Invalid resource's method ({$route->getMethod()}) specified.",
                405
            );
        }

        return $this->reflectedClass()->getMethod($name);
    }

    /**
     * {@inheritdoc}
     */
    public function setActions(array $asso = null)
    {
        $funcs = array();
        foreach ($this->getMethods() as $ref) {
            $funcs[] = $ref->name;
        }
        $routes = Router::$actions;

        $this->actions = array_intersect($routes, $funcs);
    }

    /**
     * Returns the class methods. Use internalaly.
     * @return array An array of \ReflectionMethod objects.
     */
    public function getMethods()
    {
        return $this->reflectedClass()->getMethods(
            \ReflectionMethod::IS_STATIC | \ReflectionMethod::IS_PUBLIC
        );
    }

}


1		<?php
2
3		/**
4		*
5		* This file is part of the Apix Project.
6		*
7		* (c) Franck Cassedanne <franck at ouarz.net>
8		*
9		* @license http://opensource.org/licenses/BSD-3-Clause New BSD License
10		*
11		*/
12
13		namespace Apix\Entity;
14
15		use Apix\Entity,
16		Apix\Entity\EntityInterface,
17		Apix\Reflection,
18		Apix\Router;
19
20		/**
21		* Represents a class based entity resource.
22		*/
23		class EntityClass extends Entity implements EntityInterface
24		{
25		protected $controller;
26
27		private $reflection;
28
29		/**
30		* Sets and returns a reflection of the entity class.
31		*
32		* @return \ReflectionClass\|false
33		*/
34		public function reflectedClass()
35		{
36		if (null === $this->reflection) {
37		try {
38		$this->reflection = new \ReflectionClass(
39		$this->controller['name']
40		);
41		} catch (\Exception $Exception) {
42		throw new \RuntimeException('Resource entity class not (yet) implemented.', 501);
43		}
44		}
45
46		return $this->reflection;
47		}
48
49		/**
50		* {@inheritdoc}
51		*/
52		public function append(array $def)
53		{
54		parent::_append($def);
		0 ignored issues – show Comprehensibility Bug introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`_append()` instead of `append()`). Are you sure this is correct? If so, you might want to change this to `$this->_append()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
55
56		if (isset($def['controller'])) {
57		$this->controller = $def['controller'];
58		}
59		}
60
61		/**
62		* {@inheritdoc}
63		*/
64		public function underlineCall(Router $route)
65		{
66		$name = $this->controller['name'];
67		$args = $this->controller['args'];
68
69		// if (!isset($entity->controller['name'])) {
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report `77%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
70		// $entity->controller['name'] = $route->controller_name;
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report `58%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
71		// }
72
73		// just created a deependency here!!!!!
74		// if (!isset($args)) {
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report `75%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
75		// $args = $route->controller_args;
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report `45%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
76		// }
77
78		$method = $this->getMethod($route);
79
80		$params = $this->getValidatedParams($method, $route->getMethod(), $route->getParams());
81
82		return call_user_func_array(
83		array(
84		new $name($args),
85		$route->getAction()),
86		$params
87		);
88		}
89
90		/**
91		* {@inheritdoc}
92		*/
93		public function parseDocs()
94		{
95		// group class doc
96		$docs = Reflection::parsePhpDoc(
97		$this->reflectedClass()->getDocComment()
98		);
99
100		$actions = $this->getActions();
101
102		// doc for all methods
103	View Code Duplication	foreach ($this->getMethods() as $key => $method) {
		0 ignored issues – show Duplication introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
104		if ( $key = array_search($method->name, $actions) ) {
105
106		$_docs = Reflection::parsePhpDoc( $method );
107		$_docs['method'] = $key;
108
109		// temp
110		$docs['methods'][$key] = $_docs;
111		}
112		}
113
114		return $docs;
115		}
116
117		/**
118		* {@inheritdoc}
119		*/
120		public function getMethod(Router $route)
121		{
122		$name = $route->getAction();
123		if (false === $this->reflectedClass()->hasMethod($name)) {
124		throw new \InvalidArgumentException(
125		"Invalid resource's method ({$route->getMethod()}) specified.",
126		405
127		);
128		}
129
130		return $this->reflectedClass()->getMethod($name);
131		}
132
133		/**
134		* {@inheritdoc}
135		*/
136		public function setActions(array $asso = null)
137		{
138		$funcs = array();
139		foreach ($this->getMethods() as $ref) {
140		$funcs[] = $ref->name;
141		}
142		$routes = Router::$actions;
143
144		$this->actions = array_intersect($routes, $funcs);
145		}
146
147		/**
148		* Returns the class methods. Use internalaly.
149		* @return array An array of \ReflectionMethod objects.
150		*/
151		public function getMethods()
152		{
153		return $this->reflectedClass()->getMethods(
154		\ReflectionMethod::IS_STATIC \| \ReflectionMethod::IS_PUBLIC
155		);
156		}
157
158		}
159

frqnck / apix

EntityClass::parseDocs() A last analyzed 2017-05-17 20:31 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

EntityClass::parseDocs() A
last analyzed 2017-05-17 20:31 UTC