AjaxController   A
last analyzed

Complexity

Total Complexity 6

Size/Duplication

Total Lines 38
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 2

Importance

Changes 1
Bugs 0 Features 0
Metric Value
wmc 6
c 1
b 0
f 0
lcom 1
cbo 2
dl 0
loc 38
rs 10

4 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 5 1
A _before() 0 4 1
A setStatusCode() 0 6 2
A setErrors() 0 6 2
1
<?php
2
/**
3
 * Ajax Controller
4
 *
5
 * Base request handler, all ajax controllers should inherit this class.
6
 *
7
 * @package     erdiko/core
8
 * @copyright   2012-2017 Arroyo Labs, Inc. http://www.arroyolabs.com
9
 * @author      John Arroyo <[email protected]>
10
 * @author      Andy Armstrong <[email protected]>
11
 */
12
namespace erdiko\core;
13
14
15
class AjaxController extends Controller
16
{
17
18
  /**
19
   * Contructor
20
   */
21
    public function __construct()
22
    {
23
        $this->_webroot = ERDIKO_ROOT;
24
        $this->_response = new \erdiko\core\AjaxResponse;
25
    }
26
27
    /** 
28
     * Before 
29
     */
30
    public function _before()
31
    {
32
        // Do nothing, it overrides the core before function which prepares for theming
33
    }
34
35
    /**
36
     * setStatusCode
37
     *
38
     */
39
    public function setStatusCode($code = null)
40
    {
41
        if (!empty($code)) {
42
            $this->_response->setStatusCode($code);
0 ignored issues
show
Bug introduced by
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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
43
        }
44
    }
45
46
    public function setErrors($errors = null)
47
    {
48
        if (!empty($errors)) {
49
            $this->_response->setErrors($errors);
0 ignored issues
show
Bug introduced by
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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
50
        }
51
    }
52
}
53