PPI\Framework\Module\Controller\ControllerNameParser

Complexity

Total Complexity

8

Size/Duplication

Total Lines	77
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	5
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	parse()	0	18	3
A	build()	0	6	1
A	getPartsFromControllerName()	0	21	3

<?php
/**
 * This file is part of the PPI Framework.
 *
 * @copyright   Copyright (c) 2011-2016 Paul Dragoonis <paul@ppi.io>
 * @license     http://opensource.org/licenses/mit-license.php MIT
 *
 * @link        http://www.ppi.io
 */

namespace PPI\Framework\Module\Controller;

use Zend\ModuleManager\ModuleManagerInterface;

/**
 * ControllerNameParser converts controller from the short notation a:b:c
 * (BlogModule:Post:index) to a fully-qualified class::method string
 * (Module\BlogModule\Controller\PostController::indexAction).
 *
 * @author     Fabien Potencier <fabien@symfony.com>
 * @author     Vítor Brandão <vitor@ppi.io>
 * @author     Paul Dragoonis <paul@ppi.io>
 */
class ControllerNameParser
{
    protected $moduleManager;

    /**
     * Constructor.
     *
     * @param ModuleManagerInterface $moduleManager A ModuleManagerInterface instance
     */
    public function __construct(ModuleManagerInterface $moduleManager)
    {
        $this->moduleManager = $moduleManager;
    }

    /**
     * Converts a short notation a:b:c to a class::method.
     *
     * @param string $controller A short notation controller (a:b:c)
     *
     * @throws \InvalidArgumentException when the specified module is not enabled
     *                                   or the controller cannot be found
     *
     * @return string A string with class::method
     */
    public function parse($controller)
    {
        list($module, $moduleName, $controller, $action) = $this->getPartsFromControllerName($controller);

        if (null === $module) {
            // this throws an exception if there is no such module
            $msg = sprintf('Unable to find controller "%s:%s" - module alias "%s" does not exist.', $moduleName, $controller, $moduleAlias);

The variable $moduleAlias does not exist. Did you mean $module?

        } else {
            $class = $module->getNamespace() . '\\Controller\\' . $controller;
            if (class_exists($class)) {
                return $class . '::' . $action . 'Action';
            }

            $msg = sprintf('Unable to find controller "%s:%s" - class "%s" does not exist.', $moduleName, $controller, $class);
        }

        throw new \InvalidArgumentException($msg);
    }

    public function build($controller)
    {
        list($module, $moduleName, $controllerName, $actionName) = $this->getPartsFromControllerName($controller);

The assignment to $module is unused. Consider omitting it like so list($first,,$third).

        return sprintf('%s:%s:%s', $moduleName, $controllerName, $actionName);
    }

    /**
     * @param string $controller
     *
     * @return array
     */
    private function getPartsFromControllerName($controller)
    {
        if (3 != count($parts = explode(':', $controller))) {
            throw new \InvalidArgumentException(sprintf('The "%s" controller is not a valid a:b:c controller string.', $controller));
        }

        list($moduleName, $controller, $action) = $parts;
        $controller = str_replace('/', '\\', $controller);
        $module     = $this->moduleManager->getModule($moduleName);

The method getModule() does not exist on Zend\ModuleManager\ModuleManagerInterface. Did you maybe mean getModules()?

        if (!is_object($module)) {
            throw new \RuntimeException(sprintf(
                'Unable to locate module: %s, when parsing controller: %s',
                $moduleName, $controller
            ));
        }

        $moduleName = $module->getName();

        return [$module, $moduleName, $controller, $action];
    }
}