Core::arrayMap() - Code Metrics - JuKu/JuKuCMS - Measure and Improve Code Quality continuously with Scrutinizer

Core::arrayMap() D
last analyzed 2018-09-20 13:04 UTC

↳ Parent: Core
Complexity

Conditions	27
Paths	34
Size

Total Lines	75
Code Lines	51
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	51
c	0
b	0
f	0
dl	0
loc	75
rs	4.1666
cc	27
nc	34
nop	2
How to fix Long Method Complexity

<?php
/**
 * Copyright (c) 2013-2017
 *
 * @category  Library
 * @package   Dwoo
 * @author    Jordi Boggiano <[email protected]>
 * @author    David Sanchez <[email protected]>
 * @copyright 2008-2013 Jordi Boggiano
 * @copyright 2013-2017 David Sanchez
 * @license   http://dwoo.org/LICENSE LGPLv3
 * @version   1.3.6
 * @date      2017-03-23
 * @link      http://dwoo.org/
 */

namespace Dwoo;

use ArrayAccess;
use Closure;
use Countable;
use Dwoo\Plugins\Blocks\PluginDynamic;
use Dwoo\Security\Policy as SecurityPolicy;
use Dwoo\Block\Plugin as BlockPlugin;
use Dwoo\Template\File as TemplateFile;
use Iterator;
use stdClass;
use Traversable;

/**
 * Main dwoo class, allows communication between the compiler, template and data classes.
 * <pre>
 * requirements :
 *  php 5.3.0 or above (might work below, it's a rough estimate)
 *  SPL and PCRE extensions (for php versions prior to 5.3.0)
 *  mbstring extension for some string manipulation plugins (especially if you intend to use UTF-8)
 * recommended :
 *  hash extension (for Dwoo\Template\Str - minor performance boost)
 * project created :
 *  2008-01-05
 * </pre>
 * This software is provided 'as-is', without any express or implied warranty.
 * In no event will the authors be held liable for any damages arising from the use of this software.
 */
class Core
{
    /**
     * Current version number.
     *
     * @var string
     */
    const VERSION = '1.3.6';

    /**
     * Unique number of this dwoo release, based on version number.
     * this can be used by templates classes to check whether the compiled template
     * has been compiled before this release or not, so that old templates are
     * recompiled automatically when Dwoo is updated
     */
    const RELEASE_TAG = 136;

    /**
     * Constants that represents all plugin types
     * these are bitwise-operation-safe values to allow multiple types
     * on a single plugin
     *
     * @var int
     */
    const CLASS_PLUGIN      = 1;
    const FUNC_PLUGIN       = 2;
    const NATIVE_PLUGIN     = 4;
    const BLOCK_PLUGIN      = 8;
    const COMPILABLE_PLUGIN = 16;
    const CUSTOM_PLUGIN     = 32;
    const SMARTY_MODIFIER   = 64;
    const SMARTY_BLOCK      = 128;
    const SMARTY_FUNCTION   = 256;
    const PROXY_PLUGIN      = 512;
    const TEMPLATE_PLUGIN   = 1024;

    /**
     * Constant to default namespaces of builtin plugins
     *
     * @var string
     */
    const NAMESPACE_PLUGINS_BLOCKS     = 'Dwoo\Plugins\Blocks\\';
    const NAMESPACE_PLUGINS_FILTERS    = 'Dwoo\Plugins\Filters\\';
    const NAMESPACE_PLUGINS_FUNCTIONS  = 'Dwoo\Plugins\Functions\\';
    const NAMESPACE_PLUGINS_HELPERS    = 'Dwoo\Plugins\Helpers\\';
    const NAMESPACE_PLUGINS_PROCESSORS = 'Dwoo\Plugins\Processors\\';

    /**
     * Character set of the template, used by string manipulation plugins.
     * it must be lowercase, but setCharset() will take care of that
     *
     * @see setCharset
     * @see getCharset
     * @var string
     */
    protected $charset = 'UTF-8';

    /**
     * Global variables that are accessible through $dwoo.* in the templates.
     * default values include:
     * $dwoo.version - current version number
     * $dwoo.ad - a Powered by Dwoo link pointing to dwoo.org
     * $dwoo.now - the current time
     * $dwoo.template - the current template filename
     * $dwoo.charset - the character set used by the template
     * on top of that, foreach and other plugins can store special values in there,
     * see their documentation for more details.
     *
     * @var array
     */
    protected $globals = array();

    /**
     * Directory where the compiled templates are stored.
     * defaults to DWOO_COMPILEDIR (= dwoo_dir/compiled by default)
     *
     * @var string
     */
    protected $compileDir;

    /**
     * Directory where the cached templates are stored.
     * defaults to DWOO_CACHEDIR (= dwoo_dir/cache by default)
     *
     * @var string
     */
    protected $cacheDir;

    /**
     * Directory where the template files are stored
     *
     * @var array
     */
    protected $templateDir = array();

    /**
     * Defines how long (in seconds) the cached files must remain valid.
     * can be overridden on a per-template basis
     * -1 = never delete
     * 0 = disabled
     * >0 = duration in seconds
     *
     * @var int
     */
    protected $cacheTime = 0;

    /**
     * Security policy object.
     *
     * @var SecurityPolicy
     */
    protected $securityPolicy = null;

    /**
     * Stores the custom plugins callbacks.
     *
     * @see addPlugin
     * @see removePlugin
     * @var array
     */
    protected $plugins = array();

    /**
     * Stores the filter callbacks.
     *
     * @see addFilter
     * @see removeFilter
     * @var array
     */
    protected $filters = array();

    /**
     * Stores the resource types and associated
     * classes / compiler classes.
     *
     * @var array
     */
    protected $resources = array(
        'file'   => array(
            'class'    => 'Dwoo\Template\File',
            'compiler' => null,
        ),
        'string' => array(
            'class'    => 'Dwoo\Template\Str',
            'compiler' => null,
        ),
    );

    /**
     * The dwoo loader object used to load plugins by this dwoo instance.
     *
     * @var ILoader
     */
    protected $loader = null;

    /**
     * Currently rendered template, set to null when not-rendering.
     *
     * @var ITemplate
     */
    protected $template = null;

