ProfileController::detailAction() - Code Metrics - Inspection of "Merge pull request #462: Organization profiles (#4..." - cross-solution/YAWIK - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 09456b...2094a2 )

by Mathias

created 2018-02-15 15:22 UTC

ProfileController::detailAction() B

↳ Parent: ProfileController

Complexity

Conditions	7
Paths	6

Size

Total Lines	58
Code Lines	36

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	58
rs	7.6045
cc	7
eloc	36
nc	6
nop	0

How to fix Long Method

<?php

/**
 * YAWIK
 *
 * @filesource
 * @license MIT
 * @copyright  2013 - 2017 Cross Solution <http://cross-solution.de>
 */

namespace Organizations\Controller;


use Auth\Exception\UnauthorizedAccessException;
use Core\Entity\Exception\NotFoundException;
use Jobs\Repository\Job as JobRepository;
use Organizations\Entity\Organization;
use Organizations\Repository\Organization as OrganizationRepository;
use Zend\Http\Response;
use Zend\I18n\Translator\TranslatorInterface;
use Zend\Mvc\Controller\AbstractActionController;
use Zend\View\Model\ViewModel;
use Organizations\ImageFileCache\Manager as ImageFileCacheManager;

/**
 * Class ProfileController
 *
 * @author Anthonius Munthi <[email protected]>
 * @package Organizations\Controller
 * @since 0.30.1
 */
class ProfileController extends AbstractActionController
{
    /**
     * @var OrganizationRepository
     */
    private $repo;

    /**
     * @var JobRepository
     */
    private $jobRepo;

    /**
     * @var TranslatorInterface
     */
    private $translator;

    /**
     * @var ImageFileCacheManager
     */
    private $imageFileCacheManager;

    /**
     * @var array
     */
    private $options = [
        'count' => 10,
    ];

    public function __construct(
        OrganizationRepository $repo,
        JobRepository $jobRepository,
        TranslatorInterface $translator,
        ImageFileCacheManager $imageFileCacheManager,
        $options
    )
    {
        $this->repo = $repo;
        $this->translator = $translator;
        $this->imageFileCacheManager = $imageFileCacheManager;
        $this->jobRepo = $jobRepository;
        $this->options = $options;
    }

    /**
     * List organization
     *
     * @return ViewModel
     */
    public function indexAction()
    {

        $result = $this->pagination([
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 { }
            'params' => ['Organizations_Profile',[
                    'q',
                    'count' => $this->options['count'],
                    'page' => 1,
                ]
            ],
            'paginator' => [
                'Organizations/Organization',
                'as' => 'organizations',
                'params' => [
                    'type' => 'profile',
                ]
            ],
            'form' => [
                'Core/Search',
                'as' => 'form',
            ]
        ]);
        return new ViewModel($result);
    }

    /**
     * @return array|ViewModel
     */
    public function detailAction()
    {
        $translator      = $this->translator;
        $repo            = $this->repo;
        $id              = $this->params('id');

        if(is_null($id)){
            $this->getResponse()->setStatusCode(Response::STATUS_CODE_404);
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.
    }
}
            return [
                'message' => $translator->translate('Can not access profile page without id'),
                'exception' => new \InvalidArgumentException('Null Organization Profile Id')
            ];
        }

        $organization = $repo->find($id);
        if(!$organization instanceof Organization){
            throw new NotFoundException($id);
        }

        if(
            Organization::PROFILE_DISABLED == $organization->getProfileSetting()
            || is_null($organization->getProfileSetting())
        ){
            throw new UnauthorizedAccessException(/*@translate*/ 'This Organization Profile is disabled');
        }

        $result = $this->pagination([
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 { }
            'params' => [
                'Organization_Jobs',[
                    'q',
                    'organization_id' => $organization->getId(),
                    'count' => $this->options['count'],
                    'page' => 1,
                ],
            ],
            'paginator' => [
                'as' => 'jobs',
                'Organizations/ListJob',
            ],
        ]);

        if(
            Organization::PROFILE_ACTIVE_JOBS == $organization->getProfileSetting()
        ){
            /* @var \Zend\Paginator\Paginator $paginator */
            $paginator = $result['jobs'];
            $count = $paginator->getTotalItemCount();
            if(0===$count){
                throw new UnauthorizedAccessException($this->translator->translate('This Organization Profile is disabled'));
            }
        }
        $result['organization'] = $organization;
        $result['organizationImageCache'] = $this->imageFileCacheManager;

        /* @var \Zend\Mvc\Controller\Plugin\Url $url */
        $result['paginationControlRoute'] = 'lang/organizations/profileDetail';
        return new ViewModel($result);
    }
}


