ImportController - Code Metrics - Inspection of "[Jobs] allow to set a description via the API" - cross-solution/YAWIK - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 7df659...40d27c )

unknown

created 2016-06-18 19:11 UTC

ImportController C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	245
Duplicated Lines	3.67 %

Coupling/Cohesion

Components	1
Dependencies	17

Importance

Changes	4
Bugs	2	Features	0

Metric	Value
wmc	42
c	4
b	2
f	0
lcom	1
cbo	17
dl	9
loc	245
rs	6.5405

2 Methods

Rating	Name	Duplication	Size	Complexity
A	attachDefaultListeners()	9	9	1
F	saveAction()	0	223	41

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 ImportController 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 ImportController, and based on these observations, apply Extract Interface, too.

<?php

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

/** ActionController of Core */
namespace Jobs\Controller;

use Geo\Entity\Geometry\Point;
use Jobs\Entity\Location;
use Jobs\Entity\TemplateValues;
use Organizations\Entity\Employee;
use Zend\Json\Json;
use Zend\Mvc\Controller\AbstractActionController;
use Zend\View\Model\JsonModel;
use Zend\Stdlib\Parameters;
use Core\Entity\PermissionsInterface;
use Jobs\Listener\Events\JobEvent;
use Jobs\Listener\Response\JobResponse;

/**
 *
 *
 */
class ImportController extends AbstractActionController
{

    /**
     * attaches further Listeners for generating / processing the output
     * @return $this
     */
    public function attachDefaultListeners()

    {
        parent::attachDefaultListeners();
        $serviceLocator  = $this->serviceLocator;
        $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;
    }

    /**
     * api-interface for transferring jobs
     * @return JsonModel
     */
    public function saveAction()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $services = $this->serviceLocator;

        /* @var \Zend\Http\PhpEnvironment\Request $request */
        $request = $this->getRequest();

        $params          = $this->params();
        $p               = $params->fromPost();
        $user            = $services->get('AuthenticationService')->getUser();
        $repositories    = $services->get('repositories');
        /* @var \Jobs\Repository\Job $repositoriesJob */
        $repositoriesJob = $repositories->get('Jobs/Job');
        $log             = $services->get('Core/Log');