    /**
     * Stores the instances of the class plugins during template runtime.
     *
     * @var array
     */
    protected $runtimePlugins = array();

    /**
     * Stores the returned values during template runtime.
     *
     * @var array
     */
    protected $returnData = array();

    /**
     * Stores the data during template runtime.
     *
     * @var array
     */
    protected $data = array();

    /**
     * Stores the current scope during template runtime.
     * this should ideally not be accessed directly from outside template code
     *
     * @var mixed
     */
    public $scope;

    /**
     * Stores the scope tree during template runtime.
     *
     * @var array
     */
    protected $scopeTree = array();

    /**
     * Stores the block plugins stack during template runtime.
     *
     * @var array
     */
    protected $stack = array();

    /**
     * Stores the current block plugin at the top of the stack during template runtime.
     *
     * @var BlockPlugin
     */
    protected $curBlock;

    /**
     * Stores the output buffer during template runtime.
     *
     * @var string
     */
    protected $buffer;

    /**
     * Stores plugin proxy.
     *
     * @var IPluginProxy
     */
    protected $pluginProxy;

    /**
     * Constructor, sets the cache and compile dir to the default values if not provided.
     *
     * @param string $compileDir path to the compiled directory, defaults to lib/compiled
     * @param string $cacheDir   path to the cache directory, defaults to lib/cache
     */
    public function __construct($compileDir = null, $cacheDir = null)
    {
        if ($compileDir !== null) {
            $this->setCompileDir($compileDir);
        }
        if ($cacheDir !== null) {
            $this->setCacheDir($cacheDir);
        }
        $this->initGlobals();
    }

    /**
     * Resets some runtime variables to allow a cloned object to be used to render sub-templates.
     *
     * @return void
     */
    public function __clone()
    {
        $this->template = null;
        unset($this->data);
        unset($this->returnData);
    }

    /**
     * Returns the given template rendered using the provided data and optional compiler.
     *
     * @param mixed     $_tpl      template, can either be a ITemplate object (i.e. TemplateFile), a
     *                             valid path to a template, or a template as a string it is recommended to
     *                             provide a ITemplate as it will probably make things faster, especially if
     *                             you render a template multiple times
     * @param mixed     $data      the data to use, can either be a IDataProvider object (i.e. Data) or
     *                             an associative array. if you're rendering the template from cache, it can be
     *                             left null
     * @param ICompiler $_compiler the compiler that must be used to compile the template, if left empty a default
     *                             Compiler will be used
     *
     * @return string|void or the template output if $output is false
     * @throws Exception
     */
    public function get($_tpl, $data = array(), $_compiler = null)
    {
        // a render call came from within a template, so we need a new dwoo instance in order to avoid breaking this one
        if ($this->template instanceof ITemplate) {

            $clone = clone $this;

            return $clone->get($_tpl, $data, $_compiler);
        }

        // auto-create template if required
        if ($_tpl instanceof ITemplate) {
            // valid, skip
        } elseif (is_string($_tpl)) {
            $_tpl = new TemplateFile($_tpl);
            $_tpl->setIncludePath($this->getTemplateDir());
        } else {
            throw new Exception('Dwoo->get\'s first argument must be a ITemplate (i.e. TemplateFile) or a valid path to a template file', E_USER_NOTICE);
        }

        // save the current template, enters render mode at the same time
        // if another rendering is requested it will be proxied to a new Core(instance
        $this->template = $_tpl;

        // load data
        if ($data instanceof IDataProvider) {
            $this->data = $data->getData();
        } elseif (is_array($data)) {
            $this->data = $data;
        } elseif ($data instanceof ArrayAccess) {
            $this->data = $data;
        } else {
            throw new Exception('Dwoo->get/Dwoo->output\'s data argument must be a IDataProvider object (i.e. Data) or an associative array', E_USER_NOTICE);
        }

        $this->addGlobal('template', $_tpl->getName());
        $this->initRuntimeVars($_tpl);

        // try to get cached template
        $file        = $_tpl->getCachedTemplate($this);
        $doCache     = $file === true;
        $cacheLoaded = is_string($file);

        if ($cacheLoaded === true) {
            // cache is present, run it
            ob_start();
            include $file;
            $this->template = null;

            return ob_get_clean();
        } else {
            $dynamicId = uniqid();

            // render template
            $compiledTemplate = $_tpl->getCompiledTemplate($this, $_compiler);
            $out              = include $compiledTemplate;

            // template returned false so it needs to be recompiled
            if ($out === false) {
                $_tpl->forceCompilation();
                $compiledTemplate = $_tpl->getCompiledTemplate($this, $_compiler);
                $out              = include $compiledTemplate;
            }

            if ($doCache === true) {
                $out = preg_replace('/(<%|%>|<\?php|<\?|\?>)/', '<?php /*' . $dynamicId . '*/ echo \'$1\'; ?>', $out);
                if (!class_exists(self::NAMESPACE_PLUGINS_BLOCKS . 'PluginDynamic')) {
                    $this->getLoader()->loadPlugin('PluginDynamic');
                }
                $out = PluginDynamic::unescape($out, $dynamicId, $compiledTemplate);
            }

            // process filters
            foreach ($this->filters as $filter) {
                if (is_array($filter) && $filter[0] instanceof Filter) {
                    $out = call_user_func($filter, $out);
                } else {
                    $out = call_user_func($filter, $this, $out);
                }
            }

            if ($doCache === true) {
                // building cache
                $file = $_tpl->cache($this, $out);

                // run it from the cache to be sure dynamics are rendered
                ob_start();
                include $file;
                // exit render mode
                $this->template = null;

                return ob_get_clean();
            } else {
                // no need to build cache
                // exit render mode
                $this->template = null;

                return $out;
            }
        }
    }

    /**
     * Registers a Global.
     * New globals can be added before compiling or rendering a template
     * but after, you can only update existing globals.
     *
     * @param string $name
     * @param mixed  $value
     *
     * @return $this
     * @throws Exception
     */
    public function addGlobal($name, $value)
    {
        if (null === $this->globals) {
            $this->initGlobals();
        }

        $this->globals[$name] = $value;

        return $this;
    }

    /**
     * Gets the registered Globals.
     *
     * @return array
     */
    public function getGlobals()
    {
        return $this->globals;
    }

