Module::set() - Code Metrics - samsonos/php_core - Measure and Improve Code Quality continuously with Scrutinizer

Module::set() A
last analyzed 2016-10-04 09:30 UTC

↳ Parent: Module

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	3
c	0
b	0
f	0
nc	1
nop	2
dl	0
loc	6
ccs	2
cts	2
cp	1
crap	1
rs	9.4285

<?php declare(strict_types=1);
namespace samsonphp\core;

use samson\core\File;
use samsonframework\core\ResourcesInterface;
use samsonframework\core\SystemInterface;
use samsonframework\core\ViewInterface;
use samsonframework\resource\ResourceMap;
use samsonphp\core\deprecated\iModule;
use samsonphp\core\exception\ControllerActionNotFound;
use samsonphp\core\exception\ViewPathNotFound;
use samsonphp\core\exception\ViewVariableNotFound;

/**
 * Модуль системы
 *
 * @author Vitaly Iegorov <[email protected]>
 * @deprecated Will be merged with ExternalModule
 */
class Module implements \ArrayAccess, iModule
{
    /** 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();

    /** 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
        // TODO: Should be changed or removed
        $this->resourceMap = $resourceMap = ResourceMap::get($path);
        // Save views list
        $this->views = $resourceMap->views;

        // 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;
// Without braces (not recommended)
if (true)
    doSomething();

// Recommended
if (true) {
    doSomething();
}
    }

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

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

        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)
    {
        $this->data[self::VD_HTML] = $value;

        return $this;
    }

    public function view($viewPath)
    {
        if (is_a($viewPath, ViewInterface::class)) {
            $this->view_path = $viewPath;
        } elseif (is_string($viewPath)) {
            // Find full path to view file
            $foundViewPath = $this->findView($viewPath);

            // We could not find view
            if ($foundViewPath !== false) {
                // Switch view context to founded module view
                $this->viewContext($foundViewPath);

                // Set current view path
                $this->view_path = $foundViewPath;
            } else {
                throw(new ViewPathNotFound($viewPath));
            }
        }

        // Продолжим цепирование
        return $this;
    }

    /**
     * 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 );
    }

    /**
     * @param null $controller
     *
     * @throws ControllerActionNotFound
     */
    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)) {
            /**
             * TODO: This would be removed in next major version, here should be
             * passed real controller method for execution.
             */
            $controller = method_exists($this, iModule::OBJ_PREFIX . $controller)
                ? iModule::OBJ_PREFIX . $controller
                : $controller;

            // Define if this is a procedural controller or OOP
            $callback = array($this, $controller);

            // If this controller action is present
            if (method_exists($this, $controller)) {
                // Get passed arguments
                $parameters = func_get_args();
                // Remove first as its a controller action name
                array_shift($parameters);
                // Perform controller action with passed parameters
                call_user_func_array($callback, $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()
    {
        // If view path not specified - use current correct view path
        $viewPath = $this->view_path;

        if (is_string($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 = $this->system->active($this);

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

                // Вернем на место текущий модуль системы
                $this->system->active($old);
            }

            // 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;


        } elseif (is_a($viewPath, ViewInterface::class)) {
            /** @var ViewInterface $viewPath */
            return $viewPath->output();
        }
    }

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

        // If value is passed - set it
        if (count($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);
            } else { // Standard logic
                $this->__set($arguments[0], $method);
            }
        }

        // Chaining
        return $this;
    }

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

    /** Обработчик сериализации объекта */
    public function __sleep()
    {
        return array('id', 'path', 'data', '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($value, $offset)
    {
        $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 {
            throw(new ViewVariableNotFound($field));
        }

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

    public function __set($value, $field = null)
    {
        if (is_object($field) || is_array($field)) {
            $tempValue = $field;
            $field = $value;
            $value = $tempValue;

            // TODO: Will be added in next major version
            //throw new \Exception('ViewInterface::set($value, $name) has changed, first arg is variable second is name or prefix');
        }

		// This is object
		if (is_object($value) && is_a($value, 'samsonframework\core\RenderInterface')) {
			$this->_setObject($value, $field);
		} elseif (is_array($value)) { // If array is passed
			$this->_setArray($value, $field);
		} else { // Set view variable
            $this->data[$field] = $value;
		}
    }

    public function offsetUnset($offset)
    {
        unset($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, $folder = null)

    {
        // Add slash to end
        $folder = isset($folder) ? rtrim($folder, '/') . '/' : '';

        $path = $this->cache_path . $folder;

        // If module cache folder does not exists - create it
        if (!file_exists($path)) {
            mkdir($path, 0777, true);
        }

        // Build full path to cached file
        $file = $path . $file;

        // If cached file does not exsits
        if (!file_exists($file)) {
            // If clearence flag set to true - clear all files in module cache directory with same extension
            if ($clear) {
                File::clear($path, pathinfo($file, PATHINFO_EXTENSION));
            }

            // Signal for cache file regeneration
            return true;
        }

        return false;
    }

    /**
     *
     * @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(ns_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);
    }
}


1		<?php declare(strict_types=1);
2		namespace samsonphp\core;
3
4		use samson\core\File;
5		use samsonframework\core\ResourcesInterface;
6		use samsonframework\core\SystemInterface;
7		use samsonframework\core\ViewInterface;
8		use samsonframework\resource\ResourceMap;
9		use samsonphp\core\deprecated\iModule;
10		use samsonphp\core\exception\ControllerActionNotFound;
11		use samsonphp\core\exception\ViewPathNotFound;
12		use samsonphp\core\exception\ViewVariableNotFound;
13
14		/**
15		* Модуль системы
16		*
17		* @author Vitaly Iegorov <[email protected]>
18		* @deprecated Will be merged with ExternalModule
19		*/
20		class Module implements \ArrayAccess, iModule
21		{
22		/** Static module instances collection */
23		public static $instances = array();
24
25		/** Uniquer identifier to check pointers */
26		public $uid;
27
28		/** @var ResourcesInterface Pointer to module resource map */
29		public $resourceMap;
30
31		/** @var array TODO: WTF? */
32		public $composerParameters = array();
33
34		/** Module views collection */
35		protected $views = array();
36
37		/** Module location */
38		protected $path = '';
39
40		/** Unique module identifier */
41		protected $id;
42
43		/** Path to view for rendering */
44		protected $view_path = self::VD_POINTER_DEF;
45
46		/** Pointer to view data entry */
47		protected $data = array(self::VD_POINTER_DEF => array(self::VD_HTML => ''));
48
49		/** Collection of data for view rendering, filled with default pointer */
50		protected $view_data = array(self::VD_POINTER_DEF => array(self::VD_HTML => ''));
51
52		/** Name of current view context entry */
53		protected $view_context = self::VD_POINTER_DEF;
54
55		/** Unique module cache path in local web-application */
56		protected $cache_path;
57
58		/** @var SystemInterface Instance for interaction with framework */
59		protected $system;
60
61		/**
62		* Constructor
63		*
64		* @param string $id Module unique identifier
65		* @param string $path Module location
66	7	* @param ResourcesInterface $resourceMap Pointer to module resource map
67		* @param SystemInterface $system
68		*/
69	7	public function __construct($id, $path, ResourcesInterface $resourceMap, SystemInterface $system)
70		{
71		// Inject generic module dependencies
72	7	$this->system = $system;
73
74	7	// Store pointer to module resource map
75		// TODO: Should be changed or removed
76		$this->resourceMap = $resourceMap = ResourceMap::get($path);
77	7	// Save views list
78		$this->views = $resourceMap->views;
79
80	7	// Set default view context name
81		$this->view_context = self::VD_POINTER_DEF;
82
83	7	// Set up default view data pointer
84		$this->data = &$this->view_data[$this->view_context];
85
86	7	// Set module identifier
87		$this->id = $id;
88
89	7	// Set path to module
90		$this->path(realpath($path));
91
92	7	// Generate unique module identifier
93		$this->uid = rand(0, 9999999) . '_' . microtime(true);
94
95	7	// Add to module identifier to view data stack
96		$this->data['id'] = $this->id;
97
98		// Generate unique module cache path in local web-application
99	7	$this->cache_path = __SAMSON_CWD__ . __SAMSON_CACHE_PATH . $this->id . '/';
100
101		// Save ONLY ONE copy of this instance in static instances collection,
102	7	// avoiding rewriting by cloned modules
103		!isset(self::$instances[$this->id]) ? self::$instances[$this->id] = &$this : '';
104
105	7	// Make view path relative to module - remove module path from view path
106		$this->views = str_replace($this->path, '', $this->views);
107
108	7	//elapsed('Registering module: '.$this->id.'('.$path.')' );
109		}
110
111	7	/** @see iModule::path() */
112	7	public function path($value = null)
113		{
114	7	// Если передан параметр - установим его
115		if (func_num_args()) {
116	1	$this->path = isset($value{0}) ? rtrim(normalizepath($value), DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR : '';
117
118		return $this;
119		} // Вернем относительный путь к файлам модуля
120		else return $this->path;
		0 ignored issues – show Coding Style Best Practice introduced 2016-01-12 17:12 UTC by Report Bug Copy Issue Report It is generally a best practice to always use braces with control structures. Adding braces to control structures avoids accidental mistakes as your code changes: // Without braces (not recommended) if (true) doSomething(); // Recommended if (true) { doSomething(); } Loading history...
121		}
122
123		/** @see iModule::title() */
124		public function title($title = null)
125		{
126	1	return $this->set($title, 'title');
127		}
128	1
129		/** @see iModule::set() */
130	1	public function set($value, $field = null)
131		{
132		$this->__set($value, $field);
133
134	1	return $this;
135		}
136	1
137		/** @see iModule::id() */
138		public function id()
139		{
140		return $this->id;
141		}
142
143		/** @see iModuleViewable::toView() */
144		public function toView($prefix = null, array $restricted = array())
145		{
146		// Get all module data variables
147		$view_data = array_merge($this->data, get_object_vars($this));
148
149		// Remove plain HTML from view data
150		unset($view_data[self::VD_HTML]);
151
152	1	return $view_data;
153		}
154	1
155		/** @see iModule::html() */
156	1	public function html($value)
157		{
158		$this->data[self::VD_HTML] = $value;
159	3
160		return $this;
161		}
162	3
163		public function view($viewPath)
164		{
165	3	if (is_a($viewPath, ViewInterface::class)) {
166		$this->view_path = $viewPath;
167	3	} elseif (is_string($viewPath)) {
168		// Find full path to view file
169		$foundViewPath = $this->findView($viewPath);
170	3
171	3	// We could not find view
172	1	if ($foundViewPath !== false) {
173		// Switch view context to founded module view
174		$this->viewContext($foundViewPath);
175
176	3	// Set current view path
177		$this->view_path = $foundViewPath;
178		} else {
179		throw(new ViewPathNotFound($viewPath));
180		}
181		}
182
183		// Продолжим цепирование
184		return $this;
185	3	}
186
187		/**
188	3	* Find view file by its part in module view resources and return full path to it.
189		*
190		* @param string $viewPath Part of path to module view file
191	3	* @return string Full path to view file
192		*/
193	3	public function findView($viewPath)
194		{
195		// Remove file extension for correct array searching
196	3	$viewPath = str_replace(array('.php', '.vphp'), '', $viewPath);
197
198		// Try to find passed view_path in resources views collection
199	1	if (sizeof($view = preg_grep('/' . addcslashes($viewPath, '/\\') . '(\.php\|\.vphp)/ui', $this->views))) {
200		// Sort view paths to get the shortest path
201		usort($view, array($this, 'sortStrings'));
202
203		// Set current full view path as last found view
204		return end($view);
205		}
206	4
207		return false;
		0 ignored issues – show Bug Best Practice introduced 2016-08-23 07:25 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type documented by `samsonphp\core\Module::findView` of type `string`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: 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()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
208		}
209	4
210		/**
211		* Perform module view context switching
212	4	* @param string $view_path New view context name
213		*/
214		protected function viewContext($view_path)
215	4	{
216		// Pointer to NEW view data context
217		$new = &$this->view_data[$view_path];
218
219	3	// Pointer to OLD view data context
220		$old = &$this->view_data[$this->view_context];
221	3
222		// If we are trying to switch to NEW view context
223		if ($this->view_context !== $view_path) {
224	3	//elapsed( $this->id.' - Switching view context from '.$this->view_context.' to '.$view_path );
225
226		// Create new entry in view data collection if it does not exists
227		if (!isset($this->view_data[$view_path])) {
228		// Create new view data record
229	3	$new = array();
230	3
231		// If current view data context has view data
232		if (isset($old)) {
233	3	//elapsed($old);
234	3	//elapsed( $this->id.' - Copying previous view context view data '.$this->view_context.' to new view context '.$view_path.'('.sizeof($old).')');
235
236		// Copy default view context view data to new view context
237	3	$new = array_merge($new, $old);
238		}
239
240	3	// Clear plain HTML for new view context
241	3	$new[self::VD_HTML] = '';
242		}
243	4
244		// Change view data pointer to appropriate view data entry
245		$this->data = &$new;
246	1
247		// Save current context name
248		$this->view_context = $view_path;
249	1	}
250		//else elapsed( $this->id.' - NO need to switch view context from '.$this->view_context.' to '.$view_path );
251		}
252	1
253		/**
254		* @param null $controller
255		*
256		* @throws ControllerActionNotFound
257	1	*/
258	1	public function render($controller = null)
259	1	{
260		// Switch current system active module
261		$old = $this->system->active($this);
262	1
263		// If specific controller action should be run
264		if (isset($controller)) {
265	1	/**
266		* TODO: This would be removed in next major version, here should be
267	1	* passed real controller method for execution.
268		*/
269	1	$controller = method_exists($this, iModule::OBJ_PREFIX . $controller)
270		? iModule::OBJ_PREFIX . $controller
271	1	: $controller;
272	1
273	1	// Define if this is a procedural controller or OOP
274		$callback = array($this, $controller);
275	1
276		// If this controller action is present
277		if (method_exists($this, $controller)) {
278	1	// Get passed arguments
279		$parameters = func_get_args();
280		// Remove first as its a controller action name
281	1	array_shift($parameters);
282	1	// Perform controller action with passed parameters
283		call_user_func_array($callback, $parameters);
284		} else {
285	3	throw new ControllerActionNotFound($this->id . '#' . $controller);
286		}
287		}
288	3
289		// Output view
290		echo $this->output();
291
292		// Restore previous active module
293	3	$this->system->active($old);
294		}
295
296		/** @see iModule::output() */
297		public function output()
298		{
299	3	// If view path not specified - use current correct view path
300		$viewPath = $this->view_path;
301
302	3	if (is_string($viewPath)) {
		0 ignored issues – show Coding Style introduced 2016-03-02 15:50 UTC by Report Bug Copy Issue Report Blank line found at start of control structure Loading history...
303
304	2	//elapsed('['.$this->id.'] Rendering view context: ['.$viewPath.'] with ['.$renderer->id.']');
305
306		// Switch view context to new module view
307	2	$this->viewContext($viewPath);
308
309		//elapsed($this->id.' - Outputing '.$view_path.'-'.sizeof($this->data));
310	2	//elapsed(array_keys($this->view_data));
311	2
312		// Get current view context plain HTML
313		$out = $this->data[self::VD_HTML];
314	3
315		// If view path specified
316		if (isset($viewPath{0})) {
317	3	// Временно изменим текущий модуль системы
318		$old = $this->system->active($this);
319
320	3	// Прорисуем представление модуля
321		$out .= $this->system->render($this->path . $viewPath, $this->data);
322
323	3	// Вернем на место текущий модуль системы
324		$this->system->active($old);
325		}
326	3
327		// Clear currently outputted view context from VCS
328		unset($this->view_data[$viewPath]);
329	3
330		// Get last element from VCS
331		end($this->view_data);
332
333	1	// Get last element from VCS name
334		$this->view_context = key($this->view_data);
335
336		// Set internal view data pointer to last VCS entry
337		$this->data = &$this->view_data[$this->view_context];
338	1
339		// Return view path to previous state
340	1	$this->view_path = $this->view_context;
341	1
342	1	// Вернем результат прорисовки
343	1	return $out;
344
		0 ignored issues – show Coding Style introduced 2016-03-02 15:50 UTC by Report Bug Copy Issue Report Blank line found at end of control structure Loading history...
345	1	} elseif (is_a($viewPath, ViewInterface::class)) {
346		/** @var ViewInterface $viewPath */
347		return $viewPath->output();
348	1	}
349		}
350
351		/** Magic method for calling un existing object methods */
352		public function __call($method, $arguments)
353		{
354	1	//elapsed($this->id.' - __Call '.$method);
355
356	1	// If value is passed - set it
357		if (count($arguments)) {
358		// If first argument is object or array - pass method name as second parameter
359		if (is_object($arguments[0]) \|\| is_array($arguments[0])) {
360	1	$this->__set($arguments[0], $method);
361		} else { // Standard logic
362		$this->__set($arguments[0], $method);
363	1	}
364		}
365
366	1	// Chaining
367		return $this;
368		}
369	1
370	1	// Магический метод для получения переменных представления модуля
371
372		/** Обработчик сериализации объекта */
373		public function __sleep()
374		{
375	1	return array('id', 'path', 'data', 'views');
376		}
377	1
378	1	/** Обработчик десериализации объекта */
379		public function __wakeup()
380	2	{
381		// Fill global instances
382	2	self::$instances[$this->id] = &$this;
383
384		// Set up default view data pointer
385		$this->view_data[self::VD_POINTER_DEF] = $this->data;
386
387	3	// Set reference to view context entry
388		$this->data = &$this->view_data[self::VD_POINTER_DEF];
389		}
390	3
391		// TODO: Переделать обработчик в одинаковый вид для объектов и простых
392
393	3	/** Группа методов для доступа к аттрибутам в виде массива */
394	2	public function offsetSet($value, $offset)
395	2	{
396	1	$this->__set($offset, $value);
397		}
398
399		public function offsetGet($offset)
400	2	{
401		return $this->__get($offset);
402		}
403	3
404		// Магический метод для установки переменных представления модуля
405
406	3	public function __get($field)
407	1	{
408		// Установим пустышку как значение переменной
409		$result = null;
410
411	1	// Если указанная переменная представления существует - получим её значение
412	1	if (isset($this->data[$field])) {
413	1	$result = &$this->data[$field];
414	1	} else {
415	1	throw(new ViewVariableNotFound($field));
416	1	}
417	1
418	3	// Иначе вернем пустышку
419		return $result;
420	3	}
421	3
422		public function __set($value, $field = null)
423	1	{
424		if (is_object($field) \|\| is_array($field)) {
425	1	$tempValue = $field;
426	1	$field = $value;
427		$value = $tempValue;
428	2
429		// TODO: Will be added in next major version
430	2	//throw new \Exception('ViewInterface::set($value, $name) has changed, first arg is variable second is name or prefix');
431		}
432
433		// This is object
434	1	if (is_object($value) && is_a($value, 'samsonframework\core\RenderInterface')) {
435		$this->_setObject($value, $field);
436	1	} elseif (is_array($value)) { // If array is passed
437		$this->_setArray($value, $field);
438		} else { // Set view variable
439		$this->data[$field] = $value;
440		}
441		}
442
443		public function offsetUnset($offset)
444		{
445		unset($this->data[$offset]);
446	1	}
447
448		public function offsetExists($offset)
449	1	{
450	1	return isset($this->data[$offset]);
451	1	}
452
453		/** Sort array by string length */
454	1	protected function sortStrings($a, $b)
455		{
456		return strlen($b) - strlen($a);
457	1	}
458
459	1	/**
460	1	* Create unique module cache folder structure in local web-application.
461	1	*
462		* @param string $file Path to file relative to module cache location
463		* @param boolean $clear Flag to perform generic cache folder clearence
464	1	* @return boolean TRUE if cache file has to be regenerated
465		*/
466		protected function cache_refresh(&$file, $clear = true, $folder = null)
		0 ignored issues – show Coding Style introduced 2016-01-12 17:12 UTC by Report Bug Copy Issue Report Method name "Module::cache_refresh" is not in camel caps format Loading history...
467		{
468		// Add slash to end
469		$folder = isset($folder) ? rtrim($folder, '/') . '/' : '';
470
471		$path = $this->cache_path . $folder;
472
473		// If module cache folder does not exists - create it
474		if (!file_exists($path)) {
475	1	mkdir($path, 0777, true);
476		}
477
478	1	// Build full path to cached file
479		$file = $path . $file;
480
481	1	// If cached file does not exsits
482		if (!file_exists($file)) {
483		// If clearence flag set to true - clear all files in module cache directory with same extension
484	1	if ($clear) {
485		File::clear($path, pathinfo($file, PATHINFO_EXTENSION));
486		}
487	1
488	1	// Signal for cache file regeneration
489		return true;
490		}
491
492		return false;
493		}
494
495	1	/**
496		*
497		* @param unknown $object
498	1	* @param string $viewprefix
499		*/
500		private function _setObject($object, $viewprefix = null)
501	1	{
502	1	// Generate viewprefix as only lowercase classname without NS if it is not specified
503		$class_name = is_string($viewprefix) ? $viewprefix : '' . mb_strtolower(ns_classname(get_class($object)), 'UTF-8');
		0 ignored issues – show Deprecated Code introduced 2016-08-31 15:24 UTC by Report Bug Copy Issue Report The function `ns_classname()` has been deprecated with message: use \samson\core\AutoLoader::value() and pass full class name to it without splitting into class name and namespace This function has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the function will be removed from the class and what other function to use instead. Loading history...
504
505		// Save object to view data
506		$this->data[$class_name] = $object;
507
508		// Add separator
509		$class_name .= '_';
510
511		// Generate objects view array data and merge it with view data
512		$this->data = array_merge($this->data, $object->toView($class_name));
513		}
514
515		/**
516		*
517		* @param unknown $array
518		* @param string $viewprefix
519		*/
520		private function _setArray($array, $viewprefix = null)
521		{
522		// Save array to view data
523		$this->data[$viewprefix] = $array;
524
525		// Add array values to view data
526		$this->data = array_merge($this->data, $array);
527		}
528		}
529

samsonos / php_core

Module::set() A last analyzed 2016-10-04 09:30 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Module::set() A
last analyzed 2016-10-04 09:30 UTC