ManageController::approvalAction() - Code Metrics - Inspection of "Merge Release 0.29.1" - cross-solution/YAWIK - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — develop ( 8e0188...beb977 )

unknown
created 2017-05-26 16:11 UTC
ManageController::approvalAction() B

↳ Parent: ManageController
Complexity

Conditions	5
Paths	8
Size

Total Lines	66
Code Lines	44
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
dl	0
loc	66
rs	8.6045
c	0
b	0
f	0
cc	5
eloc	44
nc	8
nop	0
How to fix Long Method

<?php

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

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

use Jobs\Entity\JobInterface;
use Jobs\Entity\JobSnapshot;
use Jobs\Entity\Status;
use Core\Repository\RepositoryService;
use Zend\Mvc\Controller\AbstractActionController;
use Zend\View\Model\ViewModel;
use Zend\View\Model\JsonModel;
use Core\Form\SummaryForm;
use Zend\Mvc\MvcEvent;
use Jobs\Listener\Events\JobEvent;
use Core\Form\SummaryFormInterface;
use Zend\Stdlib\ArrayUtils;
use Auth\AuthenticationService;
use Zend\Mvc\I18n\Translator;
use Zend\Http\PhpEnvironment\Response;
use Core\Entity\Exception\NotFoundException;

/**
 * This Controller handles management actions for jobs.
 *
 * @method \Acl\Controller\Plugin\Acl acl()
 * @method \Jobs\Controller\Plugin\InitializeJob initializeJob()
 * @method \Core\Controller\Plugin\Notification notification()
 * @method \Core\Controller\Plugin\EntitySnapshot entitySnapshot()
 *
 * @author Mathias Gelhausen <[email protected]>
 * @author Mathias Weitz <[email protected]>
 * @author Carsten Bleek <[email protected]>
 * @author Rafal Ksiazek
 * @author Miroslav Fedeleš <[email protected]>
 */
class ManageController extends AbstractActionController
{
    /**
     * @var AuthenticationService
     */
    protected $auth;

    /**
     * @var RepositoryService
     */
    protected $repositoryService;

    /**
     * @var Translator
     */
    protected $translator;

    /**
     * @param AuthenticationService $auth
     * @param RepositoryService     $repositoryService
     * @param                       $translator
     */
    public function __construct(AuthenticationService $auth, RepositoryService $repositoryService, Translator $translator)
    {
        $this->auth = $auth;
        $this->repositoryService = $repositoryService;
        $this->translator = $translator;
    }

    /**
     * @return $this|void
     */
    public function attachDefaultListeners()

    {
        parent::attachDefaultListeners();
        $events = $this->getEventManager();
        $events->attach(MvcEvent::EVENT_DISPATCH, array($this, 'preDispatch'), 10);
        $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;
    }

    /**
     * Dispatch listener callback.
     *
     * Attaches the MailSender aggregate listener to the job event manager.
     *
     * @param MvcEvent $e
     * @since 0.19
     */
    public function preDispatch(MvcEvent $e)
    {
        if ('calculate' == $this->params()->fromQuery('do')) {
            return;
        }
        $routeMatch = $e->getRouteMatch();
        $action = $routeMatch->getParam('action');

        if (in_array($action, array('edit', 'approval', 'completion'))) {
            $services = $this->serviceLocator;
            $jobEvents = $services->get('Jobs/Events');
            $mailSender = $services->get('Jobs/Listener/MailSender');

            $mailSender->attach($jobEvents);
        }
    }

    /**
     *
     *
     * @return null|ViewModel

     */
    public function editAction()
    {
        if ('calculate' == $this->params()->fromQuery('do')) {
            $calc = $this->serviceLocator->get('filtermanager')->get('Jobs/ChannelPrices');
            $sum = $calc->filter($this->params()->fromPost('channels'));

            return new JsonModel(['sum' => $sum]);
        }

        return $this->save();
    }

    /**
     * @return null|ViewModel

     */
    public function saveAction()
    {
        return $this->save();
    }

