Ingenerator\KohanaView\ViewTemplateSelector

Complexity

Total Complexity

6

Size/Duplication

Total Lines	55
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Importance

Changes	3
Bugs	0	Features	1

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getTemplateName()	0	8	2
A	validateSpecifiedTemplateName()	0	14	3
A	calculateTemplateFromClassName()	0	10	1

<?php
namespace Ingenerator\KohanaView;

use Ingenerator\KohanaView\Exception\UnspecifiedTemplateNameException;

/**
 * The ViewTemplateSelector maps ViewModel classes to the appropriate template file. By default this is done by
 * converting the class name to a lowercased file path such that:
 *
 *   View_Model_Something_WithMixedCase => model/something/with_mixed_case
 *   \View\Stuff\In\NameSpace\Thing     => stuff/in/name_space/thing
 *   \Other\View\Hierarchy              => other/view/hierarchy
 *   \Other\View\HierarchyView          => other/view/hierarchy
 *   \Other\View\HierarchyViewModel     => other/view/hierarchy
 *
 * Views can also implement TemplateSpecifyingViewModel to provide a custom template file name when required.
 *
 * @author     Andrew Coulton <andrew@ingenerator.com>
 * @copyright  2015 inGenerator Ltd
 * @license    http://kohanaframework.org/license
 */
class ViewTemplateSelector
{

    /**
     * @param ViewModel $view
     *
     * @return string
     */
    public function getTemplateName(ViewModel $view)
    {
        if ($view instanceof TemplateSpecifyingViewModel) {
            return $this->validateSpecifiedTemplateName($view);
        } else {
            return $this->calculateTemplateFromClassName($view);
        }
    }

    /**
     * @param TemplateSpecifyingViewModel $view
     *
     * @return mixed
     * @throws \UnexpectedValueException if no template is provided
     */
    protected function validateSpecifiedTemplateName(TemplateSpecifyingViewModel $view)
    {
        $template   = $view->getTemplateName();
        $view_class = get_class($view);
        if ( ! $template) {
            throw UnspecifiedTemplateNameException::forEmptyValue($view_class);
        }

        if ( ! is_string($template)) {
            throw UnspecifiedTemplateNameException::forNonStringValue($view_class, $template);
        }

        return $template;
    }

    /**
     * @param ViewModel $view
     *
     * @return string
     */
    protected function calculateTemplateFromClassName(ViewModel $view)
    {
        $template = get_class($view);
        $template = preg_replace('/\\\\|_/', '/', $template);
        $template = preg_replace('#(^view/?(model)?/)|(?<!/)(view/?(model)?$)#i', '', $template);
        $template = preg_replace('/([a-z])([A-Z])/', '\1_\2', $template);
        $template = strtolower($template);

        return $template;
    }

}