IndexController - Code Metrics - Inspection of "[Core] adds pageRange to the paginator. Removed "f..." - cross-solution/YAWIK - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 312a9e...d5555a )

unknown

created 2016-02-23 18:18 UTC

IndexController C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	323
Duplicated Lines	23.84 %

Coupling/Cohesion

Components	1
Dependencies	19

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
wmc	44
c	1
b	0
f	1
lcom	1
cbo	19
dl	77
loc	323
rs	5.5062

4 Methods

Rating	Name	Duplication	Size	Complexity
A	attachDefaultListeners()	0	9	1
F	indexAction()	50	218	31
B	dashboardAction()	24	24	3
C	mailAction()	3	47	9

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like IndexController often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use IndexController, and based on these observations, apply Extract Interface, too.

<?php
/**
 * YAWIK
 *
 * @filesource
 * @copyright (c) 2013 - 2016 Cross Solution (http://cross-solution.de)
 * @license   MIT
 */

/** Applications controller */
namespace Applications\Controller;

use Auth\Entity\Info;
use Applications\Entity\Application;
use Zend\Http\Request;
use Zend\Mvc\Controller\AbstractActionController;
use Zend\View\Model\ViewModel;
use Zend\View\Model\JsonModel;
use Applications\Entity\Status;
use Applications\Entity\StatusInterface;

/**
 * Main Action Controller for Applications module.
 *
 * @method \Core\Controller\Plugin\Notification notification()
 * @method \Core\Controller\Plugin\CreatePaginator paginator()
 * @method \Auth\Controller\Plugin\Auth auth()
 * @method \Acl\Controller\Plugin\Acl acl()
 */
class IndexController extends AbstractActionController
{
    /**
     * attaches further Listeners for generating / processing the output
     * @return $this
     */
    public function attachDefaultListeners()
    {
        parent::attachDefaultListeners();
        $serviceLocator  = $this->getServiceLocator();
        $defaultServices = $serviceLocator->get('DefaultListeners');
        $events          = $this->getEventManager();
        $events->attach($defaultServices);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        return $this;
    }