    public function channelListAction()
    {
        $serviceLocator = $this->serviceLocator;
        $options = $serviceLocator->get('Core/Options');
        $channels = $serviceLocator->get('Jobs/Options/Provider');



        $jobEntity = $this->initializeJob()->get($this->params(), true);

        $model = new ViewModel([
                                   'portals' => $jobEntity->getPortals(),
                                   'channels' => $channels,
                                   'defaultCurrencyCode' => $options->defaultCurrencyCode,
                                   'defaultTaxRate' =>  $options->defaultTaxRate,
                                   'jobId' => $jobEntity->getId()
                               ]);
        $model->setTemplate('jobs/partials/channel-list')->setTerminal(true);
        return $model;
    }

    /**
     * save a Job-Post either by a regular request or by an async post (AJAX)
     * a mandatory parameter is the ID of the Job
     * in case of a regular Request you can
     *
     * parameter are arbitrary elements for defaults or programming flow
     *
     * @param array $parameter
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return null|ViewModel

     * @throws \RuntimeException
     */
    protected function save()
    {
        $serviceLocator     = $this->serviceLocator;
        $formEvents         = $serviceLocator->get('Jobs/JobContainer/Events');

        $user               = $this->auth->getUser();
        if (empty($user->getInfo()->getEmail())) {
            return $this->getErrorViewModel('no-parent', array('cause' => 'noEmail'));
        }
        $userOrg            = $user->getOrganization();
        if (!$userOrg->hasAssociation() || $userOrg->getOrganization()->isDraft()) {
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 $this->getErrorViewModel('no-parent', array('cause' => 'noCompany'));
        }
        
        try {
            $jobEntity = $this->initializeJob()->get($this->params(), true, true);
        } catch (NotFoundException $e) {
            $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' => sprintf($this->translator->translate('Job with id "%s" not found'), $e->getId()),
                'exception' => $e
            ];
        }


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

        $params             = $this->params();
        $formIdentifier     = $params->fromQuery('form');

        if ('1' == $params->fromQuery('admin')) {
            /* @var \Auth\Controller\Plugin\UserSwitcher $switcher */
            $switcher = $this->plugin('Auth/User/Switcher');
            $switcher($jobEntity->getUser(), ['return' => urldecode($params->fromQuery('return'))]);
        }


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

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $this->acl($jobEntity, 'edit');

        if ($status = $params->fromQuery('status')) {
            $this->changeStatus($jobEntity, $status);
        }

        $form               = $this->getFormular($jobEntity);

        $valid              = true;
        $instanceForm       = null;
        $formErrorMessages = array();

        if (isset($formIdentifier) &&  $request->isPost()) {
            // at this point the form get instantiated and immediately accumulated
            $instanceForm = $form->getForm($formIdentifier);
            if (!isset($instanceForm)) {
                throw new \RuntimeException('No form found for "' . $formIdentifier . '"');
            }
            // the id may be part of the postData, but it never should be altered
            $postData = $request->getPost();
            if (isset($postData['id'])) {
                unset($postData['id']);
            }
            unset($postData['applyId']);
            $instanceForm->setData($postData);
            $valid = $instanceForm->isValid();
            $formErrorMessages = ArrayUtils::merge($formErrorMessages, $instanceForm->getMessages());
            if ($valid) {
                /*
                 * @todo This is a workaround for GeoJSON data insertion
                 * until we figured out, what we really want it to be.
                 */
//                if ('general.locationForm' == $formIdentifier) {

//                    $locElem = $instanceForm->getBaseFieldset()->get('geo-location');
//                    if ($locElem instanceof \Geo\Form\GeoText) {
//                        $loc = $locElem->getValue('entity');
//                        $locations = $jobEntity->getLocations();
//                        if (count($locations)) {
//                            $locations->clear();
//                        }
//                        $locations->add($loc);
//                        $jobEntity->setLocation($locElem->getValue());
//                    }
//                }

                $title = $jobEntity->getTitle();
                $templateTitle = $jobEntity->getTemplateValues()->getTitle();

                if (empty($templateTitle)) {
                    $jobEntity->getTemplateValues()->setTitle($title);
                }
                $this->repositoryService->store($jobEntity);
            }
        }