    /**
     * Re-initializes the globals array before each template run.
     * this method is only callede once when the Dwoo object is created
     *
     * @return void
     */
    protected function initGlobals()
    {
        $this->globals = array(
            'version' => self::VERSION,
            'ad'      => '<a href="http://dwoo.org/">Powered by Dwoo</a>',
            'now'     => $_SERVER['REQUEST_TIME'],
            'charset' => $this->getCharset(),
        );
    }

    /**
     * Re-initializes the runtime variables before each template run.
     * override this method to inject data in the globals array if needed, this
     * method is called before each template execution
     *
     * @param ITemplate $tpl the template that is going to be rendered
     *
     * @return void
     */
    protected function initRuntimeVars(ITemplate $tpl)
    protected function initRuntimeVars(/** @scrutinizer ignore-unused */ ITemplate $tpl)
    {
        $this->runtimePlugins = array();
        $this->scope          = &$this->data;
        $this->scopeTree      = array();
        $this->stack          = array();
        $this->curBlock       = null;
        $this->buffer         = '';
        $this->returnData     = array();
    }

    /**
     * Adds a custom plugin that is not in one of the plugin directories.
     *
     * @param string   $name       the plugin name to be used in the templates
     * @param callback $callback   the plugin callback, either a function name,
     *                             a class name or an array containing an object
     *                             or class name and a method name
     * @param bool     $compilable if set to true, the plugin is assumed to be compilable
     *
     * @return void
     * @throws Exception
     */
    public function addPlugin($name, $callback, $compilable = false)
    {
        $compilable = $compilable ? self::COMPILABLE_PLUGIN : 0;
        if (is_array($callback)) {
            if (is_subclass_of(is_object($callback[0]) ? get_class($callback[0]) : $callback[0], 'Dwoo\Block\Plugin')) {
                $this->plugins[$name] = array(
                    'type'     => self::BLOCK_PLUGIN | $compilable,
                    'callback' => $callback,
                    'class'    => (is_object($callback[0]) ? get_class($callback[0]) : $callback[0])
                );
            } else {
                $this->plugins[$name] = array(
                    'type'     => self::CLASS_PLUGIN | $compilable,
                    'callback' => $callback,
                    'class'    => (is_object($callback[0]) ? get_class($callback[0]) : $callback[0]),
                    'function' => $callback[1]
                );
            }
        } elseif (is_string($callback)) {
            if (class_exists($callback)) {
                if (is_subclass_of($callback, 'Dwoo\Block\Plugin')) {
                    $this->plugins[$name] = array(
                        'type'     => self::BLOCK_PLUGIN | $compilable,
                        'callback' => $callback,
                        'class'    => $callback
                    );
                } else {
                    $this->plugins[$name] = array(
                        'type'     => self::CLASS_PLUGIN | $compilable,
                        'callback' => $callback,
                        'class'    => $callback,
                        'function' => ($compilable ? 'compile' : 'process')
                    );
                }
            } elseif (function_exists($callback)) {
                $this->plugins[$name] = array(
                    'type'     => self::FUNC_PLUGIN | $compilable,
                    'callback' => $callback
                );
            } else {
                throw new Exception('Callback could not be processed correctly, please check that the function/class you used exists');
            }
        } elseif ($callback instanceof Closure) {
            $this->plugins[$name] = array(
                'type'     => self::FUNC_PLUGIN | $compilable,
                'callback' => $callback
            );
        } elseif (is_object($callback)) {
            if (is_subclass_of($callback, 'Dwoo\Block\Plugin')) {
                $this->plugins[$name] = array(
                    'type'     => self::BLOCK_PLUGIN | $compilable,
                    'callback' => get_class($callback),
                    'class'    => $callback
                );
            } else {
                $this->plugins[$name] = array(
                    'type'     => self::CLASS_PLUGIN | $compilable,
                    'callback' => $callback,
                    'class'    => $callback,
                    'function' => ($compilable ? 'compile' : 'process')
                );
            }
        } else {
            throw new Exception('Callback could not be processed correctly, please check that the function/class you used exists');
        }
    }

    /**
     * Removes a custom plugin.
     *
     * @param string $name the plugin name
     *
     * @return void
     */
    public function removePlugin($name)
    {
        if (isset($this->plugins[$name])) {
            unset($this->plugins[$name]);
        }
    }

    /**
     * Adds a filter to this Dwoo instance, it will be used to filter the output of all the templates rendered by this
     * instance.
     *
     * @param mixed $callback a callback or a filter name if it is autoloaded from a plugin directory
     * @param bool  $autoload if true, the first parameter must be a filter name from one of the plugin directories
     *
     * @return void
     * @throws Exception
     */
    public function addFilter($callback, $autoload = false)
    {
        if ($autoload) {
            $class = self::NAMESPACE_PLUGINS_FILTERS . self::toCamelCase($callback);
            if (!class_exists($class) && !function_exists($class)) {
                try {
                    $this->getLoader()->loadPlugin($callback);
                }
                catch (Exception $e) {
                    if (strstr($callback, self::NAMESPACE_PLUGINS_FILTERS)) {
                        throw new Exception('Wrong filter name : ' . $callback . ', the "Filter" prefix should not be used, please only use "' . str_replace('Filter', '', $callback) . '"');
                    } else {
                        throw new Exception('Wrong filter name : ' . $callback . ', when using autoload the filter must be in one of your plugin dir as "name.php" containig a class or function named "Filter<name>"');
                    }
                }
            }

            if (class_exists($class)) {
                $callback = array(new $class($this), 'process');
            } elseif (function_exists($class)) {
                $callback = $class;
            } else {
                throw new Exception('Wrong filter name : ' . $callback . ', when using autoload the filter must be in one of your plugin dir as "name.php" containig a class or function named "Filter<name>"');
            }

            $this->filters[] = $callback;
        } else {
            $this->filters[] = $callback;
        }
    }