        $result = array('token' => session_id(), 'isSaved' => false, 'message' => '', 'portals' => array());
        try {
            if (isset($user) && !empty($user->login)) {
                $formElementManager = $services->get('FormElementManager');
                /* @var \Jobs\Form\Import $form */
                $form               = $formElementManager->get('Jobs/Import');
                $id                 = $params->fromPost('id'); // determine Job from Database
                /* @var \Jobs\Entity\Job $entity */
                $entity             = null;
                $createdJob         = true;

                if (empty($id)) {
                    $applyId = $params->fromPost('applyId');
                    if (empty($applyId)) {
                        $entity = $repositoriesJob->create();
                    } else {
                        $entity = $repositoriesJob->findOneBy(array("applyId" => (string) $applyId));
                        if (!isset($entity)) {
                            // new Job (the more likely branch)
                            $entity =$repositoriesJob->create(array("applyId" => (string) $applyId));
                        } else {
                            $createdJob = false;
                        }
                    }
                } else {
                    $repositoriesJob->find($id);
                    $createdJob = false;
                }
                //$services->get('repositories')->get('Jobs/Job')->store($entity);

                $form->bind($entity);
                if ($request->isPost()) {
                    $loginSuffix                   = '';
                    $event                         = $this->getEvent();
                    $loginSuffixResponseCollection = $this->getEventManager()->trigger('login.getSuffix', $event);
                    if (!$loginSuffixResponseCollection->isEmpty()) {
                        $loginSuffix = $loginSuffixResponseCollection->last();
                    }
                    $params                        = $request->getPost();
                    $params->datePublishStart      = \Datetime::createFromFormat("Y-m-d", $params->datePublishStart);
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
                    $result['post']                = $_POST;
                    $form->setData($params);
                    if ($form->isValid()) {

                        if (isset($params['templateValues']['description-description'])) {
                            $templateValues = new TemplateValues();
                            $entity->setTemplateValues($templateValues->setDescription(strip_tags($params['templateValues']['description-description'])));
                        }

                        $entity->setStatus($params['status']);
                        /*
                         * Search responsible user via contactEmail
                         */
                        $users = $repositories->get('Auth/User');
                        $responsibleUser = $users->findByEmail($params['contactEmail']);

                        $entity->setUser($responsibleUser ?: $user);

                        $group = $user->getGroup($entity->getCompany());
                        if ($group) {
                            $entity->getPermissions()->grant($group, PermissionsInterface::PERMISSION_VIEW);
                        }
                        $result['isSaved'] = true;
                        $log->info('Jobs/manage/saveJob [user: ' . $user->login . ']:' . var_export($p, true));

                        if (!empty($params->companyId)) {
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
                            $companyId                = $params->companyId . $loginSuffix;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
                            $repOrganization          = $repositories->get('Organizations/Organization');
                            $hydratorManager          = $services->get('hydratorManager');
                            /* @var \Organizations\Entity\Hydrator\OrganizationHydrator $hydrator */
                            $hydrator                 = $hydratorManager->get('Hydrator/Organization');
                            $entityOrganizationFromDB = $repOrganization->findbyRef($companyId);
                            //$permissions              = $entityOrganizationFromDB->getPermissions();

                            $data = array(
                                'externalId'      => $companyId,
                                'organizationName' => $params->company,
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
                                'image'            => $params->logoRef,
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
                                'user'            => $user
                            );
                            //$permissions->grant($user, PermissionsInterface::PERMISSION_CHANGE);


                            $entityOrganization = $hydrator->hydrate($data, $entityOrganizationFromDB);
                            if ($responsibleUser && $user !== $responsibleUser) {
                                /*
                                 * We cannot use custom collections yet
                                 * @todo if we updated Mongo ODM to >1.0.5, we must move this to
                                 *       a custom collection class
                                 */
                                $employees = $entityOrganization->getEmployees();
                                $contained = false;
                                /*
                                 * this is o(n) and should propably be optimized when the custom collection is created.
                                 * It's not very performant to load the whole user entity, when all we need is the ID.
                                 * Maybe store the id as reference in the Employees Entity.
                                 */
                                foreach ($employees as $employee) {
                                    if ($employee->getUser()->getId() == $responsibleUser->getId()) {
                                        $contained = true;
                                        break;
                                    }
                                }
                                if (!$contained) {
                                    $employees->add(new Employee($responsibleUser));
                                }
                            }
                            $repositories->store($entityOrganization);
                            $entity->setOrganization($entityOrganization);
                        } else {
                            $result['message'] = '';
                        }

                        if (!empty($params->locations)) {
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
                            $locations = \Zend\Json\Json::decode($params->locations, \Zend\Json\Json::TYPE_ARRAY);
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
                            $jobLocations = $entity->getLocations();
                            $jobLocations->clear();
                            foreach ($locations as $locData) {
                                $location = new Location();
                                $coords = array_map(function ($i) { return (float) $i; }, $locData['coordinates']);
                                $location->setCountry($locData['country'])
                                         ->setRegion($locData['region'])
                                         ->setCity($locData['city'])
                                         ->setCoordinates(new Point($coords));

                                $jobLocations->add($location);
                            }
                        }
                        $repositoriesJob->store($entity);
                        $id = $entity->getId();
                        if (!empty($id)) {
                            $jobEvent = $services->get('Jobs/Event');
                            $jobEvent->setJobEntity($entity);

                            $extra = [];
                            foreach (array('channels', 'positions', 'branches', 'keywords', 'description') as $paramName) {
                                $data = $params->get($paramName);
                                if ($data) {
                                    $data = Json::decode($data, Json::TYPE_ARRAY);
                                    if ('channels' == $paramName) {
                                        foreach (array_keys($data) as $portalName) {
                                            $jobEvent->addPortal($portalName);
                                        }
                                    }

                                    $extra[$paramName] = $data;
                                }
                            }
                            $jobEvent->setParam('extraData', $extra);

                            if ($createdJob || true) {
                                /* @var $jobEvents \Zend\EventManager\EventManager */
                                $jobEvents = $services->get('Jobs/Events');
                                $jobEvent->setName(JobEvent::EVENT_JOB_ACCEPTED)
                                         ->setTarget($this);
                                $responses = $jobEvents->trigger($jobEvent);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                                foreach ($responses as $response) {
                                    // responses from the portals
                                    // @TODO, put this in some conclusion and meaningful messages
                                    if (!empty($response)) {
                                        if ($response instanceof JobResponse) {
                                            if (!array_key_exists('log', $result)) {
                                                $result['log'] = '';
                                            }
                                            //$message = $response->getMessage();

                                            //$result['log'] .= $response->getMessage() . PHP_EOL;

                                            $status = $response->getStatus();
                                            $portal = $response->getPortal();
                                            if (empty($portal)) {
                                                throw new \RuntimeException('Publisher-Events (internal error): There is an unregistered publisher listening');
                                            }
                                            switch ($status) {
                                                case JobResponse::RESPONSE_FAIL:
                                                case JobResponse::RESPONSE_NOTIMPLEMENTED:
                                                case JobResponse::RESPONSE_ERROR:
                                                    $result['isSaved'] = false;
                                                    break;
                                                case JobResponse::RESPONSE_DENIED:
                                                case JobResponse::RESPONSE_OK:
                                                case JobResponse::RESPONSE_OKANDSTOP:
                                                case JobResponse::RESPONSE_DEPRECATED:
                                                    break;
                                            }
                                            if (array_key_exists($portal, $result['portals'])) {
                                                throw new \RuntimeException('Publisher-Events (internal error): There are two publisher registered for ' . $portal);
                                            }
                                            $result['portals'][$portal] = $status;
                                        } else {
                                            throw new \RuntimeException('Publisher-Events (internal error): Response must be from the class Jobs\Listener\Response\JobResponse');
                                        }
                                    } else {
                                        throw new \RuntimeException('Publisher-Events (internal error): Response must be set');
                                    }
                                }
                            }
                        }
                    } else {
                        $log->info('Jobs/manage/saveJob [error: ' . $form->getMessages() . ']:' . var_export($p, true));
                        $result['valid Error'] = $form->getMessages();
                    }
                }
            } else {
                $log->info('Jobs/manage/saveJob [error: session lost]:' . var_export($p, true));
                $result['message'] = 'session_id is lost';
            }
        } catch (\Exception $e) {
            $result['message'] = 'exception occured: ' . $e->getMessage();
        }
        //$services->get('Core/Log')->info('Jobs/manage/saveJob result:' . PHP_EOL . var_export($p, True));

        return new JsonModel($result);
    }
}


Push — develop ( 7df659...40d27c )

ImportController C

Complexity

Size/Duplication

Coupling/Cohesion

Importance

2 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

cross-solution / YAWIK

Push — develop ( 7df659...40d27c )

ImportController C

Complexity

Size/Duplication

Coupling/Cohesion

Importance

2 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

Duplication Side-by-Side

Filter issues like