        // validation
        $jobValid = true;
        $errorMessage = array();
        if (empty($jobEntity->getTitle())) {
            $jobValid = false;
            $errorMessage[] = $this->translator->translate('No Title');
        }
        if (!$jobEntity->getLocations()->count()) {
            $jobValid = false;
            $errorMessage[] = $this->translator->translate('No Location');
        }
        if (empty($jobEntity->getTermsAccepted())) {
            $jobValid = false;
            $errorMessage[] = $this->translator->translate('Accept the Terms');
        }
        $result = $formEvents->trigger('ValidateJob', $this, [ 'form' => $form ]);
        foreach ($result as $messages) {
            if (!$messages) {
                continue;
            }
            if (!is_array($messages)) {
                $messages = [ $messages ];
            }

            $errorMessage = array_merge($errorMessage, $messages);
            $jobValid = false;
        }

        $errorMessage = '<br />' . implode('<br />', $errorMessage);
        if ($isAjax) {
            if ($instanceForm instanceof SummaryForm) {
                $instanceForm->setRenderMode(SummaryForm::RENDER_SUMMARY);
                $viewHelper = 'summaryform';
            } else {
                $viewHelper = 'form';
            }
            $viewHelperManager  = $serviceLocator->get('ViewHelperManager');
            $content = $viewHelperManager->get($viewHelper)->__invoke($instanceForm);
            $viewModel = new JsonModel(
                array(
                'content' => $content,
                'valid' => $valid,
                'jobvalid' => $jobValid,
                'errors' => $formErrorMessages,
                'errorMessage' => $errorMessage)
            );
        } else {
            if ($jobEntity->isDraft()) {
                $form->getForm('general.nameForm')->setDisplayMode(SummaryFormInterface::DISPLAY_FORM);
                $form->getForm('general.portalForm')->setDisplayMode(SummaryFormInterface::DISPLAY_FORM);
                $locElem = $form->getForm('general.locationForm')->setDisplayMode(SummaryFormInterface::DISPLAY_FORM)
                                ->getBaseFieldset()->get('geoLocation');
                if ($locElem instanceof \Geo\Form\GeoText) {
                    $loc = $jobEntity->getLocations();
                    if (count($loc)) {
                        $locElem->setValue($loc->first());
                    }
                }
            } else {
                $formEvents->trigger('DisableElements', $this, [ 'form' => $form, 'job'=>$jobEntity ]);
                // Job is deployed, some changes are now disabled
                $form->enableAll();
            }


            $completionLink = $this->url()->fromRoute(
                'lang/jobs/completion',
                [ 'id' => $jobEntity->getId()]
            );

            $viewModel = $this->getViewModel($form);

            $viewModel->setVariables(
                array(
                'completionLink' => $completionLink,
                'title' => $jobEntity->getTitle(),
                'job' => $jobEntity,
                'summary' => 'this is what we charge you for your offer...',
                'valid' => $valid,
                'jobvalid' => $jobValid,
                'errorMessage' => $errorMessage,
                'isDraft' => $jobEntity->isDraft()
                )
            );
        }
        return $viewModel;
    }

    protected function changeStatus(JobInterface $job, $status)
    {
        if ($job instanceOf JobSnapshot) {
            $job = $job->getSnapshotMeta()->getEntity();
        }

        $oldStatus = $job->getStatus();

        if ($status == $oldStatus->getName()) {
            return;
        }
        $user = $this->auth->getUser();
        try {
            $job->changeStatus($status, sprintf('Status changed from %s to %s by %s', $oldStatus->getName(), $status, $user->getInfo()->getDisplayName()));

            $events = $this->serviceLocator->get('Jobs/Events');
            $events->trigger(JobEvent::EVENT_STATUS_CHANGED, $this, ['job' => $job, 'status' => $oldStatus]);
            $this->notification()->success(/*@translate*/ 'Status successfully changed.');
        } catch (\DomainException $e) {
            $this->notification()->error(/*@translate*/ 'Change status failed.');
        }
    }

    /**
     * @return array
     */
    public function checkApplyIdAction()
    {
        $services = $this->serviceLocator;
        $validator = $services->get('validatormanager')->get('Jobs/Form/UniqueApplyId');
        if (!$validator->isValid($this->params()->fromQuery('applyId'))) {
            return array(
                'ok' => false,
                'messages' => $validator->getMessages(),
            );
        }
        return array('ok' => true);
    }

    /**
     * @param  $job \Jobs\Entity\Job
     * @return mixed
     */
    protected function getFormular($job)
    {
        $services = $this->serviceLocator;
        /* @var $forms \Zend\Form\FormElementManager */
        $forms    = $services->get('FormElementManager');
        /* @var $container \Jobs\Form\Job */

        $container = $forms->get(
            'Jobs/Job',
            array(
            'mode' => $job->getId() ? 'edit' : 'new'
            )
        );
        $container->setEntity($job);
        $container->setParam('job', $job->getId());
        $container->setParam('snapshot', $job instanceOf JobSnapshot ? $job->getSnapshotId() : '');
        $container->setParam('applyId', $job->getApplyId());
        return $container;
    }

    /**
     * @param $form
     * @param array $params
     * @return ViewModel
     */
    protected function getViewModel($form, array $params = array())
    {
        $variables = array(
            'form' => $form,
        );
        $viewVars  = array_merge($variables, $params);
        
        $model = new ViewModel($viewVars);
        $model->setTemplate("jobs/manage/form");
        
        return $model;
    }

    /**
     * Job opening is completed.
     *
     * @return array

     */
    public function completionAction()
    {
        $serviceLocator = $this->serviceLocator;

        $job = $this->initializeJob()->get($this->params(), false, true);

        if ($job->isDraft()) {

            $job->setIsDraft(false);

            $reference = $job->getReference();

            if (empty($reference)) {
                /* @var $repository \Jobs\Repository\Job */
                $repository = $this->repositoryService->get('Jobs/Job');
                $job->setReference($repository->getUniqueReference());
            }
            $job->changeStatus(Status::CREATED, "job was created");
            $job->setAtsEnabled(true);

            // sets ATS-Mode on intern
            $job->getAtsMode();

            /*
            * make the job opening persist and fire the EVENT_JOB_CREATED
            */
            $this->repositoryService->store($job);

            $jobEvents = $serviceLocator->get('Jobs/Events');
            $jobEvents->trigger(JobEvent::EVENT_JOB_CREATED, $this, array('job' => $job));
        } else if ($job->isActive()) {
            $job->getSnapshotMeta()->getEntity()->changeStatus(Status::WAITING_FOR_APPROVAL, 'job was edited.');
        }

        /* @var \Auth\Controller\Plugin\UserSwitcher $switcher */
        $switcher = $this->plugin('Auth/User/Switcher');
        if ($switcher->isSwitchedUser()) {
            $return = $switcher->getSessionParam('return');
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
            $switcher->clear();

            if ($return) {
                return $this->redirect()->toUrl($return);
            }
        }

        return array('job' => $job);
    }

    /**
     * all actions around approve or decline jobs-offers
     *
     * @return array with the viewVariables

     */
    public function approvalAction()
    {
        $serviceLocator = $this->serviceLocator;
        $user           = $this->auth->getUser();

        $params         = $this->params('state');

        $jobEntity = $this->initializeJob()->get($this->params(), false, true);
        $jobEvent       = $serviceLocator->get('Jobs/Event');
        $jobEvent->setJobEntity($jobEntity);
        $jobEvent->addPortal('XingVendorApi');
        $jobEvents      = $serviceLocator->get('Jobs/Events');
        // array with differences between the last snapshot and the actual entity
        // is remains Null if there is no snapshot
        // it will be an empty array if the snapshot and the actual entity do not differ
        $diff           = null;


        if ($params == 'declined') {
            $jobEntity->changeStatus(Status::REJECTED, sprintf(/*@translate*/ "Job opening was rejected by %s", $user->getInfo()->getDisplayName()));
            $jobEntity->setIsDraft(true);
            $this->repositoryService->store($jobEntity);
            $jobEvents->trigger(JobEvent::EVENT_JOB_REJECTED, $jobEvent);
            $this->notification()->success(/*@translate */'Job has been rejected');
        }

        if ($params == 'approved') {
            if ($jobEntity instanceOf JobSnapshot) {
                $jobEntity = $this->repositoryService->get('Jobs/JobSnapshot')->merge($jobEntity);
            } else {
                $jobEntity->setDatePublishStart();
            }
            $jobEntity->changeStatus(Status::ACTIVE, sprintf(/*@translate*/ "Job opening was activated by %s", $user->getInfo()->getDisplayName()));
            $this->repositoryService->store($jobEntity);
            $jobEvents->trigger(JobEvent::EVENT_JOB_ACCEPTED, $jobEvent);
            //$this->entitySnapshot($jobEntity);

            $this->notification()->success(/* @translate */ 'Job has been approved');
            return $this->redirect()->toRoute('lang/admin/jobs', array('lang' => $this->params('lang')));
        }

        $query = $jobEntity instanceOf JobSnapshot ? ['snapshot' => $jobEntity->getSnapshotId()] : ['id' => $jobEntity->getId()];
        $viewLink = $this->url()->fromRoute(
            'lang/jobs/view',
            array(),
            array('query' => $query
                      )
        );

        $approvalLink = $this->url()->fromRoute(
            'lang/jobs/approval',
            array('state' => 'approved'),
            array('query' => $query)
        );

        $declineLink = $this->url()->fromRoute(
            'lang/jobs/approval',
            array('state' => 'declined'),
            array('query' => $query)
        );

        return array('job' => $jobEntity,
                     'diffSnapshot' => $diff,
                     'viewLink' => $viewLink,
                     'approvalLink' => $approvalLink,
                     'declineLink' => $declineLink);
    }

    /**
     * Deactivate a job posting
     *
     * @return null|ViewModel

     */
    public function deactivateAction()
    {
        $user           = $this->auth->getUser();

        $jobEntity = $this->initializeJob()->get($this->params());

        try {
            $jobEntity->changeStatus(Status::INACTIVE, sprintf(/*@translate*/ "Job was deactivated by %s", $user->getInfo()->getDisplayName()));
            $this->notification()->success(/*@translate*/ 'Job has been deactivated');
        } catch (\Exception $e) {
            $this->notification()->danger(/*@translate*/ 'Job could not be deactivated');
        }
        return $this->save(array('page' => 2));

    }

    public function deleteAction()
    {
        $job = $this->initializeJob()->get($this->params());
        $this->acl($job, 'edit');


        $this->repositoryService->remove($job);

        $this->notification()->success(/*@translate*/ 'Job has been deleted.');
        return $this->redirect()->toRoute('lang/jobs');

    }
    /**
     * Assign a template to a job posting
     *
     * @return JsonModel
     */
    public function templateAction()
    {
        try {
            $jobEntity = $this->initializeJob()->get($this->params());
            $jobEntity->setTemplate($this->params('template', 'default'));
            $this->repositoryService->store($jobEntity);
            $this->notification()->success(/* @translate*/ 'Template changed');
        } catch (\Exception $e) {
            $this->notification()->danger(/* @translate */ 'Template not changed');
        }

        return new JsonModel(array());
    }

    /**
     * @param $script
     * @param array $parameter
     * @return ViewModel
     */
    protected function getErrorViewModel($script, $parameter = array())

    {
        /** @var Response $response */
        $response = $this->getResponse();
        $response->setStatusCode(Response::STATUS_CODE_500);

        $model = new ViewModel($parameter);
        $model->setTemplate("jobs/error/$script");

        return $model;
    }

    public function historyAction()
    {
        $jobEntity = $this->initializeJob()->get($this->params());
        $title          = $jobEntity->getTitle();
        $historyEntity  = $jobEntity->getHistory();

        $model = new ViewModel(array('title' => $title, 'history' => $historyEntity));
        $model->setTerminal(true);
        return $model;
    }
}

Push — develop ( 8e0188...beb977 )

ManageController::approvalAction() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

Available Fixes

cross-solution / YAWIK

Push — develop ( 8e0188...beb977 )

ManageController::approvalAction() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like