    /**
     * Removes a filter.
     *
     * @param mixed $callback callback or filter name if it was autoloaded
     *
     * @return void
     */
    public function removeFilter($callback)
    {
        if (($index = array_search(self::NAMESPACE_PLUGINS_FILTERS. 'Filter' . self::toCamelCase($callback), $this->filters,
                true)) !==
            false) {
            unset($this->filters[$index]);
        } elseif (($index = array_search($callback, $this->filters, true)) !== false) {
            unset($this->filters[$index]);
        } else {
            $class = self::NAMESPACE_PLUGINS_FILTERS . 'Filter' . $callback;
            foreach ($this->filters as $index => $filter) {
                if (is_array($filter) && $filter[0] instanceof $class) {
                    unset($this->filters[$index]);
                    break;
                }
            }
        }
    }

    /**
     * Adds a resource or overrides a default one.
     *
     * @param string   $name            the resource name
     * @param string   $class           the resource class (which must implement ITemplate)
     * @param callback $compilerFactory the compiler factory callback, a function that must return a compiler instance
     *                                  used to compile this resource, if none is provided. by default it will produce
     *                                  a Compiler object
     *
     * @return void
     * @throws Exception
     */
    public function addResource($name, $class, $compilerFactory = null)
    {
        if (strlen($name) < 2) {
            throw new Exception('Resource names must be at least two-character long to avoid conflicts with Windows paths');
        }

        if (!class_exists($class)) {
            throw new Exception(sprintf('Resource class %s does not exist', $class));
        }

        $interfaces = class_implements($class);
        if (in_array('Dwoo\ITemplate', $interfaces) === false) {
            throw new Exception('Resource class must implement ITemplate');
        }

        $this->resources[$name] = array(
            'class'    => $class,
            'compiler' => $compilerFactory
        );
    }

    /**
     * Removes a custom resource.
     *
     * @param string $name the resource name
     *
     * @return void
     */
    public function removeResource($name)
    {
        unset($this->resources[$name]);
        if ($name === 'file') {
            $this->resources['file'] = array(
                'class'    => 'Dwoo\Template\File',
                'compiler' => null
            );
        }
    }

    /**
     * Sets the loader object to use to load plugins.
     *
     * @param ILoader $loader loader
     *
     * @return void
     */
    public function setLoader(ILoader $loader)
    {
        $this->loader = $loader;
    }

    /**
     * Returns the current loader object or a default one if none is currently found.
     *
     * @return ILoader|Loader
     */
    public function getLoader()
    {
        if ($this->loader === null) {
            $this->loader = new Loader($this->getCompileDir());
        }

        return $this->loader;
    }

    /**
     * Returns the custom plugins loaded.
     * Used by the ITemplate classes to pass the custom plugins to their ICompiler instance.
     *
     * @return array
     */
    public function getCustomPlugins()
    {
        return $this->plugins;
    }

    /**
     * Return a specified custom plugin loaded by his name.
     * Used by the compiler, for executing a Closure.
     *
     * @param string $name
     *
     * @return mixed|null
     */
    public function getCustomPlugin($name)
    {
        if (isset($this->plugins[$name])) {
            return $this->plugins[$name]['callback'];
        }

        return null;
    }

    /**
     * Returns the cache directory with a trailing DIRECTORY_SEPARATOR.
     *
     * @return string
     */
    public function getCacheDir()
    {
        if ($this->cacheDir === null) {
            $this->setCacheDir(dirname(__DIR__) . DIRECTORY_SEPARATOR . 'cache' . DIRECTORY_SEPARATOR);
        }

        return $this->cacheDir;
    }

    /**
     * Sets the cache directory and automatically appends a DIRECTORY_SEPARATOR.
     *
     * @param string $dir the cache directory
     *
     * @return void
     * @throws Exception
     */
    public function setCacheDir($dir)
    {
        $this->cacheDir = rtrim($dir, '/\\') . DIRECTORY_SEPARATOR;
        if (!file_exists($this->cacheDir)) {
            mkdir($this->cacheDir, 0777, true);
        }
        if (is_writable($this->cacheDir) === false) {
            throw new Exception('The cache directory must be writable, chmod "' . $this->cacheDir . '" to make it writable');
        }
    }

    /**
     * Returns the compile directory with a trailing DIRECTORY_SEPARATOR.
     *
     * @return string
     */
    public function getCompileDir()
    {
        if ($this->compileDir === null) {
            $this->setCompileDir(dirname(__DIR__) . DIRECTORY_SEPARATOR . 'compiled' . DIRECTORY_SEPARATOR);
        }

        return $this->compileDir;
    }

    /**
     * Sets the compile directory and automatically appends a DIRECTORY_SEPARATOR.
     *
     * @param string $dir the compile directory
     *
     * @return void
     * @throws Exception
     */
    public function setCompileDir($dir)
    {
        $this->compileDir = rtrim($dir, '/\\') . DIRECTORY_SEPARATOR;
        if (!file_exists($this->compileDir)) {
            mkdir($this->compileDir, 0777, true);
        }
        if (is_writable($this->compileDir) === false) {
            throw new Exception('The compile directory must be writable, chmod "' . $this->compileDir . '" to make it writable');
        }
    }

    /**
     * Returns an array of the template directory with a trailing DIRECTORY_SEPARATOR
     *
     * @return array
     */
    public function getTemplateDir()
    {
        return $this->templateDir;
    }

    /**
     * sets the template directory and automatically appends a DIRECTORY_SEPARATOR
     * template directory is stored in an array
     *
     * @param string $dir
     *
     * @throws Exception
     */
    public function setTemplateDir($dir)
    {
        $tmpDir = rtrim($dir, '/\\') . DIRECTORY_SEPARATOR;
        if (is_dir($tmpDir) === false) {
            throw new Exception('The template directory: "' . $tmpDir . '" does not exists, create the directory or specify an other location !');
        }
        $this->templateDir[] = $tmpDir;
    }

    /**
     * Returns the default cache time that is used with templates that do not have a cache time set.
     *
     * @return int the duration in seconds
     */
    public function getCacheTime()
    {
        return $this->cacheTime;
    }

    /**
     * Sets the default cache time to use with templates that do not have a cache time set.
     *
     * @param int $seconds the duration in seconds
     *
     * @return void
     */
    public function setCacheTime($seconds)
    {
        $this->cacheTime = (int)$seconds;
    }

    /**
     * Returns the character set used by the string manipulation plugins.
     * the charset is automatically lowercased
     *
     * @return string
     */
    public function getCharset()
    {
        return $this->charset;
    }