    /**
     * Processes formular data of the application form
     *
     * @return \Zend\View\Model\ViewModel
     */
    public function indexAction()
    {
        $services = $this->getServiceLocator();
        /** @var Request $request */
        $request = $this->getRequest();

        $jobId = $this->params()->fromPost('jobId', 0);
        $applyId = (int) $this->params()->fromPost('applyId', 0);
        
        // subscriber comes from the form
        $subscriberUri = $this->params()->fromPost('subscriberUri', '');
        if (empty($subscriberUri)) {
            // subscriber comes with the request of the form
            // which implies that the backlink in the job-offer had such an link in the query
            $subscriberUri = $this->params()->fromQuery('subscriberUri', '');
        }
        if (empty($subscriberUri)) {
            // the subscriber comes from an external module, maybe after interpreting the backlink, or the referer
            $e = $this->getEvent();
            $subscriberResponseCollection = $this->getEventManager()->trigger('subscriber.getUri', $e);
            if (!$subscriberResponseCollection->isEmpty()) {
                $subscriberUri = $subscriberResponseCollection->last();
            }
        }


        $job = ($request->isPost() && !empty($jobId))
             ? $services->get('repositories')->get('Jobs/Job')->find($jobId)
             : $services->get('repositories')->get('Jobs/Job')->findOneBy(array("applyId"=>(0 == $applyId)?$this->params('jobId'):$applyId));
        
        
        if (!$job) {

            $this->response->setStatusCode(410);
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.
    }
}
            $model = new ViewModel(
                array(
                'content' => /*@translate*/ 'Invalid apply id'
                )
            );
            $model->setTemplate('auth/index/job-not-found.phtml');
            return $model;
        }

        /* @var $form \Zend\Form\Form */
        $form = $services->get('FormElementManager')->get('Application/Create');
        $form->setValidate();
        
        $viewModel = new ViewModel();
        $viewModel->setVariables(
            array(
            'job' => $job,
            'form' => $form,
            'isApplicationSaved' => false,
            'subscriberUri' => $subscriberUri,
            )
        );
        
        $applicationEntity = new Application();
        $applicationEntity->setJob($job);

        if ($this->auth()->isLoggedIn()) {
            // copy the contact info into the application
            $contact = new Info();
            $contact->fromArray(Info::toArray($this->auth()->get('info')));

            $applicationEntity->setContact($contact);
        }
        
        $form->bind($applicationEntity);
        $form->get('jobId')->setValue($job->id);
        $form->get('subscriberUri')->setValue($subscriberUri);
       
        if ($request->isPost()) {
            if ($returnTo = $this->params()->fromPost('returnTo', false)) {
                $returnTo = \Zend\Uri\UriFactory::factory($returnTo);
            }
            $services = $this->getServiceLocator();

            $data = array_merge_recursive(
                $this->request->getPost()->toArray(),
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.
    }
}
                $this->request->getFiles()->toArray()
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.
    }
}
            );
            
            if (!empty($subscriberUri) && $request->isPost()) {
                $subscriber = $services->get('repositories')->get('Applications/Subscriber')->findbyUriOrCreate($subscriberUri);
                $applicationEntity->subscriber = $subscriber;
<?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.");
        }
    }

}
            }
            
            $form->setData($data);
            
            if (!$form->isValid()) {
                if ($request->isXmlHttpRequest()) {
                    return new JsonModel(
                        array(
                        'ok' => false,
                        'messages' => $form->getMessages()
                        )
                    );
                }
                if ($returnTo) {

                    $returnTo->setQuery($returnTo->getQueryAsArray() + array('status' => 'failure'));
                    return $this->redirect()->toUrl((string) $returnTo);
                }
                $this->notification()->error(/*@translate*/ 'There were errors in the form.');

            } else {
                $auth = $this->auth();
            
                if ($auth->isLoggedIn()) {
                    // in instance user is logged in,
                    // and no image is uploaded
                    // take his profile-image as copy
                    $applicationEntity->setUser($auth->getUser());
                    $imageData = $form->get('contact')->get('image')->getValue();
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.
    }
}
                    if (UPLOAD_ERR_NO_FILE == $imageData['error']) {
                        // has the user an image
                        $image = $auth->getUser()->info->image;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
                        if ($image) {
                            $repositoryAttachment = $services->get('repositories')->get('Applications/Attachment');

                            // this should provide a real copy, not just a reference
                            $contactImage = $repositoryAttachment->copy($image);
                            $applicationEntity->contact->setImage($contactImage);
<?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.");
        }
    }

}
                        } else {
                            $applicationEntity->contact->setImage(null); //explicitly remove image.
<?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.");
        }
    }

}
                        }
                    }
                }
                
                if (!$request->isXmlHttpRequest()) {
                    $applicationEntity->setStatus(new Status());
                    $permissions = $applicationEntity->getPermissions();
                    $permissions->inherit($job->getPermissions());

                    /*
                     * New Application alert Mails to job recruiter
                     * This is temporary until Companies are implemented.
                     */
                    $recruiter = $services->get('repositories')->get('Auth/User')->findOneByEmail($job->contactEmail);
                    if (!$recruiter) {

                        $recruiter = $job->user;
$myVar = 'Value';
$higher = false;

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

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
                    } else {
                        $admin     = $job->user;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
                    }
                
                    $services->get('repositories')->store($applicationEntity);
                    /*
                     * New Application alert Mails to job recruiter
                     * This is temporary until Companies are implemented.
                     */
                    $recruiter = $services->get('repositories')->get('Auth/User')->findOneByEmail($job->contactEmail);
                    if (!$recruiter) {

                        $recruiter = $job->user;
                        $admin     = false;
                    } else {
                        $admin     = $job->user;
                    }
                
                    if ($recruiter->getSettings('Applications')->getMailAccess()) {
                        $this->mailer('Applications/NewApplication', array('job' => $job, 'user' => $recruiter, 'admin' => $admin), /*send*/ true);
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 { }
                    }
                    if ($recruiter->getSettings('Applications')->getAutoConfirmMail()) {

                        $ackBody = $recruiter->getSettings('Applications')->getMailConfirmationText();
                        if (empty($ackBody)) {
                            $ackBody = $job->user->getSettings('Applications')->getMailConfirmationText();
                        }
                        if (!empty($ackBody)) {
                            /* Acknowledge mail to the applicant */
                            $ackMail = $this->mailer(
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 { }
                                'Applications/Confirmation',
                                array('application' => $applicationEntity,
                                                  'body' => $ackBody,
                                            )
                            );
                            // Must be called after initializers in creation
                            $ackMail->setSubject(/*@translate*/ 'Application confirmation');
                            $ackMail->setFrom($recruiter->getInfo()->getEmail());
                            $this->mailer($ackMail);
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 { }
                            $applicationEntity->changeStatus(StatusInterface::CONFIRMED, sprintf('Mail was sent to %s', $applicationEntity->contact->email));
<?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.");
        }
    }

}
                        }
                    }

                    // send carbon copy of the application

                    $paramsCC = $this->getRequest()->getPost('carboncopy', 0);
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.
    }
}
                    if (isset($paramsCC) && array_key_exists('carboncopy', $paramsCC)) {
                        $wantCarbonCopy = (int) $paramsCC['carboncopy'];
                        if ($wantCarbonCopy) {
                             $mail = $this->mailer(
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 { }
                                 'Applications/CarbonCopy',
                                 array(
                                    'application' => $applicationEntity,
                                    'to'          => $applicationEntity->contact->email,
<?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.");
        }
    }

}
                                 ), /*send*/
                                 true
                             );
                        }
                    }
                }

                if ($request->isXmlHttpRequest()) {
                    return new JsonModel(
                        array(
                        'ok' => true,
                        'id' => $applicationEntity->id,
<?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.");
        }
    }

}
                        'jobId' => $applicationEntity->job->id,
