Jobs\Controller\ManageController

Complexity

Total Complexity

65

Size/Duplication

Total Lines	580
Duplicated Lines	8.1 %

Coupling/Cohesion

Components	1
Dependencies	23

Importance

Changes	4
Bugs	0	Features	1

17 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	attachDefaultListeners()	12	12	1
A	preDispatch()	0	16	3
A	newAction()	0	14	1
A	editAction()	0	10	2
A	saveAction()	0	4	1
F	save()	21	184	30
A	checkApplyIdAction()	0	12	2
A	getFormular()	0	17	2
C	getJob()	0	30	7
A	getViewModel()	0	12	1
B	completionAction()	0	30	2
B	approvalAction()	14	74	6
A	deactivateAction()	0	13	2
A	templateAction()	0	13	2
A	getErrorViewModel()	0	9	1
A	historyAction()	0	10	1

<?php

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

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

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;

/**
 * This Controller handles management actions for jobs.
 *
 * @author Mathias Gelhausen <gelhausen@cross-solution.de>
 */
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()

This method seems to be duplicated in your project.

    {
        parent::attachDefaultListeners();
        $events = $this->getEventManager();
        $events->attach(MvcEvent::EVENT_DISPATCH, array($this, 'preDispatch'), 10);
        $serviceLocator = $this->getServiceLocator();
        $defaultServices = $serviceLocator->get('DefaultListeners');
        $events = $this->getEventManager();
        $events->attach($defaultServices);

$defaultServices is of type object|array, but the function expects a string.

        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->getServiceLocator();
            $jobEvents = $services->get('Jobs/Events');
            $mailSender = $services->get('Jobs/Listener/MailSender');

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

    /**
     * Action called, when a new job should be created.
     *
     */
    public function newAction()
    {
        $job = $this->getJob(/* create */ true);
        $this->acl($job, 'new');

The method acl does not exist on object<Jobs\Controller\ManageController>? Since you implemented __call, maybe consider adding a @method annotation.

        $user = $this->auth->getUser();
        $job->setContactEmail($user->getInfo()->getEmail());
        $job->setApplyId(
            uniqid(substr(md5($user->getLogin()), 0, 3))
        );
        $form  = $this->getFormular($job);
        $model = $this->getViewModel($form);
        
        return $model;
    }

    /**
     * @TODO edit-Action and save-Action are doing the same, one of them has to quit
     *
     * @return null|ViewModel
     */
    public function editAction()
    {
        if ('calculate' == $this->params()->fromQuery('do')) {
            $calc = $this->getServiceLocator()->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();
    }

    /**
     * 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
     * @return null|ViewModel
     * @throws \RuntimeException
     */
    protected function save($parameter = array())
    {
        $serviceLocator     = $this->getServiceLocator();
        $user               = $this->auth->getUser();
        if (empty($user->info->email)) {

The property $info is declared protected in Auth\Entity\User. Since you implemented __get(), maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion.

Accessing email on the interface Auth\Entity\InfoInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

            return $this->getErrorViewModel('no-parent', array('cause' => 'noEmail'));
        }
        $userOrg            = $user->getOrganization();
        if (!$userOrg->hasAssociation()) {
            return $this->getErrorViewModel('no-parent', array('cause' => 'noCompany'));
        }

        /** @var \Zend\Http\Request $request */
        $request            = $this->getRequest();
        $isAjax             = $request->isXmlHttpRequest();
        $pageToForm         = array(0 => array('locationForm', 'nameForm', 'portalForm'),
                                    1 => array('descriptionForm'),
                                    2 => array('previewForm'));

        $params             = $this->params();
        $formIdentifier     = $params->fromQuery('form');
        $pageIdentifier     = (int) $params->fromQuery('page', array_key_exists('page', $parameter)?$parameter['page']:0);
        $jobEntity          = $this->getJob();
        $viewModel          = null;

$viewModel is not used, you could remove the assignment.

        $this->acl($jobEntity, 'edit');

The method acl does not exist on object<Jobs\Controller\ManageController>? Since you implemented __call, maybe consider adding a @method annotation.

        $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 ('locationForm' == $formIdentifier) {
                    $locElem = $instanceForm->getBaseFieldset()->get('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->persist($jobEntity);

The method persist does not exist on object<Core\Repository\RepositoryService>? Since you implemented __call, maybe consider adding a @method annotation.

            }
        }

        // validation
        $jobValid = true;
        $errorMessage = array();
        if (empty($jobEntity->getTitle())) {
            $jobValid = false;
            $errorMessage[] = $this->translator->translate('No Title');
        }
        if (empty($jobEntity->getLocation())) {
            $jobValid = false;
            $errorMessage[] = $this->translator->translate('No Location');
        }
        if (empty($jobEntity->getTermsAccepted())) {
            $jobValid = false;
            $errorMessage[] = $this->translator->translate('Accept the Terms');
        }

        $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 (isset($pageIdentifier)) {
                $form->disableForm();
                if (array_key_exists($pageIdentifier, $pageToForm)) {
                    foreach ($pageToForm[$pageIdentifier] as $actualFormIdentifier) {
                        $form->enableForm($actualFormIdentifier);
                        if ($jobEntity->isDraft()) {
                            $actualForm = $form->get($actualFormIdentifier);
                            if ('nameForm' != $actualFormIdentifier && $actualForm instanceof SummaryFormInterface) {
                                $form->get($actualFormIdentifier)->setDisplayMode(SummaryFormInterface::DISPLAY_FORM);

It seems like you code against a concrete implementation and not the interface Zend\Form\ElementInterface as the method setDisplayMode() does only exist in the following implementations of said interface: Applications\Form\Base, Applications\Form\Facts, Auth\Form\UserBase, Auth\Form\UserInfo, Core\Form\SummaryForm, Jobs\Form\AtsMode, Jobs\Form\Base, Jobs\Form\CompanyName, Jobs\Form\Multipost, Organizations\Form\Employees, Organizations\Form\OrganizationsContactForm, Organizations\Form\OrganizationsDescriptionForm, Organizations\Form\OrganizationsNameForm.

                            }
                            if ('locationForm' == $actualFormIdentifier) {
                                $locElem = $actualForm->getBaseFieldset()->get('location');
                                if ($locElem instanceOf \Geo\Form\GeoText) {
                                    $loc = $jobEntity->getLocations();
                                    if (count($loc)) {
                                        $locElem->setValue($loc->first());
                                    }
                                }
                            }
                        }
                    }
                    if (!$jobEntity->isDraft()) {
                        // Job is deployed, some changes are now disabled
                        $form->enableAll();
                    }
                } else {
                    throw new \RuntimeException('No form found for page ' . $pageIdentifier);
                }
            }
            $pageLinkNext = null;
            $pageLinkPrevious = null;
            if (0 < $pageIdentifier) {

This code seems to be duplicated across your project.

                $pageLinkPrevious = $this->url()->fromRoute(
                    'lang/jobs/manage',
                    [],
                    ['query' => [
                        'id' => $jobEntity->getId(),
                        'page' => $pageIdentifier - 1]
                    ]
                );
            }
            if ($pageIdentifier < count($pageToForm) - 1) {

This code seems to be duplicated across your project.

                $pageLinkNext     = $this->url()->fromRoute(
                    'lang/jobs/manage',
                    [],
                    [
                        'query' => [
                            'id' => $jobEntity->getId(),
                            'page' => $pageIdentifier + 1]
                    ]
                );
            }
            $completionLink = $this->url()->fromRoute(
                'lang/jobs/completion',
                [ 'id' => $jobEntity->getId()]
            );

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

            $viewModel->setVariables(
                array(
                'pageLinkPrevious' => $pageLinkPrevious,
                'pageLinkNext' => $pageLinkNext,
                'completionLink' => $completionLink,
                'page' => $pageIdentifier,
                'title' => $jobEntity->title,

The property $title is declared protected in Jobs\Entity\Job. Since you implemented __get(), maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion.

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

    /**
     * @return array
     */
    public function checkApplyIdAction()
    {
        $services = $this->getServiceLocator();
        $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
     * @return mixed
     */
    protected function getFormular($job)
    {
        $services = $this->getServiceLocator();
        /* @var $forms \Zend\Form\FormElementManager */
        $forms    = $services->get('FormElementManager');
        /* @var $container \Jobs\Form\Job */
        $container = $forms->get(
            'Jobs/Job',
            array(
            'mode' => $job->id ? 'edit' : 'new'
            )
        );
        $container->setEntity($job);
        $container->setParam('job', $job->id);
        $container->setParam('applyId', $job->applyId);
        return $container;
    }

    /**
     * @param bool $allowDraft
     * @return \Jobs\Entity\Job
     * @throws \RuntimeException
     */
    protected function getJob($allowDraft = true)
    {
        /* @var \Jobs\Repository\Job $jobRepository */
        $jobRepository     = $this->repositoryService->get('Jobs/Job');
        // @TODO three different method to obtain the job-id ?, simplify this
        $id_fromRoute   = $this->params('id', 0);

$id_fromRoute does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $id_fromQuery   = $this->params()->fromQuery('id', 0);

$id_fromQuery does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $id_fromSubForm = $this->params()->fromPost('job', 0);

$id_fromSubForm does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $user           = $this->auth->getUser();
        $id             = empty($id_fromRoute)? (empty($id_fromQuery)?$id_fromSubForm:$id_fromQuery) : $id_fromRoute;

$id_fromRoute does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        if (empty($id) && $allowDraft) {
            $this->acl('Jobs/Manage', 'new');

The method acl does not exist on object<Jobs\Controller\ManageController>? Since you implemented __call, maybe consider adding a @method annotation.

            /** @var \Jobs\Entity\Job $job */
            $job = $jobRepository->findDraft($user);
            if (empty($job)) {
                $job = $jobRepository->create();
                $job->setIsDraft(true);
                $job->setUser($user);
                $this->repositoryService->store($job);
            }
            return $job;
        }

        $jobEntity      = $jobRepository->find($id);
        if (!$jobEntity) {
            throw new \RuntimeException('No job found with id "' . $id . '"');
        }
        return $jobEntity;
    }

    /**
     * @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->getServiceLocator();
        $job = $this->getJob();

        $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));

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

    /**
     * all actions around approve or decline jobs-offers
     *
     * @return array with the viewVariables
     */
    public function approvalAction()
    {

        $serviceLocator = $this->getServiceLocator();
        $user           = $this->auth->getUser();

        $params         = $this->params('state');
        /** @var \Jobs\Entity\Job $jobEntity */
        $jobEntity      = $this->getJob();
        $jobEvent       = $serviceLocator->get('Jobs/Event');
        $jobEvent->setJobEntity($jobEntity);
        $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;
        // preliminary difference, contain all differences
        $prelDiff = $this->entitySnapshot()->diff($jobEntity);

The method entitySnapshot does not exist on object<Jobs\Controller\ManageController>? Since you implemented __call, maybe consider adding a @method annotation.

        if (isset($prelDiff)) {
            // we want just some Values to be compared
            $diff = null;
            foreach (array('title', 'organization', 'location',
                         'templateValues.qualifications', 'templateValues.requirements', 'templateValues.benefits', 'templateValues.title',
                         'templateValues._freeValues.description',
                     ) as $prelKey) {
                if (array_key_exists($prelKey, $prelDiff)) {
                    $diff[$prelKey] = $prelDiff[$prelKey];
                }
            }
        }

        if ($params == 'declined') {

This code seems to be duplicated across your project.

            $jobEntity->changeStatus(Status::REJECTED, sprintf(/*@translate*/ "Job opening was rejected by %s", $user->info->displayName));

The property $info is declared protected in Auth\Entity\User. Since you implemented __get(), maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion.

Accessing displayName on the interface Auth\Entity\InfoInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

            $jobEntity->setIsDraft(true);
            $this->repositoryService->store($jobEntity);
            $jobEvents->trigger(JobEvent::EVENT_JOB_REJECTED, $jobEvent);
            $this->notification()->success($this->translator->translate('Job has been rejected'));

The method notification does not exist on object<Jobs\Controller\ManageController>? Since you implemented __call, maybe consider adding a @method annotation.

        }

        if ($params == 'approved') {

This code seems to be duplicated across your project.

            $jobEntity->changeStatus(Status::ACTIVE, sprintf(/*@translate*/ "Job opening was activated by %s", $user->info->displayName));

The property $info is declared protected in Auth\Entity\User. Since you implemented __get(), maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion.

Accessing displayName on the interface Auth\Entity\InfoInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

            $this->repositoryService->store($jobEntity);
            $jobEvents->trigger(JobEvent::EVENT_JOB_ACCEPTED, $jobEvent);
            $this->entitySnapshot($jobEntity);

The method entitySnapshot does not exist on object<Jobs\Controller\ManageController>? Since you implemented __call, maybe consider adding a @method annotation.

            $this->notification()->success($this->translator->translate('Job has been approved'));

The method notification does not exist on object<Jobs\Controller\ManageController>? Since you implemented __call, maybe consider adding a @method annotation.

        }

        $viewLink = $this->url()->fromRoute(
            'lang/jobs/view',
            array(),
            array('query' =>
                      array( 'id' => $jobEntity->getId()))
        );

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

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

        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->getJob();

        try {
            $jobEntity->changeStatus(Status::INACTIVE, sprintf(/*@translate*/ "Job was deactivated by %s", $user->getInfo()->getDisplayName()));
            $this->notification()->success($this->translator->translate('Job has been deactivated'));

The method notification does not exist on object<Jobs\Controller\ManageController>? Since you implemented __call, maybe consider adding a @method annotation.

        } catch (\Exception $e) {
            $this->notification()->danger($this->translator->translate('Job could not be deactivated'));

The method notification does not exist on object<Jobs\Controller\ManageController>? Since you implemented __call, maybe consider adding a @method annotation.

        }
        return $this->save(array('page' => 2));
    }

    /**
     * Assign a template to a job posting
     *
     * @return JsonModel
     */
    public function templateAction()
    {
        try {
            $jobEntity           = $this->getJob();
            $jobEntity->setTemplate($this->params('template', 'default'));
            $this->repositoryService->store($jobEntity);
            $this->notification()->success($this->translator->translate('Template changed'));

The method notification does not exist on object<Jobs\Controller\ManageController>? Since you implemented __call, maybe consider adding a @method annotation.

        } catch (\Exception $e) {
            $this->notification()->danger($this->translator->translate('Template not changed'));

The method notification does not exist on object<Jobs\Controller\ManageController>? Since you implemented __call, maybe consider adding a @method annotation.

        }

        return new JsonModel(array());
    }

    /**
     * @param $script
     * @param array $parameter
     * @return ViewModel
     */
    protected function getErrorViewModel($script, $parameter = array())
    {
        $this->getResponse()->setStatusCode(500);

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.

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

        return $model;
    }

    public function historyAction()
    {
        $jobEntity      = $this->getJob();
        $title          = $jobEntity->title;

The property $title is declared protected in Jobs\Entity\Job. Since you implemented __get(), maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion.

        $historyEntity  = $jobEntity->history;

The property $history is declared protected in Jobs\Entity\Job. Since you implemented __get(), maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion.

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