Completed
Push — develop ( 7585df...411e92 )
by
unknown
22:06 queued 11:09
created

ManageController::forwardAction()   B

Complexity

Conditions 3
Paths 6

Size

Total Lines 42
Code Lines 28

Duplication

Lines 0
Ratio 0 %

Importance

Changes 2
Bugs 0 Features 0
Metric Value
c 2
b 0
f 0
dl 0
loc 42
rs 8.8571
cc 3
eloc 28
nc 6
nop 0
1
<?php
2
/**
3
 * YAWIK
4
 *
5
 * @filesource
6
 * @copyright (c) 2013-2015 Cross Solution (http://cross-solution.de)
7
 * @license   MIT
8
 */
9
10
/** Applications controller */
11
namespace Applications\Controller;
12
13
use Zend\Mvc\Controller\AbstractActionController;
14
use Zend\View\Model\ViewModel;
15
use Zend\View\Model\JsonModel;
16
use Applications\Entity\StatusInterface as Status;
17
use Applications\Entity\Application;
18
19
20
/**
21
 * @method \Core\Controller\Plugin\Notification notification()
22
 * @method \Core\Controller\Plugin\Mailer mailer()
23
 * @method \Acl\Controller\Plugin\Acl acl()
24
 * @method \Auth\Controller\Plugin\Auth auth()
25
 *
26
 * Handles managing actions on applications
27
 */
