ByTIC\Hello\Modules\AbstractModule\Controllers\Traits\AbstractAuthenticationControllerTrait

Complexity

Total Complexity

13

Size/Duplication

Total Lines	83
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	1

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getRedirectURL()	0	10	3
A	beforeAction()	0	4	1
A	afterActionViewVariables()	0	5	1
A	checkIsAuthenticated()	0	4	3
A	getGenericRedirectURL()	0	4	1
A	generateModelName()	0	3	1
A	doSuccessRedirect()	0	8	2
A	_setMeta()	0	7	1

<?php

namespace ByTIC\Hello\Modules\AbstractModule\Controllers\Traits;

/**
 * Trait AbstractAuthenticationControllerTrait
 * @package ByTIC\Hello\Modules\AbstractModule\Controllers\Traits
 */
trait AbstractAuthenticationControllerTrait
{
    use HasAuthenticationVariablesTrait;

    protected function beforeAction()
    {
        parent::beforeAction();
        $this->checkIsAuthenticated();
    }

    protected function afterActionViewVariables()
    {
        parent::afterActionViewVariables();

        $this->setAuthenticationVariablesInView();
    }

    /**
     * @param null $type

Are you sure the doc-type for parameter $type is correct as it would always require null to be passed?

     */
    protected function checkIsAuthenticated()
    {
        if ($this->getName() != 'logout' && $this->_getUser()->authenticated()) {

It seems like _getUser() must be provided by classes using this trait. How about adding it as abstract method to this trait?

It seems like getName() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            $this->doSuccessRedirect();
        }
    }

    /**
     * @param null $type

Are you sure the doc-type for parameter $type is correct as it would always require null to be passed?

     */
    protected function doSuccessRedirect($type = null)
    {
        $type = empty($type) ? $this->getName() : $type;
        $this->flashRedirect(
            $this->getModelManager()->getMessage($type . '-success'),

It seems like getModelManager() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            $this->getRedirectURL(),
            'success',
            'index'

'index' of type string is incompatible with the type boolean expected by parameter $name of ByTIC\Hello\Modules\AbstractModule\Controllers\Traits\AbstractAuthenticationControllerTrait::flashRedirect().

        );
    }

    /**
     * @return string
     */
    protected function getRedirectURL()
    {
        $redirectVariable = $this->getAuthenticationValue('redirect');
        if (!empty($redirectVariable)) {
            $url = urldecode($redirectVariable);
            if (valid_url($url)) {

The function valid_url was not found. Maybe you did not declare it correctly or list all dependencies?

                return $url;
            }
        }
        return $this->getGenericRedirectURL();
    }

    /**
     * @return string|null
     */
    protected function getGenericRedirectURL()
    {
        $module = $this->getRequest()->getModuleName();
        return $this->Url()->assemble($module . '.logged_in', $this->getAuthenticationVariables());

It seems like Url() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * @param $action
     */
    protected function _setMeta($action)
    {
        $label = $this->getModelManager()->getLabel($action . '-title');
        $urlMethod = 'get' . ucfirst($action) . 'URL';
        $this->getView()->Breadcrumbs()->addItem($label, $this->_getUser()->getManager()->$urlMethod());

        $this->getView()->Meta()->prependTitle($label);
    }

    /**
     * @inheritdoc
     */
    protected function generateModelName()
    {
        return get_class($this->_getUser()->getManager());
    }
}