    /**
     * Sets the character set used by the string manipulation plugins.
     * the charset will be automatically lowercased
     *
     * @param string $charset the character set
     *
     * @return void
     */
    public function setCharset($charset)
    {
        $this->charset = strtolower((string)$charset);
    }

    /**
     * Returns the current template being rendered, when applicable, or null.
     *
     * @return ITemplate|null
     */
    public function getTemplate()
    {
        return $this->template;
    }

    /**
     * Sets the current template being rendered.
     *
     * @param ITemplate $tpl template object
     *
     * @return void
     */
    public function setTemplate(ITemplate $tpl)
    {
        $this->template = $tpl;
    }

    /**
     * Sets the default compiler factory function for the given resource name.
     * a compiler factory must return a ICompiler object pre-configured to fit your needs
     *
     * @param string   $resourceName    the resource name (i.e. file, string)
     * @param callback $compilerFactory the compiler factory callback
     *
     * @return void
     */
    public function setDefaultCompilerFactory($resourceName, $compilerFactory)
    {
        $this->resources[$resourceName]['compiler'] = $compilerFactory;
    }

    /**
     * Returns the default compiler factory function for the given resource name.
     *
     * @param string $resourceName the resource name
     *
     * @return callback the compiler factory callback
     */
    public function getDefaultCompilerFactory($resourceName)
    {
        return $this->resources[$resourceName]['compiler'];
    }

    /**
     * Sets the security policy object to enforce some php security settings.
     * use this if untrusted persons can modify templates
     *
     * @param SecurityPolicy $policy the security policy object
     *
     * @return void
     */
    public function setSecurityPolicy(SecurityPolicy $policy = null)
    {
        $this->securityPolicy = $policy;
    }

    /**
     * Returns the current security policy object or null by default.
     *
     * @return SecurityPolicy|null the security policy object if any
     */
    public function getSecurityPolicy()
    {
        return $this->securityPolicy;
    }

    /**
     * Sets the object that must be used as a plugin proxy when plugin can't be found
     * by dwoo's loader.
     *
     * @param IPluginProxy $pluginProxy the proxy object
     *
     * @return void
     */
    public function setPluginProxy(IPluginProxy $pluginProxy)
    {
        $this->pluginProxy = $pluginProxy;
    }

    /**
     * Returns the current plugin proxy object or null by default.
     *
     * @return IPluginProxy
     */
    public function getPluginProxy()
    {
        return $this->pluginProxy;
    }

    /**
     * Checks whether the given template is cached or not.
     *
     * @param ITemplate $tpl the template object
     *
     * @return bool
     */
    public function isCached(ITemplate $tpl)
    {
        return is_string($tpl->getCachedTemplate($this));
    }

    /**
     * Clear templates inside the compiled directory.
     *
     * @return int
     */
    public function clearCompiled()
    {
        $iterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($this->getCompileDir()), \RecursiveIteratorIterator::SELF_FIRST);
        $count    = 0;
        foreach ($iterator as $file) {
            if ($file->isFile()) {
                $count += unlink($file->__toString()) ? 1 : 0;
            }
        }