28
class ManageController extends AbstractActionController
29
{
30
    /**
31
     * attaches further Listeners for generating / processing the output
32
     *
33
     * @return $this
34
     */
35 View Code Duplication
    public function attachDefaultListeners()
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in 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...
36
    {
37
        parent::attachDefaultListeners();
38
        $serviceLocator  = $this->getServiceLocator();
39
        $defaultServices = $serviceLocator->get('DefaultListeners');
40
        $events          = $this->getEventManager();
41
        $events->attach($defaultServices);
0 ignored issues
show
Documentation introduced by
$defaultServices is of type object|array, but the function expects a string.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
42
        return $this;
43
    }
44
45
    /**
46
     * (non-PHPdoc)
47
     * @see \Zend\Mvc\Controller\AbstractActionController::onDispatch()
48
     */
49
    public function onDispatch(\Zend\Mvc\MvcEvent $e)
50
    {
51
        $routeMatch = $e->getRouteMatch();
52
        $action     = $this->params()->fromQuery('action');
53
        
54
        if ($routeMatch && $action) {
55
            $routeMatch->setParam('action', $action);
56
        }
57
58
        return parent::onDispatch($e);
59
    }
60
    
61
    /**
62
     * List applications
63
     */
64
    public function indexAction()
65
    {
66
        $services              = $this->getServiceLocator();
67
        /* @var \Jobs\Repository\Job $jobRepository */
68
        $jobRepository         = $services->get('repositories')->get('Jobs/Job');
69
        /* @var \Applications\Repository\Application $applicationRepository */
70
        $applicationRepository = $services->get('repositories')->get('Applications/Application');
71
        $services_form         = $services->get('forms');
0 ignored issues
show
Coding Style introduced by
$services_form does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

This check examines a number of code elements and verifies that they conform to the given naming conventions.

You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods.

Loading history...
72
        /* @var \Applications\Form\FilterApplication $form */
73
        $form                  = $services_form->get('Applications/Filter');
0 ignored issues
show
Coding Style introduced by
$services_form does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

This check examines a number of code elements and verifies that they conform to the given naming conventions.

You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods.

Loading history...
74
        $params                = $this->getRequest()->getQuery();
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Zend\Stdlib\RequestInterface as the method getQuery() does only exist in the following implementations of said interface: ZendTest\Mvc\Controller\TestAsset\Request, Zend\Http\PhpEnvironment\Request, Zend\Http\Request.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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 implementation 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 interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
75
        /* @var \Zend\Form\Element\Select $statusElement */
76
        $statusElement         = $form->get('status');
77
78
        $states                = $applicationRepository->getStates()->toArray();
79
        $states                = array_merge(array(/*@translate*/ 'all'), $states);
80
        
81
        $statesForSelections = array();
82
        foreach ($states as $state) {
83
            $statesForSelections[$state] = $state;
84
        }
85
        $statusElement->setValueOptions($statesForSelections);
86
        
87
        $job = $params->job ? $jobRepository->find($params->job)  : null;
88
        $paginator = $this->paginator('Applications/Application', $params);
0 ignored issues
show
Documentation Bug introduced by
The method paginator does not exist on object<Applications\Controller\ManageController>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
89
90
        if ($job) {
91
            $params['job_title'] = '[' . $job->getApplyId() . '] ' . $job->getTitle();
92
        }
93
94
        $form->bind($params);
95
                
96
        return array(
97
            'form' => $form,
98
            'applications' => $paginator,
99
            'byJobs' => 'jobs' == $params->get('by', 'me'),
100
            'sort' => $params->get('sort', 'none'),
101
            'search' => $params->get('search', ''),
102
            'job' => $job,
103
            'applicationStates' => $states,
104
            'applicationState' => $params->get('status', '')
105
        );
106
    }
107
108
    /**
109
     * Detail view of an application
110
     *
111
     * @return array|JsonModel|ViewModel
112
     */
113
    public function detailAction()
114
    {
115
116
        if ('refresh-rating' == $this->params()->fromQuery('do')) {
117
            return $this->refreshRatingAction();
118
        }
119
        
120
        $nav = $this->getServiceLocator()->get('Core/Navigation');
121
        $page = $nav->findByRoute('lang/applications');
122
        $page->setActive();
123
124
        /* @var \Applications\Repository\Application$repository */
125
        $repository = $this->getServiceLocator()->get('repositories')->get('Applications/Application');
126
        /* @var Application $application */
127
        $application = $repository->find($this->params('id'));
128
        
129 View Code Duplication
        if (!$application) {
0 ignored issues
show
Duplication introduced by
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...
130
            $this->response->setStatusCode(410);
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Zend\Stdlib\ResponseInterface as the method setStatusCode() does only exist in the following implementations of said interface: Zend\Http\PhpEnvironment\Response, Zend\Http\Response, Zend\Http\Response\Stream.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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 implementation 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 interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
131
            $model = new ViewModel(
132
                array(
133
                'content' => /*@translate*/ 'Invalid apply id'
134
                )
135
            );
136
            $model->setTemplate('applications/error/not-found');
137
            return $model;
138
        }
139
        
140
        $this->acl($application, 'read');
0 ignored issues
show
Unused Code introduced by
The call to ManageController::acl() has too many arguments starting with $application.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
141
        
142
        $applicationIsUnread = false;
143
        if ($application->isUnreadBy($this->auth('id'))) {
0 ignored issues
show
Unused Code introduced by
The call to ManageController::auth() has too many arguments starting with 'id'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
Documentation introduced by
$this->auth('id') is of type object<Auth\Controller\Plugin\Auth>, but the function expects a object<Auth\Entity\UserInterface>|string.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
144
            $application->addReadBy($this->auth('id'));
0 ignored issues
show
Unused Code introduced by
The call to ManageController::auth() has too many arguments starting with 'id'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
Documentation introduced by
$this->auth('id') is of type object<Auth\Controller\Plugin\Auth>, but the function expects a object<Auth\Entity\UserInterface>|string.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
145
            $applicationIsUnread = true;
146
        }
147
        
148
        
149
        $format=$this->params()->fromQuery('format');
150
151
        if ($application->isDraft()) {
152
            $list = false;
153
        } else {
154
            $list = $this->paginationParams('Applications\Index', $repository);
0 ignored issues
show
Bug introduced by
The method paginationParams() does not exist on Applications\Controller\ManageController. Did you maybe mean params()?

This check marks calls to methods that do not seem to exist on an object.

This is most likely the result of a method being renamed without all references to it being renamed likewise.

Loading history...
155
            $list->setCurrent($application->id);
0 ignored issues
show
Documentation introduced by
The property $id is declared protected in Core\Entity\AbstractIdentifiableEntity. Since you implemented __get(), maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
156
        }
157
158
        $return = array(
159
            'application'=> $application,
160
            'list' => $list,
161
            'isUnread' => $applicationIsUnread,
162
            'format' => 'html'
163
        );
164
        switch ($format) {
165
            case 'json':
166
                /*@deprecated - must be refactored */
167
                        $viewModel = new JsonModel();
168
                        $viewModel->setVariables(
169
                            /*array(
0 ignored issues
show
Unused Code Comprehensibility introduced by
67% 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...
170
                            'application' => */$this->getServiceLocator()
171
                                              ->get('builders')
172
                                              ->get('JsonApplication')
173
                                              ->unbuild($application)
174
                        );
175
                        $viewModel->setVariable('isUnread', $applicationIsUnread);
176
                        $return = $viewModel;
177
                break;
178
            case 'pdf':
179
                $pdf = $this->getServiceLocator()->get('Core/html2pdf');
0 ignored issues
show
Unused Code introduced by
$pdf is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
180
                $return['format'] = $format;
181
                break;
182
            default:
183
                $contentCollector = $this->getPluginManager()->get('Core/ContentCollector');
184
                $contentCollector->setTemplate('applications/manage/details/action-buttons');
185
                $actionButtons = $contentCollector->trigger('application.detail.actionbuttons', $application);
186
                
187
                $return = new ViewModel($return);
188
                $return->addChild($actionButtons, 'externActionButtons');
189
                break;
190
        }
191
        
192
        return $return;
193
    }
194
    
195
    /**
196
     * Refreshes the rating of an application
197
     *
198
     * @throws \DomainException
199
     * @return \Zend\View\Model\ViewModel
200
     */
201
    public function refreshRatingAction()
202
    {
203
        $model = new ViewModel();
204
        $model->setTemplate('applications/manage/_rating');
205
        
206
        $application = $this->getServiceLocator()->get('repositories')->get('Applications/Application')
207
                        ->find($this->params('id', 0));
208
        
209
        if (!$application) {
210
            throw new \DomainException('Invalid application id.');
211
        }
212
        
213
        $model->setVariable('application', $application);
214
        return $model;
215
    }
216
    
217
    /**
218
     * Attaches a social profile to an application
219
     * @throws \InvalidArgumentException
220
     *
221
     * @return array
222
     */
223
    public function socialProfileAction()
224
    {
225
        if ($spId = $this->params()->fromQuery('spId')) {
0 ignored issues
show
Unused Code introduced by
$spId is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
226
            $repositories = $this->getServiceLocator()->get('repositories');
227
            $repo = $repositories->get('Applications/Application');
228
            $profile = $repo->findProfile($this->params()->fromQuery('spId'));
229
            if (!$profile) {
230
                throw new \InvalidArgumentException('Could not find profile.');
231
            }
232
            
233
        } elseif ($this->getRequest()->isPost()
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Zend\Stdlib\RequestInterface as the method isPost() does only exist in the following implementations of said interface: ZendTest\Mvc\Controller\TestAsset\Request, Zend\Http\PhpEnvironment\Request, Zend\Http\Request.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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 implementation 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 interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
234
                   && ($network = $this->params()->fromQuery('network'))
235
                   && ($data    = $this->params()->fromPost('data'))
236
        ) {
237
            $profileClass = '\\Auth\\Entity\\SocialProfiles\\' . $network;
238
            $profile      = new $profileClass();
239
            $profile->setData(\Zend\Json\Json::decode($data, \Zend\Json\Json::TYPE_ARRAY));
240
        } else {
241
            throw new \RuntimeException(
242
                'Missing arguments. Either provide "spId" as Get or "network" and "data" as Post.'
243
            );
244
        }
245
        
246
        return array(
247
            'profile' => $profile
248
        );
249
    }
250
251
    /**
252
     * Changes the status of an application
253
     *
254
     * @return array
0 ignored issues
show
Documentation introduced by
Should the return type not be \Zend\Stdlib\ResponseInt...Applications\Form\Mail>?

This check compares the return type specified in the @return annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.

Loading history...
255
     */
256
    public function statusAction()
257
    {
258
        $applicationId = $this->params('id');
259
        /* @var \Applications\Repository\Application $repository */
260
        $repository    = $this->getServiceLocator()->get('repositories')->get('Applications/Application');
261
        /* @var Application $application */
262
        $application   = $repository->find($applicationId);
263
        if (!$application) {
264
            throw new \InvalidArgumentException('Could not find application.');
265
        }
266
        
267
        $this->acl($application, 'change');
0 ignored issues
show
Unused Code introduced by
The call to ManageController::acl() has too many arguments starting with $application.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
268
        
269
        $jsonFormat    = 'json' == $this->params()->fromQuery('format');
270
        $status        = $this->params('status', Status::CONFIRMED);
271
        $settings = $this->settings();
0 ignored issues
show
Documentation Bug introduced by
The method settings does not exist on object<Applications\Controller\ManageController>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
272
        
273
        if (in_array($status, array(Status::INCOMING))) {
274
            $application->changeStatus($status);
275
            if ($this->request->isXmlHttpRequest()) {
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Zend\Stdlib\RequestInterface as the method isXmlHttpRequest() does only exist in the following implementations of said interface: ZendTest\Mvc\Controller\TestAsset\Request, Zend\Http\PhpEnvironment\Request, Zend\Http\Request.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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 implementation 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 interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
276
                $response = $this->getResponse();
277
                $response->setContent('ok');
278
                return $response;
279
            }
280
            if ($jsonFormat) {
281
                return array(
282
                    'status' => 'success',
283
                );
284
            }
285
            return $this->redirect()->toRoute('lang/applications/detail', array(), true);
0 ignored issues
show
Documentation introduced by
true is of type boolean, but the function expects a array.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
286
        }
287
        $mailService = $this->getServiceLocator()->get('Core/MailService');
288
        /* @var \Applications\Mail\StatusChange $mail */
289
        $mail = $mailService->get('Applications/StatusChange');
290
        $mail->setApplication($application);
291
        if ($this->request->isPost()) {
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Zend\Stdlib\RequestInterface as the method isPost() does only exist in the following implementations of said interface: ZendTest\Mvc\Controller\TestAsset\Request, Zend\Http\PhpEnvironment\Request, Zend\Http\Request.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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 implementation 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 interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
292
            $mail->setSubject($this->params()->fromPost('mailSubject'));
293
            $mail->setBody($this->params()->fromPost('mailText'));
294
            if ($from = $application->getJob()->getContactEmail()) {
295
                $mail->setFrom($from, $application->getJob()->getCompany());
0 ignored issues
show
Deprecated Code introduced by
The method Jobs\Entity\JobInterface::getCompany() has been deprecated.

This method has been deprecated.

Loading history...
296
            }
297
            if ($this->settings()->mailBCC) {
0 ignored issues
show
Documentation Bug introduced by
The method settings does not exist on object<Applications\Controller\ManageController>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
298
                $user = $this->auth()->getUser();
299
                $mail->addBcc($user->getInfo()->getEmail(), $user->getInfo()->getDisplayName());
300
            }
301
            $mailService->send($mail);
302
303
            $historyText = sprintf('Mail was sent to %s', $application->getContact()->getEmail());
304
            $application->changeStatus($status, $historyText);
305
            $this->notification()->success($historyText);
306
307
            if ($jsonFormat) {
308
                return array(
309
                    'status' => 'success',
310
                );
311
            }
312
            return $this->redirect()->toRoute('lang/applications/detail', array(), true);
0 ignored issues
show
Documentation introduced by
true is of type boolean, but the function expects a array.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
313
        }
314
        
315
        $translator = $this->getServiceLocator()->get('translator');
316
        switch ($status) {
317
            default:
0 ignored issues
show
Unused Code introduced by
default: does not seem to be reachable.

This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed.

Unreachable code is most often the result of return, die or exit statements that have been added for debug purposes.

function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}

In the above example, the last return false will never be executed, because a return statement has already been met in every possible execution path.

Loading history...
318
            case Status::CONFIRMED:
319
                $key = 'mailConfirmationText';
320
                break;
321
            case Status::INVITED:
322
                $key = 'mailInvitationText';
323
                break;
324
            case Status::REJECTED:
325
                $key = 'mailRejectionText';
326
                break;
327
            default:
328
                throw new \InvalidArgumentException('Unknown status value.');
329
        }
330
        $mailText      = $settings->$key ? $settings->$key : '';
331
        $this->notification()->success($mailText);
332
        $mail->setBody($mailText);
333
        $mailText = $mail->getBodyText();
334
        $mailSubject   = sprintf(
335
            $translator->translate('Your application dated %s'),
336
            strftime('%x', $application->getDateCreated()->getTimestamp())
337
        );
338
        
339
        $params = array(
340
                'applicationId' => $applicationId,
341
                'status'        => $status,
342
                'mailSubject'   => $mailSubject,
343
                'mailText'      => $mailText
344
            );
345
        if ($jsonFormat) {
346
            return $params;
347
        }
348
349
        /* @var \Applications\Form\Mail $form */
350
        $form = $this->getServiceLocator()->get('FormElementManager')->get('Applications/Mail');
351
        $form->populateValues($params);
352
                
353
        return ['form' => $form];
354
    }
