ApiController - Code Metrics - Erdiko/core - Measure and Improve Code Quality continuously with Scrutinizer

ApiController A
last analyzed 2017-04-21 07:13 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	30
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	5
c	1
b	0
f	0
lcom	1
cbo	2
dl	0
loc	30
rs	10

3 Methods

Rating	Name	Size	Complexity
A	__construct()	5	1
A	setStatusCode()	6	2
A	setErrors()	6	2

<?php
/**
 * Api Controller
 *
 * Base API request handler, all API controllers should be a subclass of this.
 * @note don't use this class just yet, WIP
 * @todo finish this class, right now it mimicks the Ajax controller/response
 *
 * @package     erdiko/core
 * @copyright   2012-2017 Arroyo Labs, Inc. http://www.arroyolabs.com
 * @author      John Arroyo <[email protected]>
 */
namespace erdiko\core;


/**
 * ApiController class
 */
class ApiController extends Controller
{

  /**
   * Contructor
   */
    public function __construct()
    {
        $this->_webroot = ERDIKO_ROOT;
        $this->_response = new \erdiko\core\ApiResponse;
    }

  /**
   * setStatusCode
   *
   */
    public function setStatusCode($code = null)
    {
        if (!empty($code)) {
            $this->_response->setStatusCode($code);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        }
    }

    public function setErrors($errors = null)
    {
        if (!empty($errors)) {
            $this->_response->setErrors($errors);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        }
    }
}


ApiController A
last analyzed 2017-04-21 07:13 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

Available Fixes

Available Fixes

1			<?php
2			/**
3			* Api Controller
4			*
5			* Base API request handler, all API controllers should be a subclass of this.
6			* @note don't use this class just yet, WIP
7			* @todo finish this class, right now it mimicks the Ajax controller/response
8			*
9			* @package erdiko/core
10			* @copyright 2012-2017 Arroyo Labs, Inc. http://www.arroyolabs.com
11			* @author John Arroyo <[email protected]>
12			*/
13			namespace erdiko\core;
14
15
16			/**
17			* ApiController class
18			*/
19			class ApiController extends Controller
20			{
21
22			/**
23			* Contructor
24			*/
25			public function __construct()
26			{
27			$this->_webroot = ERDIKO_ROOT;
28			$this->_response = new \erdiko\core\ApiResponse;
29			}
30
31			/**
32			* setStatusCode
33			*
34			*/
35			public function setStatusCode($code = null)
36			{
37			if (!empty($code)) {
38			$this->_response->setStatusCode($code);
			0 ignored issues – show Bug introduced 2017-02-17 23:45 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `erdiko\core\Response` as the method `setStatusCode()` does only exist in the following sub-classes of `erdiko\core\Response`: `erdiko\core\AjaxResponse`, `erdiko\core\ApiResponse`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
39			}
40			}
41
42			public function setErrors($errors = null)
43			{
44			if (!empty($errors)) {
45			$this->_response->setErrors($errors);
			0 ignored issues – show Bug introduced 2017-02-17 23:45 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `erdiko\core\Response` as the method `setErrors()` does only exist in the following sub-classes of `erdiko\core\Response`: `erdiko\core\AjaxResponse`, `erdiko\core\ApiResponse`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
46			}
47			}
48			}
49

Erdiko / core

ApiController A last analyzed 2017-04-21 07:13 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

ApiController A
last analyzed 2017-04-21 07:13 UTC