Applications\Controller\ManageController

Complexity

Total Complexity

45

Size/Duplication

Total Lines	479
Duplicated Lines	0 %

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	refreshRatingAction()	0	14	2
A	socialProfileAction()	0	24	6
C	detailAction()	0	127	15
A	__construct()	0	16	1
A	moveAction()	0	23	2
A	deleteAction()	0	23	3
A	forwardAction()	0	39	3
A	factory()	0	12	1
A	onDispatch()	0	10	3
B	statusAction()	0	81	8
A	indexAction()	0	8	1

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

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

use Applications\Form\ApplicationsFilter;
use Applications\Listener\Events\ApplicationEvent;
use Core\Repository\RepositoryService;
use Interop\Container\ContainerInterface;
use Zend\Mvc\Controller\AbstractActionController;
use Zend\View\Model\ViewModel;
use Zend\View\Model\JsonModel;
use Applications\Entity\StatusInterface as Status;
use Applications\Entity\Application;

/**
 * @method \Core\Controller\Plugin\Notification notification()
 * @method \Core\Controller\Plugin\Mailer mailer()
 * @method \Acl\Controller\Plugin\Acl acl()
 * @method \Auth\Controller\Plugin\Auth auth()
 *
 * Handles managing actions on applications
 */
class ManageController extends AbstractActionController
{
    /**
     * @var RepositoryService
     */
    private $repositories;
    
    /**
     * @var
     */
    private $coreNavigation;
    
    private $forms;
    
    private $appOptions;
    
    private $appEvents;
    
    private $translator;
    
    private $container;
    
    /**
     * ManageController constructor.
     *
     * @param RepositoryService $repositories
     */
    public function __construct(
        RepositoryService $repositories,
        $coreNavigation,
        $forms,
        $appOptions,
        $appEvents,
        $translator,
        $container
    ) {
        $this->repositories     = $repositories;
        $this->coreNavigation   = $coreNavigation;
        $this->forms            = $forms;
        $this->appOptions       = $appOptions;
        $this->appEvents        = $appEvents;
        $this->translator       = $translator;
        $this->container         = $container;
    }
    
    /**
     * @param ContainerInterface $container
     *
     * @return ManageController
     */
    public static function factory(ContainerInterface $container)
    {
        $ob = new self(
            $container->get('Core/RepositoryService'),
            $container->get('Core/Navigation'),
            $container->get('forms'),
            $container->get('Applications/Options'),
            $container->get('Applications/Events'),
            $container->get('translator'),
            $container
        );
        return $ob;
    }
    
    /**
     * (non-PHPdoc)
     * @see \Zend\Mvc\Controller\AbstractActionController::onDispatch()
     */
    public function onDispatch(\Zend\Mvc\MvcEvent $e)
    {
        $routeMatch = $e->getRouteMatch();
        $action     = $this->params()->fromQuery('action');
        
        if ($routeMatch && $action) {
            $routeMatch->setParam('action', $action);
        }

        return parent::onDispatch($e);
    }
    
    /**
     * List applications
     */
    public function indexAction()
    {
        return $this->pagination([

The method pagination() does not exist on Applications\Controller\ManageController. Since you implemented __call, consider adding a @method annotation.

                'params' => ['Application_List', ['q', 'job', 'page' => 1, 'unread', 'status' => 'all']],
                'paginator' => ['Applications', 'as' => 'applications'],
                'form' => [
                    ApplicationsFilter::class,
                    'as' => 'form'
                ],
            ]);
    }