355
    
356
    /**
357
     * Forwards an application via Email
358
     *
359
     * @throws \InvalidArgumentException
360
     * @return \Zend\View\Model\JsonModel
361
     */
362
    public function forwardAction()
363
    {
364
        $services     = $this->getServiceLocator();
365
        $emailAddress = $this->params()->fromQuery('email');
366
        /* @var \Applications\Entity\Application $application */
367
        $application  = $services->get('repositories')->get('Applications/Application')
368
                                 ->find($this->params('id'));
369
        
370
        $this->acl($application, 'forward');
0 ignored issues
show
Unused Code introduced by
The call to ManageController::acl() has too many arguments starting with $application.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
371
        
372
        $translator   = $services->get('translator');
373
         
374
        if (!$emailAddress) {
375
            throw new \InvalidArgumentException('An email address must be supplied.');
376
        }
377
        
378
        $params = array(
379
            'ok' => true,
380
            'text' => sprintf($translator->translate('Forwarded application to %s'), $emailAddress)
381
        );
382
        
383
        try {
384
            $userName    = $this->auth('info')->displayName;
0 ignored issues
show
Bug introduced by
The property displayName does not seem to exist in Auth\Controller\Plugin\Auth.

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
Unused Code introduced by
The call to ManageController::auth() has too many arguments starting with 'info'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
385
            $fromAddress = $application->getJob()->getContactEmail();
386
            $mailOptions = array(
387
                'application' => $application,
388
                'to'          => $emailAddress,
389
                'from'        => array($fromAddress => $userName)
390
            );
391
            $this->mailer('Applications/Forward', $mailOptions, true);
0 ignored issues
show
Unused Code introduced by
The call to ManageController::mailer() has too many arguments starting with 'Applications/Forward'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
392
            $this->notification()->success($params['text']);
393
        } catch (\Exception $ex) {
394
            $params = array(
395
                'ok' => false,
396
                'text' => sprintf($translator->translate('Forward application to %s failed.'), $emailAddress)
397
            );
398
            $this->notification()->error($params['text']);
399
400
        }
401
        $application->changeStatus($application->getStatus(), $params['text']);
402
        return new JsonModel($params);
403
    }
404
405
    /**
406
     * Deletes an application
407
     *
408
     * @return array
0 ignored issues
show
Documentation introduced by
Should the return type not be array<string,string>|null?

This check compares the return type specified in the @return annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.

Loading history...
409
     */
410
    public function deleteAction()
411
    {
412
        $id          = $this->params('id');
413
        $services    = $this->getServiceLocator();
414
        $repositories= $services->get('repositories');
415
        $repository  = $repositories->get('Applications/Application');
416
        $application = $repository->find($id);
417
        
418
        if (!$application) {
419
            throw new \DomainException('Application not found.');
420
        }
421
        
422
        $this->acl($application, 'delete');
0 ignored issues
show
Unused Code introduced by
The call to ManageController::acl() has too many arguments starting with $application.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
423
        
424
        $repositories->remove($application);
425
        
426
        if ('json' == $this->params()->fromQuery('format')) {
427
            return ['status' => 'success'];
428
        }
429
        
430
        $this->redirect()->toRoute('lang/applications', array(), true);
0 ignored issues
show
Documentation introduced by
true is of type boolean, but the function expects a array.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
431
    }
432
}