DLTemplate::setPHxPlaceholders() - Code Metrics - AgelxNash/DocLister - Measure and Improve Code Quality continuously with Scrutinizer

DLTemplate::setPHxPlaceholders() A
last analyzed 2025-02-01 16:32 UTC

↳ Parent: DLTemplate
Complexity

Conditions	4
Paths	6
Size

Total Lines	10
Code Lines	7
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	20
Importance

Changes
Metric	Value
eloc	7
c	0
b	0
f	0
dl	0
loc	10
ccs	0
cts	6
cp	0
rs	10
cc	4
nc	6
nop	3
crap	20
<?php
if (!class_exists('\\DLTemplate')) {

    include_once(MODX_BASE_PATH . 'assets/lib/APIHelpers.class.php');

    /**
     * Class DLTemplate
     */
    class DLTemplate
    {
        /**
         * Объект DocumentParser - основной класс MODX
         * @var DocumentParser $modx
         * @access protected
         */
        protected $modx = null;

        /**
         * @var DLTemplate cached reference to singleton instance
         */
        protected static $instance;

        protected $templatePath = 'assets/templates/';

        protected $templateExtension = 'html';

        /**
         * @var null|Twig_Environment
filter:
    dependency_paths: ["lib/*"]
         */
        protected $twig;
        /*
         * @var Illuminate\View\Factory
filter:
    dependency_paths: ["lib/*"]
         */
        protected $blade;

        protected $twigEnabled = false;
        protected $bladeEnabled = false;
            
        protected $templateData = array();

        public $phx;

        /**
         * gets the instance via lazy initialization (created on first usage)
         *
         * @return self
         */
        public static function getInstance(DocumentParser $modx)
        {

            if (null === self::$instance) {
                self::$instance = new self($modx);
            }

            return self::$instance;
        }

        /**
         * is not allowed to call from outside: private!
         *
         */
        private function __construct(DocumentParser $modx)
        {
            $this->modx = $modx;
        }

        /**
         * prevent the instance from being cloned
         *
         * @return void
         */
        private function __clone()
        {
        }

        /**
         * prevent from being unserialized
         *
         * @return void
         */
        public function __wakeup()
        {
        }

        public function getTemplatePath()
        {
            return $this->templatePath;
        }

        /**
         * Задает относительный путь к папке с шаблонами
         *
         * @param string $path
         * @param bool $supRoot
         * @return $this
         */
        public function setTemplatePath($path, $supRoot = false)
        {
            $path = trim($path ?? '');
            if ($supRoot === false) {
                $path = $this->cleanPath($path);
            }

            if (!empty($path)) {

                $this->templatePath = $path;
                if ($this->twigEnabled) {
                    $this->twig->setLoader(new \Twig\Loader\FilesystemLoader(MODX_BASE_PATH . $path));
                                 setLoader(new \Twig\Loader\FilesystemLoader(MODX_BASE_PATH . $path));
                }
                if ($this->bladeEnabled) {
                    $filesystem = new Illuminate\Filesystem\Filesystem;
filter:
    dependency_paths: ["lib/*"]
                    $viewFinder = new Illuminate\View\FileViewFinder($filesystem, [MODX_BASE_PATH . $path]);
filter:
    dependency_paths: ["lib/*"]
                    $this->blade->setFinder($viewFinder);
                }
            }

            return $this;
        }

        /**
         * @param string $path
         * @return string
         */
        protected function cleanPath($path)
        {
            return preg_replace(array('/\.*[\/|\\\]/i', '/[\/|\\\]+/i'), array('/', '/'), $path);
        }

        public function getTemplateExtension()
        {
            return $this->templateExtension;
        }

        /**
         * Задает расширение файла с шаблоном
         *
         * @param $ext
         * @return $this
         */
        public function setTemplateExtension($ext)
        {
            $ext = $this->cleanPath(trim($ext ?? '', ". \t\n\r\0\x0B"));

            if (!empty($ext)) {

                $this->templateExtension = $ext;
            }

            return $this;
        }

        /**
         * Additional data for external templates
         *
         * @param array $data
         * @return $this
         */
        public function setTemplateData($data = array())
        {
            if (is_array($data)) {

                $this->templateData = $data;
            }

            return $this;
        }

        /**
         * @param array $data
         * @return array
         */
        public function getTemplateData($data = array())
        {
            $plh = $this->templateData;
            $plh['data'] = $data;
            $plh['modx'] = $this->modx;

            return $plh;
        }

        /**
         * Сохранение данных в массив плейсхолдеров
         *
         * @param mixed $data данные
         * @param int $set устанавливать ли глобальнй плейсхолдер MODX
         * @param string $key ключ локального плейсхолдера
         * @param string $prefix префикс для ключей массива
         * @return string
         */
        public function toPlaceholders($data, $set = 0, $key = 'contentPlaceholder', $prefix = '')
        {
            $out = '';
            if ($set != 0) {
                $this->modx->toPlaceholder($key, $data, $prefix);
                             toPlaceholder($key, $data, $prefix);
            } else {
                $out = $data;
            }

            return $out;
        }

        /**
         * refactor $modx->getChunk();
         *
         * @param string $name Template: chunk name || @CODE: template || @FILE: file with template
         * @return string html template with placeholders without data
         */
        public function getChunk($name)

        {
            $tpl = '';
            $ext = null;
            $this->bladeEnabled = substr($name, 0, 3) == '@B_';//(0 === strpos($name, '@B_'));
            if ($name != '' && !isset($this->modx->chunkCache[$name])) {

                $mode = (preg_match(
                    '/^((@[A-Z_]+)[:]{0,1})(.*)/Asu',
                    trim($name),
                    $tmp
                ) && isset($tmp[2], $tmp[3])) ? $tmp[2] : false;
                $subTmp = (isset($tmp[3])) ? trim($tmp[3]) : null;
                if ($this->bladeEnabled) {
                    $ext = $this->getTemplateExtension();
                    $this->setTemplateExtension('blade.php');
                }
                switch ($mode) {
                    case '@T_FILE':
                        if ($subTmp != '' && $this->twigEnabled) {
                            $real = realpath(MODX_BASE_PATH . $this->templatePath);
                            $path = realpath(MODX_BASE_PATH . $this->templatePath . $this->cleanPath($subTmp) . '.' . $this->templateExtension);
                            if (basename($path, '.' . $this->templateExtension) !== '' &&
                                0 === strpos($path, $real) &&
                                file_exists($path)
                            ) {
                                $tpl = $this->twig->load($this->cleanPath($subTmp) . '.' . $this->templateExtension);
                            }
                        }
                        break;
                    case '@T_CODE':
                        if ($this->twigEnabled) {
                            $tpl = $tmp[3];
                            $tpl = $this->twig->createTemplate($tpl);
                        }
                        break;
                    case '@B_FILE':
                        if ($subTmp != '' && $this->bladeEnabled) {
                            $real = realpath(MODX_BASE_PATH . $this->templatePath);
                            $path = realpath(MODX_BASE_PATH . $this->templatePath . $this->cleanPath($subTmp) . '.' . $this->templateExtension);
                            if (basename($path, '.' . $this->templateExtension) !== '' &&
                                0 === strpos($path, $real) &&
                                file_exists($path)
                            ) {
                                $tpl = $this->cleanPath($subTmp);
                            }
                        }
                        break;
                    case '@B_CODE':
                        $cache = md5($name). '-'. sha1($subTmp);
                        $cache = md5($name). '-'. sha1(/** @scrutinizer ignore-type */ $subTmp);
                        $path = MODX_BASE_PATH . '/assets/cache/blade/' . $cache . '.blade.php';
                        if (! file_exists($path)) {
                            file_put_contents($path, $tpl);
                        }
                        $tpl = 'cache::' . $cache;
                        break;
                    case '@FILE':
                        if ($subTmp != '') {
                            $real = realpath(MODX_BASE_PATH . $this->templatePath);
                            $path = realpath(MODX_BASE_PATH . $this->templatePath . $this->cleanPath($subTmp) . '.' . $this->templateExtension);
                            if (basename($path, '.' . $this->templateExtension) !== '' &&
                                0 === strpos($path, $real) &&
                                file_exists($path)
                            ) {
                                $tpl = file_get_contents($path);
                            }
                        }
                        break;
                    case '@INLINE':
                    case '@TPL':
                    case '@CODE':
                        $tpl = $tmp[3]; //without trim
                        break;
                    case '@DOCUMENT':
                    case '@DOC':
                        switch (true) {
                            case ((int)$subTmp > 0):
                                $tpl = $this->modx->getPageInfo((int)$subTmp, 0, "content");
                                $tpl = $this->modx->getPageInfo((int)$subTmp, 0, "content");
                                $tpl = isset($tpl['content']) ? $tpl['content'] : '';
                                break;
                            case ((int)$subTmp == 0):
                                $tpl = $this->modx->documentObject['content'];

                                break;
                        }
                        break;
                    case '@PLH':
                    case '@PLACEHOLDER':
                        if ($subTmp != '') {
                            $tpl = $this->modx->getPlaceholder($subTmp);
                            $tpl = $this->modx->getPlaceholder($subTmp);
                        }
                        break;
                    case '@CFG':
                    case '@CONFIG':
                    case '@OPTIONS':
                        if ($subTmp != '') {
                            $tpl = $this->modx->getConfig($subTmp);
                            $tpl = $this->modx->getConfig($subTmp);
                        }
                        break;
                    case '@SNIPPET':
                        if ($subTmp != '') {
                            $tpl = $this->modx->runSnippet($subTmp, $this->modx->event->params);
                            $tpl = $this->modx->runSnippet($subTmp, $this->modx->event->params);
                        }
                        break;
                    case '@RENDERPAGE':
                        $tpl = $this->renderDoc($subTmp, false);
                        $tpl = $this->renderDoc(/** @scrutinizer ignore-type */ $subTmp, false);
                        break;
                    case '@LOADPAGE':
                        $tpl = $this->renderDoc($subTmp, true);
                        break;
                    case '@TEMPLATE':
                        $tpl = $this->getTemplate($subTmp);
                        $tpl = $this->getTemplate(/** @scrutinizer ignore-type */ $subTmp);
                        break;
                    case '@CHUNK':
                        $tpl = $this->getBaseChunk($subTmp);
                        break;
                    default:
                        $tpl = $this->getBaseChunk($name);
                }
                $this->modx->chunkCache[$name] = $tpl;
            } else {
                $tpl = $this->getBaseChunk($name);
            }

            if($ext !== null) {

                $this->setTemplateExtension($ext);
            }
            return $tpl;
        }

        protected function getBaseChunk($name)
        {
            if (empty($name)) {
                return '';
            }

            if (isset ($this->modx->chunkCache[$name])) {

                $tpl = $this->modx->chunkCache[$name];
            } else {
                $table = $this->modx->getFullTableName('site_htmlsnippets');
                $query = $this->modx->db->query(
                    "SELECT `snippet` FROM " . $table . " WHERE `name`='" . $this->modx->db->escape($name) . "' AND `disabled`=0"
                );
                if ($this->modx->db->getRecordCount($query) == 1) {
                    $row = $this->modx->db->getRow($query);
                    $tpl = $row['snippet'];
                } else {
                    $tpl = '';
                }
            }

            return $tpl;
        }

        /**
         * Рендер документа с подстановкой плейсхолдеров и выполнением сниппетов
         *
         * @param int $id ID документа
         * @param bool $events Во время рендера документа стоит ли вызывать события OnLoadWebDocument и OnLoadDocumentObject (внутри метода getDocumentObject).
         * @param mixed $tpl Шаблон с которым необходимо отрендерить документ. Возможные значения:
         *                       null - Использовать шаблон который назначен документу
         *                       int(0-n) - Получить шаблон из базы данных с указанным ID и применить его к документу
         *                       string - Применить шаблон указанный в строке к документу
         * @return string
         *
         * Событие OnLoadWebDocument дополнительно передает параметры:
         *       - с источиком от куда произошел вызов события
         *       - оригинальный экземпляр класса DocumentParser
         */
        public function renderDoc($id, $events = false, $tpl = null)
        {
            $id = (int)$id;
            if ($id <= 0) {
                return '';
            }

            $m = clone $this->modx; //Чтобы была возможность вызывать события
            $m->documentIdentifier = $id;
            $m->documentObject = $m->getDocumentObject('id', (int)$id, $events ? 'prepareResponse' : null);
            $m->documentObject = $m->getDocumentObject('id', (int)$id, $events ? 'prepareResponse' : null);
            if ($m->documentObject['type'] == "reference") {
                if (is_numeric($m->documentObject['content']) && $m->documentObject['content'] > 0) {
                    $m->documentObject['content'] = $this->renderDoc($m->documentObject['content'], $events);
                }
            }
            switch (true) {
                case is_integer($tpl):
                    $tpl = $this->getTemplate($tpl);
                    break;
                case is_string($tpl):
                    break;
                case is_null($tpl):
                default:
                    $tpl = $this->getTemplate($m->documentObject['template']);
            }
            $m->documentContent = $tpl;

            if ($events) {
                $m->invokeEvent("OnLoadWebDocument", array(
                    invokeEvent("OnLoadWebDocument", array(
                    'source'   => 'DLTemplate',
                    'mainModx' => $this->modx,
                ));
            }

            return $this->parseDocumentSource($m->documentContent, $m);
        }

        /**
         * Получить содержимое шаблона с определенным номером
         * @param int $id Номер шаблона
         * @return string HTML код шаблона
         */
        public function getTemplate($id)
        {
            $tpl = null;
            $id = (int)$id;
            if ($id > 0) {
                $tpl = $this->modx->db->getValue("SELECT `content` FROM {$this->modx->getFullTableName("site_templates")} WHERE `id` = {$id}");
            }
            if (is_null($tpl)) {
                $tpl = '[*content*]';
            }

            return $tpl;
        }

        /**
         * refactor $modx->parseChunk();
         *
         * @param string $name Template: chunk name || @CODE: template || @FILE: file with template
         * @param array $data paceholder
         * @param bool $parseDocumentSource render html template via DocumentParser::parseDocumentSource()
         * @return string html template with data without placeholders
         */
        public function parseChunk($name, $data = array(), $parseDocumentSource = false, $disablePHx = false)

        {
            $out = $this->getChunk($name);
            $twig = strpos($name, '@T_') === 0 && $this->twigEnabled;
            $blade = strpos($name, '@B_') === 0 && $this->bladeEnabled;
            switch (true) {
                case $twig:
                    $out = $out->render($this->getTemplateData($data));
                    break;
                case $blade:
                    $out = $this->blade->make($out)->with($this->getTemplateData($data))->render();
                    break;
                case is_array($data) && ($out != ''):
                    if (preg_match("/\[\+[A-Z0-9\.\_\-]+\+\]/is", $out)) {
                        $item = $this->renameKeyArr($data, '[', ']', '+');
                        $out = str_replace(array_keys($item), array_values($item), $out);
                    }
                    if (!$disablePHx && preg_match("/:([^:=]+)(?:=`(.*?)`(?=:[^:=]+|$))?/is", $out)) {

                        if (is_null($this->phx) || !($this->phx instanceof DLphx)) {

                            $this->phx = $this->createPHx(0, 1000);
                        }
                        $this->phx->placeholders = array();
                        $this->setPHxPlaceholders($data);
                        $out = $this->phx->Parse($out);
                    }
                    break;
            }
            if ($parseDocumentSource && !$twig && !$blade) {

                $out = $this->parseDocumentSource($out);
            }

            return $out;
        }

        /**
         *
         * @param string|array $value
         * @param string $key
         * @param string $path
         */
        public function setPHxPlaceholders($value = '', $key = '', $path = '')

        {
            $keypath = !empty($path) ? $path . "." . $key : $key;

            $this->phx->curPass = 0;
            if (is_array($value)) {
                foreach ($value as $subkey => $subval) {
                    $this->setPHxPlaceholders($subval, $subkey, $keypath);
                }
            } else {
                $this->phx->setPHxVariable($keypath, $value);
            }
        }

        public function loadTwig() {
            if (is_null($this->twig) && isset($this->modx->twig)) {
                $this->twig = clone $this->modx->twig;
                $this->twigEnabled = true;
            }
        }

        public function loadBlade() {
            if (is_null($this->blade) && isset($this->modx->blade)) {
                $this->blade = clone $this->modx->blade;
                $this->bladeEnabled = true;
            }
        }

        /**
         *
         * @param string $string
         * @return string
         */
        public function cleanPHx($string)

        {
            preg_match_all('~\[(\+|\*|\()([^:\+\[\]]+)([^\[\]]*?)(\1|\))\]~s', $string, $matches);
            if ($matches[0]) {
                $string = str_replace($matches[0], '', $string);
            }

            return $string;
        }

        /**
         * @param int $debug
         * @param int $maxpass
         * @return DLphx
         */
        public function createPHx($debug = 0, $maxpass = 50)

        {
            if (!class_exists('DLphx')) {

                include_once(__DIR__ . '/DLphx.class.php');
            }

            return new DLphx($this->modx, $debug, $maxpass);
        }

        /**
         * Переменовывание элементов массива
         *
         * @param array $data массив с данными
         * @param string $prefix префикс ключей
         * @param string $suffix суффикс ключей
         * @param string $sep разделитель суффиксов, префиксов и ключей массива
         * @return array массив с переименованными ключами
         */
        public function renameKeyArr($data, $prefix = '', $suffix = '', $sep = '.')
        {
            return APIhelpers::renameKeyArr($data, $prefix, $suffix, $sep);
        }

        /**
         * @param $out
         * @param DocumentParser|null $modx
         * @return mixed|string
         */
        public function parseDocumentSource($out, $modx = null)
        {
            if (!is_object($modx)) {

                $modx = $this->modx;
            }
            $_minPasses = (int)$modx->minParserPasses;

            $minPasses = $_minPasses <= 0 ? 2 : $_minPasses;
            $_maxPasses = (int)$modx->maxParserPasses;

            $maxPasses = $_maxPasses <= 0 ? 10 : $_maxPasses;
            $modx->minParserPasses = $modx->maxParserPasses = 1;
            $site_status = $modx->getConfig('site_status');
            $modx->config['site_status'] = 0;
            for ($i = 1; $i <= $maxPasses; $i++) {
                $html = $out;
                if (preg_match('/\[\!(.*)\!\]/us', $out)) {
                    $out = str_replace(array('[!', '!]'), array('[[', ']]'), $out);
                }
                if ($i <= $minPasses || $out != $html) {
                    $out = $modx->parseDocumentSource($out);
                    $out = $modx->parseDocumentSource($out);
                } else {
                    break;
                }
            }
            $out = $modx->rewriteUrls($out);
            $out = $modx->rewriteUrls($out);
            $out = $this->cleanPHx($out);
            $modx->config['site_status'] = $site_status;
            $modx->minParserPasses = $_minPasses;
            $modx->maxParserPasses = $_maxPasses;
            
            return $out;
        }
    }
}

AgelxNash / DocLister

DLTemplate::setPHxPlaceholders() A last analyzed 2025-02-01 16:32 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

DLTemplate::setPHxPlaceholders() A
last analyzed 2025-02-01 16:32 UTC
