Nip\Http\Request\Traits\InteractsWithMca

Complexity

Total Complexity

22

Size/Duplication

Total Lines	223
Duplicated Lines	0 %

Test Coverage

Coverage

43.75%

Importance

Changes	1
Bugs	0	Features	0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	getActionName()	0	7	2
A	setControllerName()	0	7	2
A	setControllerKey()	0	5	1
A	setModuleName()	0	7	2
A	getMCA()	0	3	1
A	hasMCA()	0	3	1
A	initControllerName()	0	3	1
A	getModuleName()	0	7	2
A	getActionDefault()	0	3	1
A	getModuleKey()	0	3	1
A	getControllerKey()	0	3	1
A	setModuleKey()	0	5	1
A	getActionKey()	0	3	1
A	setActionKey()	0	5	1
A	getControllerName()	0	7	2
A	setActionName()	0	7	2

<?php

namespace Nip\Http\Request\Traits;

/**
 * Class InteractsWithMca
 * @package Nip\Http\Request\Traits
 */
trait InteractsWithMca
{
    /**
     * Has the action been dispatched?
     * @var boolean
     */
    protected $dispatched = false;

    /**
     * Module
     * @var string
     */
    protected $module;

    /**
     * Module key for retrieving module from params
     * @var string
     */
    protected $moduleKey = 'module';

    /**
     * Controller
     * @var string
     */
    protected $controller;

    /**
     * Controller key for retrieving controller from params
     * @var string
     */
    protected $controllerKey = 'controller';

    /**
     * Action
     * @var string
     */
    protected $action;

    /**
     * Action key for retrieving action from params
     * @var string
     */
    protected $actionKey = 'action';

    /**
     * Retrieve the action key
     *
     * @return string
     */
    public function getActionKey()
    {
        return $this->actionKey;
    }

    /**
     * Set the action key
     *
     * @param string $key
     * @return self
     */
    public function setActionKey($key)
    {
        $this->actionKey = (string) $key;

        return $this;
    }

    /**
     * @return bool
     */
    public function hasMCA()
    {
        return $this->getMCA() != '..';
    }

    /**
     * @return string
     */
    public function getMCA()
    {
        return $this->getModuleName() . '.' . $this->getControllerName() . '.' . $this->getActionName();
    }

    /**
     * Retrieve the module name
     * @return string
     */
    public function getModuleName()
    {
        if (null === $this->module) {
            $this->module = $this->attributes->get($this->getModuleKey());
        }

        return $this->module;
    }

    /**
     * Retrieve the module key
     *
     * @return string
     */
    public function getModuleKey()
    {
        return $this->moduleKey;
    }

    /**
     * Set the module key
     *
     * @param string $key
     * @return $this
     */
    public function setModuleKey($key)
    {
        $this->moduleKey = (string) $key;

        return $this;
    }

    /**
     * Retrieve the controller name
     * @return string
     */
    public function getControllerName()
    {
        if ($this->controller === null) {
            $this->initControllerName();
        }

        return $this->controller;
    }

    public function initControllerName()
    {
        $this->controller = $this->attributes->get($this->getControllerKey());
    }

    /**
     * Retrieve the controller key
     *
     * @return string
     */
    public function getControllerKey()
    {
        return $this->controllerKey;
    }

    /**
     * Set the controller key
     *
     * @param string $key
     * @return self
     */
    public function setControllerKey($key)
    {
        $this->controllerKey = (string) $key;

        return $this;
    }

    /**
     * Retrieve the action name
     *
     * @return string
     */
    public function getActionName()
    {
        if (null === $this->action) {
            $this->setActionName($this->getActionDefault());
        }

        return $this->action;
    }

    /**
     * Set the action name
     * @param string $value
     * @return self
     */
    public function setActionName($value)
    {
        if ($value) {
            $this->action = $value;
        }

        return $this;
    }

    /**
     * @return string
     */
    public function getActionDefault()
    {
        return 'index';
    }

    /**
     * Set the controller name to use
     *
     * @param string $value
     * @return self
     */
    public function setControllerName($value)
    {
        if ($value) {
            $this->controller = $value;
        }

        return $this;
    }

    /**
     * Set the module name to use
     * @param string $value
     * @return self
     */
    public function setModuleName($value)
    {
        if ($value) {
            $this->module = $value;
        }

        return $this;
    }
}