Module::output() - Code Metrics - Inspection of "Removed old routering logic from module" - samsonos/php_core - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 033fc6...4822d4 )

by Vitaly
created 2016-01-11 17:38 UTC
Module::output() B

↳ Parent: Module
Complexity

Conditions	5
Paths	9
Size

Total Lines	53
Code Lines	20
Duplication

Lines	0
Ratio	0 %
Importance

Changes	3
Bugs	1	Features	0
Metric	Value
c	3
b	1
f	0
dl	0
loc	53
rs	8.7155
cc	5
eloc	20
nc	9
nop	1
How to fix Long Method

<?php
namespace samson\core;

// TODO: Разобраться почему с вызовом m()->render() во вьюхе, и почему не передаются параметры
use samsonframework\core\ResourcesInterface;
use samsonframework\core\SystemInterface;
use samsonphp\core\exception\ControllerActionNotFound;

/**
 * Модуль системы
 *
 * @author Vitaly Iegorov <[email protected]>
 * @version 1.0
 */
class Module implements iModule, \ArrayAccess

{
    /** Static module instances collection */
    public static $instances = array();

    /** Uniquer identifier to check pointers */
    public $uid;

    /** @var ResourcesInterface Pointer to module resource map */
    public $resourceMap;

    /** @var array TODO: WTF? */
    public $composerParameters = array();

    /** Collection for cachable callable controllers of module */
    protected $cacheControllers = array();

    /** Module views collection */
    protected $views = array();

    /** Module location */
    protected $path = '';

    /** Unique module identifier */
    protected $id = '';

    /** Path to view for rendering */
    protected $view_path = self::VD_POINTER_DEF;

    /** Pointer to view data entry */
    protected $data = array(self::VD_POINTER_DEF => array(self::VD_HTML => ''));

    /** Collection of data for view rendering, filled with default pointer */
    protected $view_data = array(self::VD_POINTER_DEF => array(self::VD_HTML => ''));

    /** Name of current view context entry */
    protected $view_context = self::VD_POINTER_DEF;

    /** Unique module cache path in local web-application */
    protected $cache_path;

    /** @var SystemInterface Instance for interaction with framework */
    protected $system;

    /**
     * Constructor
     *
     * @param string $id Module unique identifier
     * @param string $path Module location
     * @param ResourcesInterface $resourceMap Pointer to module resource map
     * @param SystemInterface $system
     */
    public function __construct($id, $path, ResourcesInterface $resourceMap, SystemInterface $system)
    {
        // Inject generic module dependencies
        $this->system = $system;

        // Store pointer to module resource map
        $this->resourceMap = &$resourceMap;
        // Save views list
        $this->views = $resourceMap->views;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}

        // Set default view context name
        $this->view_context = self::VD_POINTER_DEF;

        // Set up default view data pointer
        $this->data = &$this->view_data[$this->view_context];

        // Set module identifier
        $this->id = $id;

        // Set path to module
        $this->path(realpath($path));

        // Generate unique module identifier
        $this->uid = rand(0, 9999999) . '_' . microtime(true);

        // Add to module identifier to view data stack
        $this->data['id'] = $this->id;

        // Generate unique module cache path in local web-application
        $this->cache_path = __SAMSON_CWD__ . __SAMSON_CACHE_PATH . $this->id . '/';

        // Save ONLY ONE copy of this instance in static instances collection,
        // avoiding rewriting by cloned modules
        !isset(self::$instances[$this->id]) ? self::$instances[$this->id] = &$this : '';

        // Make view path relative to module - remove module path from view path
        $this->views = str_replace($this->path, '', $this->views);