<?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.");
        }
    }

}
                        )
                    );
                }
                if ($returnTo) {

                    $returnTo->setQuery($returnTo->getQueryAsArray() + array('status' => 'success'));
                    return $this->redirect()->toUrl((string) $returnTo);
                }
                $this->notification()->success(/*@translate*/ 'your application was sent successfully');
                $viewModel->setVariable('isApplicationSaved', true);
            }
        }
        return $viewModel;
    }
    
    /**
     * Handles dashboard listings of applications
     *
     * @return array
     */
    public function dashboardAction()

    {
        $params = $this->getRequest()->getQuery();
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.
    }
}
        $isRecruiter = $this->acl()->isRole('recruiter');
        if ($isRecruiter) {
            $params->set('by', 'me');
        }

         //default sorting
        if (!isset($params['sort'])) {
            $params['sort']="-date";
        }
        $params->count = 5;
        $params->pageRange=5;

        $this->paginationParams()->setParams('Applications\Index', $params);


        $paginator = $this->paginator('Applications/Application', $params);

     
        return array(
            'script' => 'applications/index/dashboard',
            'applications' => $paginator
        );
    }

    /**
     * sends a test-mail with all application-data to the applicant
     * @return JsonModel
     */
    public function mailAction()
    {
        $services          = $this->getServiceLocator();
        $config            = $services->get('Config');
        $applicationId     = $this->getRequest()
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.
    }
}
                                  ->getQuery('id');
        $status            = $this->params('status');
        $repositories      = $services->get('repositories');
        $entityApplication = $repositories->get('Applications/Application')->find($applicationId);
        if (empty($entityApplication)) {
            $this->notification()->error(/*@translate*/ 'Application has been deleted.');
        } else {
            $jobEntity         = $entityApplication->job;
            $applicantEmail    = $entityApplication->contact->email;
            $organizationEmail = $jobEntity->contactEmail;
            $mailAddress        = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
            switch ($status == 'test') {
                case 'company':
                    $mailAddress = $organizationEmail;
                    break;
                case 'test':
                default:
                    $mailAddress = $applicantEmail;
                    break;
            }
            if (!empty($mailAddress)) {
                $mailData = array(
                    'application' => $entityApplication,
                    'to'          => $mailAddress
                );
                if (array_key_exists('mails', $config) && array_key_exists('from', $config['mails']) && array_key_exists('email', $config['mails']['from'])) {

                    $mailData['from'] = $config['mails']['from']['email'];
                }

                $mail = $this->mailer('Applications/CarbonCopy', $mailData, true);
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 { }
                $this->notification()
                     ->success(/*@translate*/ 'Mail has been send');
                if ($status == 'company') {
                    $repositories->remove($entityApplication);
                    $this->notification()->info(/*@translate*/ 'Application data has been deleted');
                }
            } else {
                $this->notification()->error(/*@translate*/ 'No mail adress available');
            }
        }
        return new JsonModel(array());
    }
}


Push — develop ( 312a9e...d5555a )

IndexController C

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

cross-solution / YAWIK

Push — develop ( 312a9e...d5555a )

IndexController C

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like