JsUtils.php

Go to the documentation of this file.

<?php
namespace Ajax;

use Ajax\config\DefaultConfig;
use Ajax\config\Config;
use Ajax\common\traits\JsUtilsEventsTrait;
use Ajax\common\traits\JsUtilsActionsTrait;
use Ajax\common\traits\JsUtilsAjaxTrait;
use Ajax\common\traits\JsUtilsInternalTrait;
use Ajax\service\JArray;
use Ajax\service\Javascript;

abstract class JsUtils {
    use JsUtilsEventsTrait,JsUtilsActionsTrait,JsUtilsAjaxTrait,JsUtilsInternalTrait;

    protected $params;

    protected $injected;

    protected $_ui;

    protected $_bootstrap;

    protected $_semantic;

    protected $config;

    abstract public function getUrl($url);

    abstract public function addViewElement($identifier, $content, &$view);

    abstract public function createScriptVariable(&$view, $view_var, $output);

    abstract public function forward($initialController, $controller, $action, $params);

    abstract public function renderContent($initialControllerInstance, $viewName, $params = NULL);

    abstract public function fromDispatcher($dispatcher);

    public function ui(JqueryUI $ui = NULL) {
        if ($ui !== NULL) {
            $this->_ui = $ui;
            $ui->setJs($this);
            $bs = $this->bootstrap();
            if (isset($bs)) {
                $this->conflict();
            }
        }
        return $this->_ui;
    }

    public function bootstrap(Bootstrap $bootstrap = NULL) {
        if ($bootstrap !== NULL) {
            $this->_bootstrap = $bootstrap;
            $bootstrap->setJs($this);
            $ui = $this->ui();
            if (isset($ui)) {
                $this->conflict();
            }
        }
        return $this->_bootstrap;
    }

    public function semantic(Semantic $semantic = NULL) {
        if ($semantic !== NULL) {
            $this->_semantic = $semantic;
            $semantic->setJs($this);
            $ui = $this->ui();
            if (isset($ui)) {
                $this->conflict();
            }
        }
        return $this->_semantic;
    }

    public function config($config = NULL) {
        if ($config === NULL) {
            if ($this->config === NULL) {
                $this->config = new DefaultConfig();
            }
        } elseif (\is_array($config)) {
            $this->config = new Config($config);
        } elseif ($config instanceof Config) {
            $this->config = $config;
        }
        return $this->config;
    }

    public function __construct($params = array(), $injected = NULL) {
        $ajaxDefault = [
            'ajaxTransition' => null,
            'attr' => '',
            'historize' => false,
            'jsCallback' => null,
            'hasLoader' => true,
            'jqueryDone' => 'html',
            'async' => true,
            'params' => null,
            'headers' => null,
            'jsCondition' => null,
            'ajaxLoader' => null,
            'csrf' => false
        ];
        $defaults = [
            'debug' => true,
            'defer' => false,
            'ajax' => $ajaxDefault,
            'historize' => true,
            'autoActiveLinks' => true
        ];
        foreach ($defaults as $key => $val) {
            if (isset($params[$key]) === false || $params[$key] === "") {
                $params[$key] = $defaults[$key];
            }
        }
        foreach ($ajaxDefault as $key => $val) {
            if (isset($params["ajax"][$key]) === false || $params["ajax"][$key] === "") {
                $params["ajax"][$key] = $ajaxDefault[$key];
            }
        }

        if (\array_key_exists("semantic", $params)) {
            $this->semantic(new Semantic());
        }
        if (\array_key_exists("bootstrap", $params)) {
            $this->bootstrap(new Bootstrap());
        }
        if (isset($params["ajax"])) {
            if (isset($params["ajax"]["ajaxTransition"])) {
                $this->ajaxTransition = $this->setAjaxDataCall($params["ajax"]["ajaxTransition"]);
            }
            if ($params["ajax"]["historize"]) {
                $params["historize"] = true;
            }
            if ($params["ajax"]["csrf"]) {
                $this->exec($this->addCsrf(), true);
            }
        }
        if ($params["historize"]) {
            $this->execAtLast($this->onPopstate());
        }
        if ($params["autoActiveLinks"]) {
            $this->exec($this->autoActiveLinks(), true);
        }

        $this->params = $params;
        $this->injected = $injected;
        if (isset($params['gc'])) {
            \gc_disable();
        }
        $this->initialize();
    }

    protected function initialize() {}

    public function __set($property, $value) {
        switch ($property) {
            case "bootstrap":
                $this->bootstrap($value);
                break;
            case "semantic":
                $this->semantic(value);
                break;
            case "ui":
                $this->ui($value);
                break;
            default:
                throw new \Exception('Unknown property !');
        }
    }

    public function getParam($key) {
        if (isset($this->params[$key]))
            return $this->params[$key];
    }

    public function output($array_js) {
        if (! is_array($array_js)) {
            $array_js = array(
                $array_js
            );
        }

        foreach ($array_js as $js) {
            $this->jquery_code_for_compile[] = "\t$js\n";
        }
    }