        return $count;
    }

    /**
     * Clears the cached templates if they are older than the given time.
     *
     * @param int $olderThan minimum time (in seconds) required for a cached template to be cleared
     *
     * @return int the amount of templates cleared
     */
    public function clearCache($olderThan = - 1)
    {
        $iterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($this->getCacheDir()), \RecursiveIteratorIterator::SELF_FIRST);
        $expired  = time() - $olderThan;
        $count    = 0;
        foreach ($iterator as $file) {
            if ($file->isFile() && $file->getCTime() < $expired) {
                $count += unlink((string)$file) ? 1 : 0;
            }
        }

        return $count;
    }

    /**
     * Fetches a template object of the given resource.
     *
     * @param string    $resourceName   the resource name (i.e. file, string)
     * @param string    $resourceId     the resource identifier (i.e. file path)
     * @param int       $cacheTime      the cache time setting for this resource
     * @param string    $cacheId        the unique cache identifier
     * @param string    $compileId      the unique compiler identifier
     * @param ITemplate $parentTemplate the parent template
     *
     * @return ITemplate
     * @throws Exception
     */
    public function templateFactory($resourceName, $resourceId, $cacheTime = null, $cacheId = null, $compileId = null, ITemplate $parentTemplate = null)
    {
        if (isset($this->resources[$resourceName])) {
            /**
             * Interface ITemplate
             *
             * @var ITemplate $class
             */
            $class = $this->resources[$resourceName]['class'];

            return $class::templateFactory($this, $resourceId, $cacheTime, $cacheId, $compileId, $parentTemplate);

        }

        throw new Exception('Unknown resource type : ' . $resourceName);
    }

    /**
     * Checks if the input is an array or arrayaccess object, optionally it can also check if it's
     * empty.
     *
     * @param mixed $value        the variable to check
     * @param bool  $checkIsEmpty if true, the function will also check if the array|arrayaccess is empty,
     *                            and return true only if it's not empty
     *
     * @return int|bool true if it's an array|arrayaccess (or the item count if $checkIsEmpty is true) or false if it's
     *                  not an array|arrayaccess (or 0 if $checkIsEmpty is true)
     */
    public function isArray($value, $checkIsEmpty = false)
    {
        if (is_array($value) === true || $value instanceof ArrayAccess) {
            if ($checkIsEmpty === false) {
                return true;
            }

            return $this->count($value);
        }

        return false;
    }

    /**
     * Checks if the input is an array or a traversable object, optionally it can also check if it's
     * empty.
     *
     * @param mixed $value        the variable to check
     * @param bool  $checkIsEmpty if true, the function will also check if the array|traversable is empty,
     *                            and return true only if it's not empty
     *
     * @return int|bool true if it's an array|traversable (or the item count if $checkIsEmpty is true) or false if it's
     *                  not an array|traversable (or 0 if $checkIsEmpty is true)
     */
    public function isTraversable($value, $checkIsEmpty = false)
    {
        if (is_array($value) === true) {
            if ($checkIsEmpty === false) {
                return true;
            } else {
                return count($value) > 0;
            }
        } elseif ($value instanceof Traversable) {
            if ($checkIsEmpty === false) {
                return true;
            } else {
                return $this->count($value);
            }
        }

        return false;
    }

    /**
     * Counts an array or arrayaccess/traversable object.
     *
     * @param mixed $value the value to count
     *
     * @return int|bool the count for arrays and objects that implement countable, true for other objects that don't,
     *                  and 0 for empty elements
     */
    public function count($value)
    {
        if (is_array($value) === true || $value instanceof Countable) {
            return count($value);
        } elseif ($value instanceof ArrayAccess) {
            if ($value->offsetExists(0)) {
                return true;
            }
        } elseif ($value instanceof Iterator) {
            $value->rewind();
            if ($value->valid()) {
                return true;
            }
        } elseif ($value instanceof Traversable) {
            foreach ($value as $dummy) {
                return true;
            }
        }

        return 0;
    }

    /**
     * Triggers a dwoo error.
     *
     * @param string $message the error message
     * @param int    $level   the error level, one of the PHP's E_* constants
     *
     * @return void
     */
    public function triggerError($message, $level = E_USER_NOTICE)
    {
        if (!($tplIdentifier = $this->template->getResourceIdentifier())) {
            $tplIdentifier = $this->template->getResourceName();
        }
        trigger_error('Dwoo error (in ' . $tplIdentifier . ') : ' . $message, $level);
    }

    /**
     * Adds a block to the block stack.
     *
     * @param string $blockName the block name (without `Plugin` prefix)
     * @param array  $args      the arguments to be passed to the block's init() function
     *
     * @return BlockPlugin the newly created block
     */
    public function addStack($blockName, array $args = array())
    {
        if (isset($this->plugins[$blockName])) {
            $class = $this->plugins[$blockName]['class'];
        } else {
            $class = self::NAMESPACE_PLUGINS_BLOCKS . 'Plugin' . self::toCamelCase($blockName);
        }

        if ($this->curBlock !== null) {
            $this->curBlock->buffer(ob_get_contents());
            ob_clean();
        } else {
            $this->buffer .= ob_get_contents();
            ob_clean();
        }

        $block = new $class($this);

        call_user_func_array(array($block, 'init'), $args);

        $this->stack[] = $this->curBlock = $block;

        return $block;
    }

    /**
     * Removes the plugin at the top of the block stack.
     * Calls the block buffer() function, followed by a call to end() and finally a call to process()
     *
     * @return void
     */
    public function delStack()
    {
        $args = func_get_args();

        $this->curBlock->buffer(ob_get_contents());
        ob_clean();

        call_user_func_array(array($this->curBlock, 'end'), $args);

        $tmp = array_pop($this->stack);

        if (count($this->stack) > 0) {
            $this->curBlock = end($this->stack);
            $this->curBlock->buffer($tmp->process());
        } else {
            if ($this->buffer !== '') {
                echo $this->buffer;
                $this->buffer = '';
            }
            $this->curBlock = null;
            echo $tmp->process();
        }

        unset($tmp);
    }

    /**
     * Returns the parent block of the given block.
     *
     * @param BlockPlugin $block the block class plugin
     *
     * @return BlockPlugin|false if the given block isn't in the stack
     */
    public function getParentBlock(BlockPlugin $block)
    {
        $index = array_search($block, $this->stack, true);
        if ($index !== false && $index > 0) {
            return $this->stack[$index - 1];
        }

        return false;
    }

    /**
     * Finds the closest block of the given type, starting at the top of the stack.
     *
     * @param string $type the type of plugin you want to find
     *
     * @return BlockPlugin|false if no plugin of such type is in the stack
     */
    public function findBlock($type)
    {
        if (isset($this->plugins[$type])) {
            $type = $this->plugins[$type]['class'];
        } else {
            $type = self::NAMESPACE_PLUGINS_BLOCKS . 'Plugin_' . str_replace(self::NAMESPACE_PLUGINS_BLOCKS.'Plugin',
                    '', $type);
        }

        $keys = array_keys($this->stack);
        while (($key = array_pop($keys)) !== false) {
            if ($this->stack[$key] instanceof $type) {
                return $this->stack[$key];
            }
        }

        return false;
    }

    /**
     * Returns a Plugin of the given class.
     * this is so a single instance of every class plugin is created at each template run,
     * allowing class plugins to have "per-template-run" static variables
     *
     * @param string $class the class name
     *
     * @return mixed an object of the given class
     */
    public function getObjectPlugin($class)
    {
        if (isset($this->runtimePlugins[$class])) {
            return $this->runtimePlugins[$class];
        }

        return $this->runtimePlugins[$class] = new $class($this);
    }

    /**
     * Calls the process() method of the given class-plugin name.
     *
     * @param string $plugName the class plugin name (without `Plugin` prefix)
     * @param array  $params   an array of parameters to send to the process() method
     *
     * @return string the process() return value
     */
    public function classCall($plugName, array $params = array())
    {
        $class  = self::toCamelCase($plugName);
        $plugin = $this->getObjectPlugin($class);

        return call_user_func_array(array($plugin, 'process'), $params);
    }

    /**
     * Calls a php function.
     *
     * @param string $callback the function to call
     * @param array  $params   an array of parameters to send to the function
     *
     * @return mixed the return value of the called function
     */
    public function arrayMap($callback, array $params)
    {
        if ($params[0] === $this) {
            $addThis = true;
            array_shift($params);
        }
        if ((is_array($params[0]) || ($params[0] instanceof Iterator && $params[0] instanceof ArrayAccess))) {
            if (empty($params[0])) {
                return $params[0];
            }

            // array map
            $out = array();
            $cnt = count($params);

            if (isset($addThis)) {
                array_unshift($params, $this);
                $items = $params[1];
                $keys  = array_keys($items);

                if (is_string($callback) === false) {

                    while (($i = array_shift($keys)) !== null) {
                        $out[] = call_user_func_array($callback, array(1 => $items[$i]) + $params);
                    }
                } elseif ($cnt === 1) {
                    while (($i = array_shift($keys)) !== null) {
                        $out[] = $callback($this, $items[$i]);
                    }
                } elseif ($cnt === 2) {
                    while (($i = array_shift($keys)) !== null) {
                        $out[] = $callback($this, $items[$i], $params[2]);
                    }
                } elseif ($cnt === 3) {
                    while (($i = array_shift($keys)) !== null) {
                        $out[] = $callback($this, $items[$i], $params[2], $params[3]);
                    }
                } else {
                    while (($i = array_shift($keys)) !== null) {
                        $out[] = call_user_func_array($callback, array(1 => $items[$i]) + $params);
                    }
                }
            } else {
                $items = $params[0];
                $keys  = array_keys($items);

                if (is_string($callback) === false) {

                    while (($i = array_shift($keys)) !== null) {
                        $out[] = call_user_func_array($callback, array($items[$i]) + $params);
                    }
                } elseif ($cnt === 1) {
                    while (($i = array_shift($keys)) !== null) {
                        $out[] = $callback($items[$i]);
                    }
                } elseif ($cnt === 2) {
                    while (($i = array_shift($keys)) !== null) {
                        $out[] = $callback($items[$i], $params[1]);
                    }
                } elseif ($cnt === 3) {
                    while (($i = array_shift($keys)) !== null) {
                        $out[] = $callback($items[$i], $params[1], $params[2]);
                    }
                } elseif ($cnt === 4) {
                    while (($i = array_shift($keys)) !== null) {
                        $out[] = $callback($items[$i], $params[1], $params[2], $params[3]);
                    }
                } else {
                    while (($i = array_shift($keys)) !== null) {
                        $out[] = call_user_func_array($callback, array($items[$i]) + $params);
                    }
                }
            }

            return $out;
        } else {
            return $params[0];
        }
    }

    /**
     * Reads a variable into the given data array.
     *
     * @param string $varstr   the variable string, using dwoo variable syntax (i.e. "var.subvar[subsubvar]->property")
     * @param mixed  $data     the data array or object to read from
     * @param bool   $safeRead if true, the function will check whether the index exists to prevent any notices from
     *                         being output
     *
     * @return mixed
     */
    public function readVarInto($varstr, $data, $safeRead = false)
    {
        if ($data === null) {
            return null;
        }

        if (is_array($varstr) === false) {

            preg_match_all('#(\[|->|\.)?((?:[^.[\]-]|-(?!>))+)\]?#i', $varstr, $m);
        } else {
            $m = $varstr;
        }
        unset($varstr);

        foreach ($m[1] as $k => $sep) {
            if ($sep === '.' || $sep === '[' || $sep === '') {
                // strip enclosing quotes if present
                $m[2][$k] = preg_replace('#^(["\']?)(.*?)\1$#', '$2', $m[2][$k]);

                if ((is_array($data) || $data instanceof ArrayAccess) && ($safeRead === false || isset($data[$m[2][$k]]))) {
                    $data = $data[$m[2][$k]];
                } else {
                    return null;
                }
            } else {
                if (is_object($data) && ($safeRead === false || isset($data->{$m[2][$k]}))) {
                    $data = $data->{$m[2][$k]};
                } else {
                    return null;
                }
            }
        }

        return $data;
    }

    /**
     * Reads a variable into the parent scope.
     *
     * @param int    $parentLevels the amount of parent levels to go from the current scope
     * @param string $varstr       the variable string, using dwoo variable syntax (i.e.
     *                             "var.subvar[subsubvar]->property")
     *
     * @return mixed
     */
    public function readParentVar($parentLevels, $varstr = null)
    {
        $tree = $this->scopeTree;
        $cur  = $this->data;

        while ($parentLevels -- !== 0) {
            array_pop($tree);
        }

        while (($i = array_shift($tree)) !== null) {
            if (is_object($cur)) {
                $cur = $cur->{$i};
            } else {
                $cur = $cur[$i];
            }
        }

        if ($varstr !== null) {
            return $this->readVarInto($varstr, $cur);
        } else {
            return $cur;
        }
    }

    /**
     * Reads a variable into the current scope.
     *
     * @param string $varstr the variable string, using dwoo variable syntax (i.e. "var.subvar[subsubvar]->property")
     *
     * @return mixed
     */
    public function readVar($varstr)
    {
        if (is_array($varstr) === true) {

            $m = $varstr;
            unset($varstr);
        } else {
            if (strstr($varstr, '.') === false && strstr($varstr, '[') === false && strstr($varstr, '->') === false) {
                if ($varstr === 'dwoo') {
                    return $this->getGlobals();
                } elseif ($varstr === '__' || $varstr === '_root') {
                    return $this->data;
                } elseif ($varstr === '_' || $varstr === '_parent') {
                    $varstr = '.' . $varstr;

                    $tree   = $this->scopeTree;
                    $cur    = $this->data;
                    array_pop($tree);

                    while (($i = array_shift($tree)) !== null) {
                        if (is_object($cur)) {
                            $cur = $cur->{$i};
                        } else {
                            $cur = $cur[$i];
                        }
                    }

                    return $cur;
                }

                $cur = $this->scope;

                if (isset($cur[$varstr])) {
                    return $cur[$varstr];
                } else {
                    return null;
                }
            }

            if (substr($varstr, 0, 1) === '.') {
                $varstr = 'dwoo' . $varstr;
            }

            preg_match_all('#(\[|->|\.)?((?:[^.[\]-]|-(?!>))+)\]?#i', $varstr, $m);
        }

        $i = $m[2][0];
        if ($i === 'dwoo') {
            $cur = $this->getGlobals();
            array_shift($m[2]);
            array_shift($m[1]);
            switch ($m[2][0]) {
            case 'get':
                $cur = $_GET;
                break;
            case 'post':
                $cur = $_POST;
                break;
            case 'session':
                $cur = $_SESSION;
                break;
            case 'cookies':
            case 'cookie':
                $cur = $_COOKIE;
                break;
            case 'server':
                $cur = $_SERVER;
                break;
            case 'env':
                $cur = $_ENV;
                break;
            case 'request':
                $cur = $_REQUEST;
                break;
            case 'const':
                array_shift($m[2]);
                if (defined($m[2][0])) {
                    return constant($m[2][0]);
                } else {
                    return null;
                }
            }
            if ($cur !== $this->getGlobals()) {
                array_shift($m[2]);
                array_shift($m[1]);
            }
        } elseif ($i === '__' || $i === '_root') {
            $cur = $this->data;
            array_shift($m[2]);
            array_shift($m[1]);
        } elseif ($i === '_' || $i === '_parent') {
            $tree = $this->scopeTree;
            $cur  = $this->data;

            while (true) {
                array_pop($tree);
                array_shift($m[2]);
                array_shift($m[1]);
                if (current($m[2]) === '_' || current($m[2]) === '_parent') {
                    continue;
                }

                while (($i = array_shift($tree)) !== null) {
                    if (is_object($cur)) {
                        $cur = $cur->{$i};
                    } else {
                        $cur = $cur[$i];
                    }
                }
                break;
            }
        } else {
            $cur = $this->scope;
        }

        foreach ($m[1] as $k => $sep) {
            if ($sep === '.' || $sep === '[' || $sep === '') {
                if ((is_array($cur) || $cur instanceof ArrayAccess) && isset($cur[$m[2][$k]])) {
                    $cur = $cur[$m[2][$k]];
                } else {
                    return null;
                }
            } elseif ($sep === '->') {
                if (is_object($cur)) {
                    $cur = $cur->{$m[2][$k]};
                } else {
                    return null;
                }
            } else {
                return null;
            }
        }

        return $cur;
    }

    /**
     * Assign the value to the given variable.
     *
     * @param mixed  $value the value to assign
     * @param string $scope the variable string, using dwoo variable syntax (i.e. "var.subvar[subsubvar]->property")
     *
     * @return bool true if assigned correctly or false if a problem occured while parsing the var string
     */
    public function assignInScope($value, $scope)
    {
        if (!is_string($scope)) {

            $this->triggerError('Assignments must be done into strings, (' . gettype($scope) . ') ' . var_export($scope, true) . ' given', E_USER_ERROR);
        }
        if (strstr($scope, '.') === false && strstr($scope, '->') === false) {
            $this->scope[$scope] = $value;
        } else {
            // TODO handle _root/_parent scopes ?
            preg_match_all('#(\[|->|\.)?([^.[\]-]+)\]?#i', $scope, $m);

            $cur  = &$this->scope;
            $last = array(
                array_pop($m[1]),
                array_pop($m[2])
            );

            foreach ($m[1] as $k => $sep) {
                if ($sep === '.' || $sep === '[' || $sep === '') {
                    if (is_array($cur) === false) {
                        $cur = array();
                    }
                    $cur = &$cur[$m[2][$k]];
                } elseif ($sep === '->') {
                    if (is_object($cur) === false) {
                        $cur = new stdClass();
                    }
                    $cur = &$cur->{$m[2][$k]};
                } else {
                    return false;
                }
            }

            if ($last[0] === '.' || $last[0] === '[' || $last[0] === '') {
                if (is_array($cur) === false) {
                    $cur = array();
                }
                $cur[$last[1]] = $value;
            } elseif ($last[0] === '->') {
                if (is_object($cur) === false) {
                    $cur = new stdClass();
                }
                $cur->{$last[1]} = $value;
            } else {
                return false;
            }
        }
    }

    /**
     * Sets the scope to the given scope string or array.
     *
     * @param mixed $scope    a string i.e. "level1.level2" or an array i.e. array("level1", "level2")
     * @param bool  $absolute if true, the scope is set from the top level scope and not from the current scope
     *
     * @return array the current scope tree
     */
    public function setScope($scope, $absolute = false)
    {
        $old = $this->scopeTree;

        if (is_string($scope) === true) {
            $scope = explode('.', $scope);
        }

        if ($absolute === true) {
            $this->scope     = &$this->data;
            $this->scopeTree = array();
        }

        while (($bit = array_shift($scope)) !== null) {
            if ($bit === '_' || $bit === '_parent') {
                array_pop($this->scopeTree);
                $this->scope = &$this->data;
                $cnt         = count($this->scopeTree);
                for ($i = 0; $i < $cnt; ++ $i) {
                    $this->scope = &$this->scope[$this->scopeTree[$i]];
                }
            } elseif ($bit === '__' || $bit === '_root') {
                $this->scope     = &$this->data;
                $this->scopeTree = array();
            } elseif (isset($this->scope[$bit])) {
                if ($this->scope instanceof ArrayAccess) {
                    $tmp         = $this->scope[$bit];
                    $this->scope = &$tmp;
                } else {
                    $this->scope = &$this->scope[$bit];
                }
                $this->scopeTree[] = $bit;
            } else {
                unset($this->scope);
                $this->scope = null;
            }
        }

        return $old;
    }

    /**
     * Returns the entire data array.
     *
     * @return array
     */
    public function getData()
    {
        return $this->data;
    }

    /**
     * Sets a return value for the currently running template.
     *
     * @param string $name  var name
     * @param mixed  $value var value
     *
     * @return void
     */
    public function setReturnValue($name, $value)
    {
        $this->returnData[$name] = $value;
    }

    /**
     * Retrieves the return values set by the template.
     *
     * @return array
     */
    public function getReturnValues()
    {
        return $this->returnData;
    }

    /**
     * Returns a reference to the current scope.
     *
     * @return mixed
     */
    public function &getScope()
    {
        return $this->scope;
    }

    /**
     * Redirects all calls to unexisting to plugin proxy.
     *
     * @param string $method the method name
     * @param array  $args   array of arguments
     *
     * @return mixed
     * @throws Exception
     */
    public function __call($method, $args)
    {
        $proxy = $this->getPluginProxy();
        if (!$proxy) {

            throw new Exception('Call to undefined method ' . __CLASS__ . '::' . $method . '()');
        }

        return call_user_func_array($proxy->getCallback($method), $args);
    }

    /**
     * Convert plugin name from `auto_escape` to `AutoEscape`.
     * @param string $input
     * @param string $separator
     *
     * @return mixed
     */
    public static function toCamelCase($input, $separator = '_')
    {
        return join(array_map('ucfirst', explode($separator, $input)));
        return /** @scrutinizer ignore-call */ join(array_map('ucfirst', explode($separator, $input)));

        // TODO >= PHP5.4.32
        //return str_replace($separator, '', ucwords($input, $separator));
    }
}

JuKu / JuKuCMS

Core::arrayMap() D last analyzed 2018-09-20 13:04 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like

Core::arrayMap() D
last analyzed 2018-09-20 13:04 UTC