    /**
     * Detail view of an application
     *
     * @return array|JsonModel|ViewModel
     */
    public function detailAction()
    {
        if ('refresh-rating' == $this->params()->fromQuery('do')) {
            return $this->refreshRatingAction();
        }
        
        $nav = $this->coreNavigation;
        $page = $nav->findByRoute('lang/applications');
        $page->setActive();

        /* @var \Applications\Repository\Application$repository */
        $repository = $this->repositories->get('Applications/Application');
        /* @var Application $application */
        $application = $repository->find($this->params('id'));
        
        if (!$application) {

$application is of type Applications\Entity\Application, thus it always evaluated to true.

            $this->response->setStatusCode(410);
            $model = new ViewModel(
                array(
                'content' => /*@translate*/ 'Invalid apply id'
                )
            );
            $model->setTemplate('applications/error/not-found');
            return $model;
        }
        
        $this->acl($application, 'read');

The call to Applications\Controller\ManageController::acl() has too many arguments starting with $application.

        
        $applicationIsUnread = false;
        if ($application->isUnreadBy($this->auth('id')) && $application->getStatus()) {

The call to Applications\Controller\ManageController::auth() has too many arguments starting with 'id'.

            $application->addReadBy($this->auth('id'));
            $applicationIsUnread = true;
            $application->changeStatus(
                $application->getStatus(),
                sprintf(/*@translate*/ 'Application was read by %s',
                                       $this->auth()->getUser()->getInfo()->getDisplayName()
                )
            );
        }


        
        $format=$this->params()->fromQuery('format');

        if ($application->isDraft()) {
            $list = false;
        } else {
            $list = $this->paginationParams('Applications\Index', $repository);

The method paginationParams() does not exist on Applications\Controller\ManageController. Since you implemented __call, consider adding a @method annotation.

            $list->setCurrent($application->getId());

The method setCurrent() does not exist on Zend\Stdlib\DispatchableInterface. It seems like you code against a sub-type of Zend\Stdlib\DispatchableInterface such as Zend\Mvc\Controller\AbstractController.

        }

        $return = array(
            'application'=> $application,
            'list' => $list,
            'isUnread' => $applicationIsUnread,
            'format' => 'html'
        );
        switch ($format) {
            case 'json':
                /*@deprecated - must be refactored */
                        $viewModel = new JsonModel();
                        $viewModel->setVariables(
                            /*array(
                            'application' => */$this->builders

The property builders does not exist on Applications\Controller\ManageController. Did you maybe forget to declare it?

                                              ->get('JsonApplication')
                                              ->unbuild($application)
                        );
                        $viewModel->setVariable('isUnread', $applicationIsUnread);
                        $return = $viewModel;
                break;
            case 'pdf':
                // @TODO: [ZF3] Refactor this so we can inject Core/Html2Pdf service during controller creation
                $pdf = $this->container->get('Core/Html2Pdf');

The assignment to $pdf is dead and can be removed.

                $return['format'] = $format;
                break;
            default:
                $contentCollector = $this->getPluginManager()->get('Core/ContentCollector');
                $contentCollector->setTemplate('applications/manage/details/action-buttons');

The method setTemplate() does not exist on Zend\Stdlib\DispatchableInterface. It seems like you code against a sub-type of Zend\Stdlib\DispatchableInterface such as Zend\Mvc\Controller\AbstractController.

                $actionButtons = $contentCollector->trigger('application.detail.actionbuttons', $application);

The method trigger() does not exist on Zend\Stdlib\DispatchableInterface. It seems like you code against a sub-type of Zend\Stdlib\DispatchableInterface such as Zend\Mvc\Controller\AbstractController.

                
                $return = new ViewModel($return);
                $return->addChild($actionButtons, 'externActionButtons');
                
                $allowSubsequentAttachmentUpload = $this->appOptions
                    ->getAllowSubsequentAttachmentUpload();
                
                if ($allowSubsequentAttachmentUpload
                    && $this->acl($application, Application::PERMISSION_SUBSEQUENT_ATTACHMENT_UPLOAD, 'test')
                ) {
                    $attachmentsForm = $this->forms
                        ->get('Applications/Attachments');
                    $attachmentsForm->bind($application->getAttachments());
                    
                    /* @var $request \Zend\Http\PhpEnvironment\Request */
                    $request = $this->getRequest();
                    
                    if ($request->isPost() && $attachmentsForm->get('return')->getValue() === $request->getPost('return')) {
                        $data = array_merge(
                            $attachmentsForm->getOption('use_post_array') ? $request->getPost()->toArray() : [],
                            $attachmentsForm->getOption('use_files_array') ? $request->getFiles()->toArray() : []
                        );
                        $attachmentsForm->setData($data);
                        
                        if (!$attachmentsForm->isValid()) {
                            return new JsonModel([
                                'valid' => false,
                                'errors' => $attachmentsForm->getMessages()
                            ]);
                        }
                        
                        $content = $attachmentsForm->getHydrator()
                            ->getLastUploadedFile()
                            ->getUri();
                        
                        return new JsonModel([
                            'valid' => $attachmentsForm->isValid(),
                            'content' => $content
                        ]);
                    }
                    
                    $return->setVariable('attachmentsForm', $attachmentsForm);
                }
                
                break;
        }
        
        return $return;
    }
    