    public function compile(&$view = NULL, $view_var = 'script_foot', $script_tags = TRUE) {
        if (isset($this->_ui)) {
            $this->_compileLibrary($this->_ui, $view);
        }
        if (isset($this->_bootstrap)) {
            $this->_compileLibrary($this->_bootstrap, $view);
        }
        if (isset($this->_semantic)) {
            $this->_compileLibrary($this->_semantic, $view);
        }

        $this->jquery_code_for_compile = \array_merge($this->jquery_code_for_compile, $this->jquery_code_for_compile_at_last);

        if (\count($this->jquery_code_for_compile) == 0) {
            return;
        }
        
        // Inline references
        $script = $this->ready(implode('', $this->jquery_code_for_compile));
        if ($this->params["defer"]) {
            $script = $this->defer($script);
        }
        $script .= ";";

        $this->jquery_code_for_compile = $this->jquery_code_for_compile_at_last = [];
        if ($this->params["debug"] === false) {
            $script = $this->minify($script);
        }
        $output = ($script_tags === FALSE) ? $script : $this->inline($script);

        if ($view !== NULL) {
            $this->createScriptVariable($view, $view_var, $output);
        }

        return $output;
    }

    public function clear_compile() {
        $this->jquery_code_for_compile = $this->jquery_code_for_compile_at_last = [];
        if($this->_bootstrap!==null){
            $this->_bootstrap->clearComponents();
        }
        if($this->_semantic!==null){
            $this->_semantic->clearComponents();
        }
        if($this->_ui!==null){
            $this->_ui->clearComponents();
        }
    }

    public function getScript($offset = 0) {
        $code = \array_merge($this->jquery_code_for_compile, $this->jquery_code_for_compile_at_last);
        if ($offset > 0) {
            $code = \array_slice($code, $offset);
        }
        return \implode('', $code);
    }

    public function scriptCount() {
        return \count($this->jquery_code_for_compile);
    }

    public function inline($script, $cdata = TRUE) {
        $str = $this->_open_script();
        $str .= ($cdata) ? "\n// <![CDATA[\n{$script}\n// ]]>\n" : "\n{$script}\n";
        $str .= $this->_close_script();
        return $str;
    }

    public function generate_json($result = NULL, $match_array_type = FALSE) {
        // JSON data can optionally be passed to this function
        // either as a database result object or an array, or a user supplied array
        if (! is_null($result)) {
            if (is_object($result)) {
                $json_result = $result->result_array();
            } elseif (\is_array($result)) {
                $json_result = $result;
            } else {
                return $this->_prep_args($result);
            }
        } else {
            return 'null';
        }
        return $this->_create_json($json_result, $match_array_type);
    }

    private function _create_json($json_result, $match_array_type) {
        $json = array();
        $_is_assoc = TRUE;
        if (! is_array($json_result) && empty($json_result)) {
            show_error("Generate JSON Failed - Illegal key, value pair.");
        } elseif ($match_array_type) {
            $_is_assoc = JArray::isAssociative($json_result);
        }
        foreach ($json_result as $k => $v) {
            if ($_is_assoc) {
                $json[] = $this->_prep_args($k, TRUE) . ':' . $this->generate_json($v, $match_array_type);
            } else {
                $json[] = $this->generate_json($v, $match_array_type);
            }
        }
        $json = implode(',', $json);
        return $_is_assoc ? "{" . $json . "}" : "[" . $json . "]";
    }

    public function _prep_args($result, $is_key = FALSE) {
        if (is_null($result)) {
            return 'null';
        } elseif (is_bool($result)) {
            return ($result === TRUE) ? 'true' : 'false';
        } elseif (is_string($result) || $is_key) {
            return '"' . str_replace(array(
                '\\',
                "\t",
                "\n",
                "\r",
                '"',
                '/'
            ), array(
                '\\\\',
                '\\t',
                '\\n',
                "\\r",
                '\"',
                '\/'
            ), $result) . '"';
        } elseif (is_scalar($result)) {
            return $result;
        }
    }

    public function _add_event($element, $js, $event, $preventDefault = false, $stopPropagation = false, $immediatly = true, $listenerOn = false) {
        if (\is_array($js)) {
            $js = implode("\n\t\t", $js);
        }
        if ($preventDefault === true) {
            $js = Javascript::$preventDefault . $js;
        }
        if ($stopPropagation === true) {
            $js = Javascript::$stopPropagation . $js;
        }
        if (\is_string($listenerOn)) {
            $event = "\n\t$(" . Javascript::prep_element($listenerOn) . ").on('{$event}'," . Javascript::prep_element($element) . ",function(event){\n\t\t{$js}\n\t});\n";
        } else {
            if (\array_search($event, $this->jquery_events) === false) {
                $event = "\n\t$(" . Javascript::prep_element($element) . ").bind('{$event}',function(event){\n\t\t{$js}\n\t});\n";
            } else {
                $event = "\n\t$(" . Javascript::prep_element($element) . ").{$event}(function(event){\n\t\t{$js}\n\t});\n";
            }
        }
        if ($immediatly)
            $this->jquery_code_for_compile[] = $event;
        return $event;
    }

    public function getInjected() {
        return $this->injected;
    }
    
    public function setParam(string $param,$value){
        $this->params[$param]=$value;
    }
}