1			<?php
2
3			/**
4			* YAWIK
5			*
6			* @filesource
7			* @license MIT
8			* @copyright 2013 - 2017 Cross Solution <http://cross-solution.de>
9			*/
10
11			namespace Organizations\Controller;
12
13
14			use Auth\Exception\UnauthorizedAccessException;
15			use Core\Entity\Exception\NotFoundException;
16			use Jobs\Repository\Job as JobRepository;
17			use Organizations\Entity\Organization;
18			use Organizations\Repository\Organization as OrganizationRepository;
19			use Zend\Http\Response;
20			use Zend\I18n\Translator\TranslatorInterface;
21			use Zend\Mvc\Controller\AbstractActionController;
22			use Zend\View\Model\ViewModel;
23			use Organizations\ImageFileCache\Manager as ImageFileCacheManager;
24
25			/**
26			* Class ProfileController
27			*
28			* @author Anthonius Munthi <[email protected]>
29			* @package Organizations\Controller
30			* @since 0.30.1
31			*/
32			class ProfileController extends AbstractActionController
33			{
34			/**
35			* @var OrganizationRepository
36			*/
37			private $repo;
38
39			/**
40			* @var JobRepository
41			*/
42			private $jobRepo;
43
44			/**
45			* @var TranslatorInterface
46			*/
47			private $translator;
48
49			/**
50			* @var ImageFileCacheManager
51			*/
52			private $imageFileCacheManager;
53
54			/**
55			* @var array
56			*/
57			private $options = [
58			'count' => 10,
59			];
60
61			public function __construct(
62			OrganizationRepository $repo,
63			JobRepository $jobRepository,
64			TranslatorInterface $translator,
65			ImageFileCacheManager $imageFileCacheManager,
66			$options
67			)
68			{
69			$this->repo = $repo;
70			$this->translator = $translator;
71			$this->imageFileCacheManager = $imageFileCacheManager;
72			$this->jobRepo = $jobRepository;
73			$this->options = $options;
74			}
75
76			/**
77			* List organization
78			*
79			* @return ViewModel
80			*/
81			public function indexAction()
82			{
83
84			$result = $this->pagination([
			0 ignored issues – show Documentation Bug introduced 2018-02-14 16:39 UTC by Report Bug Copy Issue Report The method `pagination` does not exist on `object<Organizations\Con...ller\ProfileController>`? 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...
85			'params' => ['Organizations_Profile',[
86			'q',
87			'count' => $this->options['count'],
88			'page' => 1,
89			]
90			],
91			'paginator' => [
92			'Organizations/Organization',
93			'as' => 'organizations',
94			'params' => [
95			'type' => 'profile',
96			]
97			],
98			'form' => [
99			'Core/Search',
100			'as' => 'form',
101			]
102			]);
103			return new ViewModel($result);
104			}
105
106			/**
107			* @return array\|ViewModel
108			*/
109			public function detailAction()
110			{
111			$translator = $this->translator;
112			$repo = $this->repo;
113			$id = $this->params('id');
114
115			if(is_null($id)){
116			$this->getResponse()->setStatusCode(Response::STATUS_CODE_404);
			0 ignored issues – show Bug introduced 2016-05-13 10:54 UTC by Report Bug Copy Issue Report 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 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 interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
117			return [
118			'message' => $translator->translate('Can not access profile page without id'),
119			'exception' => new \InvalidArgumentException('Null Organization Profile Id')
120			];
121			}
122
123			$organization = $repo->find($id);
124			if(!$organization instanceof Organization){
125			throw new NotFoundException($id);
126			}
127
128			if(
129			Organization::PROFILE_DISABLED == $organization->getProfileSetting()
130			\|\| is_null($organization->getProfileSetting())
131			){
132			throw new UnauthorizedAccessException(/@translate/ 'This Organization Profile is disabled');
133			}
134
135			$result = $this->pagination([
			0 ignored issues – show Documentation Bug introduced 2018-02-09 00:14 UTC by Report Bug Copy Issue Report The method `pagination` does not exist on `object<Organizations\Con...ller\ProfileController>`? 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...
136			'params' => [
137			'Organization_Jobs',[
138			'q',
139			'organization_id' => $organization->getId(),
140			'count' => $this->options['count'],
141			'page' => 1,
142			],
143			],
144			'paginator' => [
145			'as' => 'jobs',
146			'Organizations/ListJob',
147			],
148			]);
149
150			if(
151			Organization::PROFILE_ACTIVE_JOBS == $organization->getProfileSetting()
152			){
153			/* @var \Zend\Paginator\Paginator $paginator */
154			$paginator = $result['jobs'];
155			$count = $paginator->getTotalItemCount();
156			if(0===$count){
157			throw new UnauthorizedAccessException($this->translator->translate('This Organization Profile is disabled'));
158			}
159			}
160			$result['organization'] = $organization;
161			$result['organizationImageCache'] = $this->imageFileCacheManager;
162
163			/* @var \Zend\Mvc\Controller\Plugin\Url $url */
164			$result['paginationControlRoute'] = 'lang/organizations/profileDetail';
165			return new ViewModel($result);
166			}
167			}
168

cross-solution / YAWIK

Push — develop ( 09456b...2094a2 )

ProfileController::detailAction() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like