    /**
     * Refreshes the rating of an application
     *
     * @throws \DomainException
     * @return \Zend\View\Model\ViewModel
     */
    public function refreshRatingAction()
    {
        $model = new ViewModel();
        $model->setTemplate('applications/manage/_rating');
        
        $application = $this->repositories->get('Applications/Application')
                        ->find($this->params('id', 0));
        
        if (!$application) {
            throw new \DomainException('Invalid application id.');
        }
        
        $model->setVariable('application', $application);
        return $model;
    }
    
    /**
     * Attaches a social profile to an application
     * @throws \InvalidArgumentException
     *
     * @return array
     */
    public function socialProfileAction()
    {
        if ($spId = $this->params()->fromQuery('spId')) {

The assignment to $spId is dead and can be removed.

            $repositories = $this->repositories;
            $repo = $repositories->get('Applications/Application');
            $profile = $repo->findProfile($this->params()->fromQuery('spId'));
            if (!$profile) {
                throw new \InvalidArgumentException('Could not find profile.');
            }
        } elseif ($this->getRequest()->isPost()

The method isPost() does not exist on Zend\Stdlib\RequestInterface. It seems like you code against a sub-type of Zend\Stdlib\RequestInterface such as Zend\Http\Request.

                   && ($network = $this->params()->fromQuery('network'))
                   && ($data    = $this->params()->fromPost('data'))
        ) {
            $profileClass = '\\Auth\\Entity\\SocialProfiles\\' . $network;
            $profile      = new $profileClass();
            $profile->setData(\Zend\Json\Json::decode($data, \Zend\Json\Json::TYPE_ARRAY));
        } else {
            throw new \RuntimeException(
                'Missing arguments. Either provide "spId" as Get or "network" and "data" as Post.'
            );
        }
        
        return array(
            'profile' => $profile
        );
    }

    /**
     * Changes the status of an application
     *
     * @return array
     */
    public function statusAction()
    {
        $applicationId = $this->params('id');
        /* @var \Applications\Repository\Application $repository */
        $repository    = $this->repositories->get('Applications/Application');
        /* @var Application $application */
        $application   = $repository->find($applicationId);

        /* @var Request $request */
        $request = $this->getRequest();

        if (!$application) {

$application is of type Applications\Entity\Application, thus it always evaluated to true.

            throw new \InvalidArgumentException('Could not find application.');
        }
        
        $this->acl($application, 'change');

The call to Applications\Controller\ManageController::acl() has too many arguments starting with $application.

        
        $jsonFormat    = 'json' == $this->params()->fromQuery('format');
        $status        = $this->params('status', Status::CONFIRMED);
        $settings = $this->settings();

The method settings() does not exist on Applications\Controller\ManageController. Since you implemented __call, consider adding a @method annotation.

The assignment to $settings is dead and can be removed.

        
        if (in_array($status, array(Status::INCOMING))) {
            $application->changeStatus($status);

It seems like $status can also be of type Zend\Mvc\Controller\Plugin\Params; however, parameter $status of Applications\Entity\Application::changeStatus() does only seem to accept Applications\Entity\StatusInterface|string, maybe add an additional type check?

            if ($request->isXmlHttpRequest()) {
                $response = $this->getResponse();
                $response->setContent('ok');
                return $response;

The expression return $response returns the type Zend\Stdlib\ResponseInterface which is incompatible with the documented return type array.

            }
            if ($jsonFormat) {
                return array(
                    'status' => 'success',
                );
            }
            return $this->redirect()->toRoute('lang/applications/detail', array(), true);

The expression return $this->redirect()->toRoute('lang/applications/detail', array(), true) returns the type Zend\Http\Response which is incompatible with the documented return type array.

true of type true is incompatible with the type array expected by parameter $options of Zend\Mvc\Controller\Plugin\Redirect::toRoute().

        }

        $events = $this->appEvents;

        /* @var ApplicationEvent $event */
        $event = $events->getEvent(
            ApplicationEvent::EVENT_APPLICATION_STATUS_CHANGE,
                                   $this,
                                   [
                                       'application' => $application,
                                       'status' => $status,
                                       'user' => $this->auth()->getUser(),
                                   ]
        );
        
        $event->setIsPostRequest($request->isPost());
        $event->setPostData($request->getPost());
        $events->trigger($event->getName(), $event);

        $params = $event->getFormData();


        if ($request->isPost()) {
            if ($jsonFormat) {
                return array(
                    'status' => 'success',
                );
            }
            $this->notification()->success($event->getNotification());
            return $this->redirect()->toRoute('lang/applications/detail', array(), true);

The expression return $this->redirect()->toRoute('lang/applications/detail', array(), true) returns the type Zend\Http\Response which is incompatible with the documented return type array.

        }

        if ($jsonFormat) {
            return $params;
        }

        /* @var \Applications\Form\Mail $form */
        $form = $this->forms->get('Applications/Mail');
        $form->populateValues($params);



        $recipient = $params['to'];

        return [
            'recipient' => $recipient,
            'form' => $form
        ];
    }
    