        //elapsed('Registering module: '.$this->id.'('.$path.')' );
    }

    /** @see iModule::path() */
    public function path($value = null)
    {
        // Если передан параметр - установим его
        if (func_num_args()) {
            $this->path = isset($value{0}) ? rtrim(normalizepath($value), DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR : '';

            return $this;
        } // Вернем относительный путь к файлам модуля
        else return $this->path;
    }

    /**    @see iModule::title() */
    public function title($title = null)
    {
        return $this->set('title', $title);
    }

    /** @see iModule::set() */
    public function set($field, $value = null)
    {
        $this->__set($field, $value);

        return $this;
    }

    /**    @see iModule::id() */
    public function id()
    {
        return $this->id;
    }

    /** @see iModuleViewable::toView() */
    public function toView($prefix = null, array $restricted = array())
    {
        // Get all module data variables
        $view_data = array_merge($this->data, get_object_vars($this));

        // Remove plain HTML from view data
        unset($view_data[self::VD_HTML]);

        return $view_data;
    }

    /** @see iModule::html() */
    public function html($value = null)
    {
        //elapsed($this->id.' - Setting HTML for '.array_search(  $this->data, $this->view_data ).'('.strlen($value).')');

        // Если передан параметр то установим его
        if (func_num_args()) {
            $this->data[self::VD_HTML] = $value;
        } else {
            return $this->data['html'];
        }

        return $this;
    }

    public function view($viewPath)
    {
        // Find full path to view file
        $viewPath = $this->findView($viewPath);

        //elapsed($this->id.' - Changing current view to '.$view_path);

        // Switch view context to founded module view
        $this->viewContext($viewPath);

        // Set current view path
        $this->view_path = $viewPath;

        // Продолжим цепирование
        return $this;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * Find view file by its part in module view resources and return full path to it
     * @param string $viewPath Part of path to module view file
     * @return string Full path to view file
     */
    public function findView($viewPath)
    {
        // Remove file extension for correct array searching
        $viewPath = str_replace(array('.php', '.vphp'), '', $viewPath);

        // Try to find passed view_path in  resources views collection
        if (sizeof($view = preg_grep('/' . addcslashes($viewPath, '/\\') . '(\.php|\.vphp)/ui', $this->views))) {
            // Sort view paths to get the shortest path
            usort($view, array($this, 'sortStrings'));

            // Set current full view path as last found view
            return end($view);
        }

        return false;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * Perform module view context switching
     * @param string $view_path New view context name
     */
    protected function viewContext($view_path)
    {
        // Pointer to NEW view data context
        $new = &$this->view_data[$view_path];

        // Pointer to OLD view data context
        $old = &$this->view_data[$this->view_context];

        // If we are trying to switch to NEW view context
        if ($this->view_context !== $view_path) {
            //elapsed( $this->id.' - Switching view context from '.$this->view_context.' to '.$view_path );

            // Create new entry in view data collection if it does not exists
            if (!isset($this->view_data[$view_path])) {
                // Create new view data record
                $new = array();

                // If current view data context has view data
                if (isset($old)) {
                    //elapsed($old);
                    //elapsed( $this->id.' - Copying previous view context view data '.$this->view_context.' to new view context '.$view_path.'('.sizeof($old).')');

                    // Copy default view context view data to new view context
                    $new = array_merge($new, $old);
                }

                // Clear plain HTML for new view context
                $new[self::VD_HTML] = '';
            }

            // Change view data pointer to appropriate view data entry
            $this->data = &$new;

            // Save current context name
            $this->view_context = $view_path;
        }
        //else elapsed( $this->id.' - NO need to switch view context from '.$this->view_context.' to '.$view_path );
    }

    /**    @see iModule::render() */
    public function render($controller = null)
    {
        // Switch current system active module
        $old = &$this->system->active($this);

        // If specific controller action should be run
        if (isset($controller)) {
            // Define if this is a procedural controller or OOP
            $callback = function_exists($controller)
                ? $controller
                : array($this, iModule::OBJ_PREFIX . $controller);

            // If this controller action is present
            if (is_callable($callback)) {
                // Perform controller action
                call_user_func_array($callback, url()->parameters);
            } else {
                throw(new ControllerActionNotFound($this->id . '#' . $controller));
            }
        }

        // Output view
        echo $this->output();

        // Restore previous active module
        $this->system->active($old);
    }

    /**    @see iModule::output() */
    public function output($viewPath = null)
    {
        // If view path not specified - use current correct view path
        if (!isset($viewPath)) {
            $viewPath = $this->view_path;
        } elseif (isset($viewPath{0})) { // Direct rendering of specific view, not default view data entry
            elapsed('Outputting to a view is deprecated, split your rendering chain into ->view(..)->output()');
            $viewPath = $this->findView($viewPath);
        }

        //elapsed('['.$this->id.'] Rendering view context: ['.$viewPath.'] with ['.$renderer->id.']');

        // Switch view context to new module view
        $this->viewContext($viewPath);

        //elapsed($this->id.' - Outputing '.$view_path.'-'.sizeof($this->data));
        //elapsed(array_keys($this->view_data));

        // Get current view context plain HTML
        $out = $this->data[self::VD_HTML];

        // If view path specified
        if (isset($viewPath{0})) {
            // Временно изменим текущий модуль системы
            $old = s()->active($this);

            // Прорисуем представление модуля
            $out .= s()->render($this->path . $viewPath, $this->data);

            // Вернем на место текущий модуль системы
            s()->active($old);
        } elseif (!isset($out{0})) { // No plain HTML view data is set also
            return e('Cannot render view for module ## - No view path or data has been set', E_SAMSON_CORE_ERROR, $this->id);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        // Clear currently outputted view context from VCS
        unset($this->view_data[$viewPath]);

        // Get last element from VCS
        end($this->view_data);

        // Get last element from VCS name
        $this->view_context = key($this->view_data);

        // Set internal view data pointer to last VCS entry
        $this->data = &$this->view_data[$this->view_context];

        // Return view path to previous state
        $this->view_path = $this->view_context;

        // Вернем результат прорисовки
        return $out;
    }

    /** Обработчик уничтожения объекта */
    public function __destruct()
    {
        //trace('Уничтожение модуля:'.$this->id );

        // Очистим коллекцию загруженых модулей
        unset(Module::$instances[$this->id]);
    }

    /** Magic method for calling unexisting object methods */
    public function __call($method, $arguments)
    {
        //elapsed($this->id.' - __Call '.$method);

        // If value is passed - set it
        if (sizeof($arguments)) {
            // If first argument is object or array - pass method name as second parameter
            if (is_object($arguments[0]) || is_array($arguments[0])) $this->__set($arguments[0], $method);
            // Standard logic
            else  $this->__set($method, $arguments[0]);
        }

        // Chaining
        return $this;
    }

    // Магический метод для получения переменных представления модуля

    /** Обработчик сериализации объекта */
    public function __sleep()
    {
        return array('id', 'path', 'version', 'data', 'controllers', 'views');
    }

    /** Обработчик десериализации объекта */
    public function __wakeup()
    {
        // Fill global instances
        self::$instances[$this->id] = &$this;

        // Set up default view data pointer
        $this->view_data[self::VD_POINTER_DEF] = $this->data;

        // Set reference to view context entry
        $this->data = &$this->view_data[self::VD_POINTER_DEF];
    }

    // TODO: Переделать обработчик в одинаковый вид для объектов и простых

    /** Группа методов для доступа к аттрибутам в виде массива */
    public function offsetSet($offset, $value)
    {
        $this->__set($offset, $value);
    }

    public function offsetGet($offset)
    {
        return $this->__get($offset);
    }

    // Магический метод для установки переменных представления модуля

    public function __get($field)
    {
        // Установим пустышку как значение переменной
        $result = null;

        // Если указанная переменная представления существует - получим её значение
        if (isset($this->data[$field])) $result = &$this->data[$field];
        // Выведем ошибку
        else return e('Ошибка получения данных модуля(##) - Требуемые данные(##) не найдены', E_SAMSON_CORE_ERROR, array($this->id, $field));

        // Иначе вернем пустышку
        return $result;
    }

    public function __set($field, $value = null)
    {
        // This is object
        if (is_object($field)) {
            $implements = class_implements($field);
            // If iModuleViewable implements is passed
            if (
                // TODO: Remove old interface support in future
                in_array(ns_classname('iModuleViewable', 'samson\core'), $implements)

                || in_array(AutoLoader::className('IViewSettable', 'samson\core'), $implements)
                || in_array('samsonframework\core\RenderInterface', $implements)
            ) {
                $this->_setObject($field, $value);
            }
        } // If array is passed
        else if (is_array($field)) $this->_setArray($field, $value);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        // Set view variable
        else $this->data[$field] = $value;
    }

    public function offsetUnset($offset)
    {
        $this->data[$offset] = '';
    }

    public function offsetExists($offset)
    {
        return isset($this->data[$offset]);
    }

    /** Sort array by string length */
    protected function sortStrings($a, $b)
    {
        return strlen($b) - strlen($a);
    }

    /**
     * Create unique module cache folder structure in local web-application
     * @param string $file Path to file relative to module cache location
     * @param boolean $clear Flag to perform generic cache folder clearence
     * @return boolean TRUE if cache file has to be regenerated
     */
    protected function cache_refresh(& $file, $clear = true)
    {
        // If module cache folder does not exists - create it
        if (!file_exists($this->cache_path)) mkdir($this->cache_path, 0777, TRUE);

        // Build full path to cached file
        $file = $this->cache_path . $file;

        // If cached file does not exsits
        if (file_exists($file)) return false;
        // Needed file does not exists
        else {
            // If clearence flag set to true - clear all files in module cache directory with same extension
            if ($clear) File::clear($this->cache_path, pathinfo($file, PATHINFO_EXTENSION));

            // Singal for cache file regeneration
            return true;
        }
    }

    /**
     *
     * @param unknown $object
     * @param string $viewprefix
     */
    private function _setObject($object, $viewprefix = null)
    {
        // Generate viewprefix as only lowercase classname without NS if it is not specified
        $class_name = is_string($viewprefix) ? $viewprefix : '' . mb_strtolower(classname(get_class($object)), 'UTF-8');

        // Save object to view data
        $this->data[$class_name] = $object;

        // Add separator
        $class_name .= '_';

        // Generate objects view array data and merge it with view data
        $this->data = array_merge($this->data, $object->toView($class_name));
    }

    /**
     *
     * @param unknown $array
     * @param string $viewprefix
     */
    private function _setArray($array, $viewprefix = null)
    {
        // Save array to view data
        $this->data[$viewprefix] = $array;

        // Add array values to view data
        $this->data = array_merge($this->data, $array);
    }
}

samsonos / php_core

Push — master ( 033fc6...4822d4 )

Module::output() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like