    /**
     * Forwards an application via Email
     *
     * @throws \InvalidArgumentException
     * @return \Zend\View\Model\JsonModel
     */
    public function forwardAction()
    {
        $emailAddress = $this->params()->fromQuery('email');
        /* @var \Applications\Entity\Application $application */
        $application  = $this->repositories->get('Applications/Application')
                                 ->find($this->params('id'));
        
        $this->acl($application, 'forward');

The call to Applications\Controller\ManageController::acl() has too many arguments starting with $application.

        
        $translator   = $this->translator;
         
        if (!$emailAddress) {
            throw new \InvalidArgumentException('An email address must be supplied.');
        }
        
        $params = array(
            'ok' => true,
            'text' => sprintf($translator->translate('Forwarded application to %s'), $emailAddress)
        );
        
        try {
            $userName    = $this->auth('info')->getDisplayName();

The call to Applications\Controller\ManageController::auth() has too many arguments starting with 'info'.

The method getDisplayName() does not exist on Auth\Controller\Plugin\Auth. Since you implemented __call, consider adding a @method annotation.

            $fromAddress = $application->getJob()->getContactEmail();
            $mailOptions = array(
                'application' => $application,
                'to'          => $emailAddress,
                'from'        => array($fromAddress => $userName)
            );
            $this->mailer('Applications/Forward', $mailOptions, true);

The call to Applications\Controller\ManageController::mailer() has too many arguments starting with 'Applications/Forward'.

            $this->notification()->success($params['text']);
        } catch (\Exception $ex) {
            $params = array(
                'ok' => false,
                'text' => sprintf($translator->translate('Forward application to %s failed.'), $emailAddress)
            );
            $this->notification()->error($params['text']);
        }
        $application->changeStatus($application->getStatus(), $params['text']);
        return new JsonModel($params);
    }

    /**
     * Deletes an application
     *
     * @return array|\Zend\Http\Response
     */
    public function deleteAction()
    {
        $id          = $this->params('id');
        $repositories= $this->repositories;
        $repository  = $repositories->get('Applications/Application');
        $application = $repository->find($id);
        
        if (!$application) {
            throw new \DomainException('Application not found.');
        }

        $this->acl($application, 'delete');

The call to Applications\Controller\ManageController::acl() has too many arguments starting with $application.

        $events   = $this->appEvents;
        $events->trigger(ApplicationEvent::EVENT_APPLICATION_PRE_DELETE, $this, [ 'application' => $application ]);
        
        $repositories->remove($application);
        
        if ('json' == $this->params()->fromQuery('format')) {
            return ['status' => 'success'];
        }
        
        return $this->redirect()->toRoute('lang/applications', array(), true);

true of type true is incompatible with the type array expected by parameter $options of Zend\Mvc\Controller\Plugin\Redirect::toRoute().

    }

    /**
     * Move an application to talent pool
     *
     * @return \Zend\Http\Response
     * @since 0.26
     */
    public function moveAction()
    {
        $id = $this->params('id');
        $repositories = $this->repositories;
        $application = $repositories->get('Applications/Application')->find($id);
        
        if (!$application) {
            throw new \DomainException('Application not found.');
        }

        $this->acl($application, 'move');

The call to Applications\Controller\ManageController::acl() has too many arguments starting with $application.

        
        $user = $this->auth()->getUser();
        $cv = $repositories->get('Cv/Cv')->createFromApplication($application, $user);
        
        $repositories->store($cv);
        $repositories->remove($application);

        $this->notification()->success(
            /*@translate*/ 'Application has been successfully moved to Talent Pool'
        );
        
        return $this->redirect()->toRoute('lang/applications', array(), true);

true of type true is incompatible with the type array expected by parameter $options of Zend\Mvc\Controller\Plugin\Redirect::toRoute().

    }
}