Опубликовано admin - пн, 05/28/2018 - 18:45

Давно не писал что-нибудь заумное, чтоб после прочтения у Вас голова заболела, поэтому решил написать! Может будет трудно осилить, но Вы приблизитесь к опытному уровню разработок в modx. В этой статье я не буду разжевывать всё в подробностях, но она будет очень большая, охватывающая многие аспекты программирования в среде для разработки modx, поэтому Вам придётся набраться терпения, но это будет того стоить, так как некоторые решения Вы не найдётё в интернете.

Что Вы будете уметь после прочтения?

Во-первых работа с внешними скриптами с использованием API MODX;
Не обойдется без решения таких вопросов как получения сессий, залогиных пользователей;
Особое внимание я уделю выводу ресурсов(документы расположенные в админ. панели) с помощью jQuery;
В конце всего вы найдёте мини-примеры, которые наиболее востребованы в моей практике.
На последок я сделал Вам сюрприз, - мы встроим интересную jQuery каптчу в скрипт модуля регистрации MODX.

Итак, - поехали!

То что я буду Вам пытаться сейчас объяснить вызовет у Вас головную боль, но поверьте эта боль - меньшее зло, по сравнению с той, которая бы у Вас проявилась, если бы Вы вручную - методом проб, всё бы это пытались создать. Для начала давайте вспомним, что отменили в последней версии MODx - 2.1.

Список отменённых методов в MODx 2.1!

getSettings()
getDocumentObject()
getLoginUserType()
getDocument()
getDocuments()
getUserDocGroups()
getFullTableName()
getAllChildren()
getActiveChildren()
getDocumentChildren()
getDocumentChildrenTVars()
getTemplateVar()
getTemplateVars()
getTemplateVarOutput()
getParent()
getPageInfo()
getUserInfo()
getWebUserInfo()
getDocGroups()
changeWebUserPassword()
changePassword()
cleanDocumentIdentifier()
getDocumentIdentifier()
getDocumentMethod()
checkPreview()
logEvent()
getManagerPath()
userLoggedIn()
mergeDocumentContent()
mergeSettingsContent()
mergeChunkContent()
mergePlaceholderContent()
isBackend()
isFrontend()
insideManager()
putChunk()

Правильно выводим статьи в MODX REVOLUTION!

Часто разработчику необходимо получать данные не прибегая к перезагрузке страницы, то есть через ajax. Так как с системами управления это достаточно сложно реализовать начинающим пользователям и разработчикам этих систем, поэтому мы начнём с правильного подключения MODx API во внешних скриптах.

Для начала нужно определится с подключением к MODX API. Данный код нужен для защиты.

if (!defined('MODX_API_MODE')) { define('MODX_API_MODE', false); }

Далее следует указать стоит ли кэшировать данные MODX, - по умолчанию данные кэшируются, что мы собственно и видим.

$modx_cache_disabled= false;

После этого нам нужно подключить основной класс для работы с API MODX и конфигурационный файл:

config.core.php
modx.class.php

/* подключаем настройки и определим базовый путь для MODX*/ @include('config.core.php'); if (!defined('MODX_CORE_PATH')) define('MODX_CORE_PATH', $_SEVER['DOCUMENT_ROOT'].'/core/'); /* подключаем класс modX */ if (!@include_once (MODX_CORE_PATH . "model/modx/modx.class.php")) { $errorMessage = 'Site temporarily unavailable'; @include(MODX_CORE_PATH . 'error/unavailable.include.php'); header('HTTP/1.1 503 Service Unavailable'); echo "<html><title>Error 503: Site temporarily unavailable</title><body><h1>Error 503</h1><p>{$errorMessage}</p></body></html>"; exit(); } /* вывод данных из буфера */ ob_start(); /* Создаём экземпляр класса modX */ if (empty($options) || !is_array($options)) $options = array(); $modx= new modX('', $options); if (!is_object($modx) || !($modx instanceof modX)) { @ob_end_flush(); $errorMessage = '<a href="setup/">MODx not installed. Install now?</a>'; @include(MODX_CORE_PATH . 'error/unavailable.include.php'); header('HTTP/1.1 503 Service Unavailable'); echo "<html><title>Error 503: Site temporarily unavailable</title><body><h1>Error 503</h1><p>{$errorMessage}</p></body></html>"; exit(); }

В моих скриптах я использую заголовок для указания правильной кодировки. Правильнее этот заголовок разместить выше предыдущих скрипов, но в связи с тем что мои скрипы, как правило, не выводят ошибок до этого заголовка, то и сообщение о его неправильно размещении Вы так же не должны получить.

header('Content-Type: text/html; charset=utf-8');

Я советую использовать нижеуказанный код для записи всех действий в журнал MODX.

$modx->setLogLevel(modX::LOG_LEVEL_ERROR); $modx->setLogTarget('FILE');

Задайте уровень обработки ошибок.

$modx->setDebug(E_ALL & ~E_NOTICE);

Здесь нужно быть по внимательнее, выбрав правильный контекст, изначально он такой. Если Вам нужен другой контекст, - измените соответственно строку 'web'.

$modx->initialize('web');

Сейчас мы подобрались к основному выводу содержимого статей вашего сайта. В следующем листинге мы получаем объект - ресурс с "ID" равным 3. Если у Вас пока одна страница "HOME", то Вам необходимо изменить его на 1, иначе ничего не будет выведено. Сейчас я не буду объяснять подробное назначения массива, но заранее отмечу что в MODX можно выбирать статьи одновременно по нескольким параметрам, а так же несколько ресурсов в одни массив, но пока давайте выведем содержимое одной статьи по её ID.

$holder = $modx->getObject('modResource',array('id' => 3));

Теперь, когда у нас есть объект, мы можем получить его данные, давайте получим содержимое статьи.

echo $holder->get('content');

Рабочий вариант полностью.

<?php /* * MODx Revolution * * Copyright 2006-2010 by the MODx Team. * All rights reserved. * * This program is free software; you can redistribute it and/or modify it under * the terms of the GNU General Public License as published by the Free Software * Foundation; either version 2 of the License, or (at your option) any later * version. * * This program is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more * details. * * You should have received a copy of the GNU General Public License along with * this program; if not, write to the Free Software Foundation, Inc., 59 Temple * Place, Suite 330, Boston, MA 02111-1307 USA * */ $mtime= microtime(); $mtime= explode(" ", $mtime); $mtime= $mtime[1] + $mtime[0]; $tstart= $mtime; error_reporting(E_ALL & ~E_NOTICE); /** * @deprecated 2.0.0 * For backward compatibility with MODx 0.9.x */ define("IN_PARSER_MODE", "true"); /** * @deprecated 2.0.0 * For backward compatibility with MODx 0.9.x */ define("IN_MANAGER_MODE", false); /* define this as true in another entry file, then include this file to simply access the API * without executing the MODx request handler */ if (!defined('MODX_API_MODE')) { define('MODX_API_MODE', false); } /* this can be used to disable caching in MODx absolutely */ $modx_cache_disabled= false; /* include custom core config and define core path */ @include('config.core.php'); if (!defined('MODX_CORE_PATH')) define('MODX_CORE_PATH', $_SEVER['DOCUMENT_ROOT'].'/core/'); /* include the modX class */ if (!@include_once (MODX_CORE_PATH . "model/modx/modx.class.php")) { $errorMessage = 'Site temporarily unavailable'; @include(MODX_CORE_PATH . 'error/unavailable.include.php'); header('HTTP/1.1 503 Service Unavailable'); echo "<html><title>Error 503: Site temporarily unavailable</title><body><h1>Error 503</h1><p>{$errorMessage}</p></body></html>"; exit(); } /* start output buffering */ ob_start(); /* Create an instance of the modX class */ if (empty($options) || !is_array($options)) $options = array(); $modx= new modX('', $options); if (!is_object($modx) || !($modx instanceof modX)) { @ob_end_flush(); $errorMessage = '<a href="setup/">MODx not installed. Install now?</a>'; @include(MODX_CORE_PATH . 'error/unavailable.include.php'); header('HTTP/1.1 503 Service Unavailable'); echo "<html><title>Error 503: Site temporarily unavailable</title><body><h1>Error 503</h1><p>{$errorMessage}</p></body></html>"; exit(); } header('Content-Type: text/html; charset=utf-8'); /* Set the actual start time */ $modx->startTime= $tstart; /* Set additional logging options including level and target: */ $modx->setLogLevel(modX::LOG_LEVEL_ERROR); $modx->setLogTarget('FILE'); /* Set debugging mode (i.e. error_reporting): */ $modx->setDebug(E_ALL & ~E_NOTICE); /* Initialize the default 'web' context */ $modx->initialize('web'); //выбираем ресурсы по заданному условию $holder = $modx->getObject('modResource',array('id' => 3)); echo $holder->get('content'); ?>

Если нужно вывести одновременно несколько статей, например, зная их название и краткое описание, то нужно использовать метод getCollection и заменить всё в предыдущем листинге начиная с 93 строки следующим кодом:

$documents = $modx->getCollection('modResource',array( 'id' => 1, 'id' => 2, 'id' => 3 )); if (!empty($documents)) { foreach ($documents as $document) { $content = $document->get('content'); if (!empty($content)) { $modx->resource =& $document; // get the max iterations tags are processed before processing is terminated $maxIterations= (integer) $modx->getOption('parser_max_iterations', null, 10); // parse all cacheable tags first $modx->getParser()->processElementTags('', $content, true, false, '[[', ']]', array(), $maxIterations); // parse all non-cacheable and remove unprocessed tags $modx->getParser()->processElementTags('', $content, true, true, '[[', ']]', array(), $maxIterations); echo $content. '< br/>'; } } }

В итоге будут получены первые три статьи, при этом все переменные, TV будут распарены, а сниппеты выполнены - это основное отличие от предыдущего листинга, в котором содержимое выводится в том виде, в котором Вы его видите в админ. Панели, - при редактировании в редакторе(content).

Используя этот шаблон php скрипта плюс небольшое дополнение на jQuery, например $.load или $.post или $.ajax Вы сможете создавать динамичные ресурсы внутри системы MODX.

Учимся выводить данные о пользователе во внешние php скрипты в MODX REVOLUTION!

Как-то у меня возникла необходимость получать имя активного пользователя, для того чтобы заполнить его данным таблицу SQL, я выбрал следующее решение.

require_once 'manager/config.core.php'; require_once MODX_CORE_PATH.'config/'.MODX_CONFIG_KEY.'.inc.php'; require_once MODX_CORE_PATH.'model/modx/modx.class.php'; $modx = new modX(); $modx->initialize('web'); define('LOGINMODX',$modx->getLoginUserName()); ..... $query = 'SELECT * FROM modx_mail_papers WHERE chernovik = 1 AND username="'.LOGINMODX.'"'; ..... $result = $this->mMysqli->query($query) or die (mysqli_error($this->mMysqli)); .....

Другой раз у меня возникла необходимость отправки данных на email, который должен был быть указан пользователем и может постоянно изменяться. Для того, чтобы пользователю не "лазить" по скриптам, я решил создать сниппет в котором пользователь мог удобно изменить email на нужный. Для вызова сниппета мне пришлось использовать метод runsnippet. Поэтому может и Вам пригодится:

<?php require_once 'manager/config.core.php'; require_once MODX_CORE_PATH.'config/'.MODX_CONFIG_KEY.'.inc.php'; require_once MODX_CORE_PATH.'model/modx/modx.class.php'; $modx = new modX(); $modx->initialize('web'); define('PAPERSEMAIL', $modx->runsnippet('papersemail')); echo PAPERSEMAIL; ?>

Получаем данные об активном пользователе или странице через сниппет!

Получать данные об активном пользователе или странице внутри системы (НЕ ВО ВНЕШНЕМ СКРИПТЕ), через сниппет можно следующим образом:

<?php $currentResource = $modx->resource; $currentUser = $modx->user;

Получим текущий заголовок страницы(pagttitle), в сниппетах, - не забывайте вместо echo пишется return:

<?php $pagetitle = $modx->resource->get('pagetitle'); return $pagetitle;

Однажды столкнулся с ситуацией, когда в системе было несколько статей с одинаковыми заголовками, одни из которых были опубликованы, другие нет, для того чтобы вывести опубликованные использовал следующий код:

$document = $modx->getObject('modResource',array( 'published' => 1, 'pagetitle' => 'BMW' ));

Мини-примеры MODX API REVOLUTION!

Получаем системные настройки MODX:

$setting = $modx->getOption('site_start');

Получаем переменные шаблонов (TV):

$val = $modx->resource->getTVValue('имя TV'); $val = $modx->resource->getTVValue($id); // ID TV (не документа)

Так как не запрещено внутри TV использовать другие TV, то для того чтобы получить TV с уже распарсенным TV, нужно использовать следующий код:

/* Доступ к TV */ $tv = $modx->getObject('modTemplateVar',array('name'=>'MyTV')); /* получить TV без разбора*/ $rawValue = $tv->getValue($id); /* распарсить содержимое TV */ $processedValue = $tv->renderOutput($id);

Встраиваем содержимое ресурса, заголовок которого - "MyDocument", в чанк, тем самым все переменные внутри этого содержимого будут распарсены парсером MODX.

$resource = $modx->getObject('modResource',array('pagetitle'=>'MyDocument')); return $modx->getChunk('ShowResource',$resource->toArray());

Выполнить сниппет можно с указанием его настроек следующим образом:

$modx->runsnippet($snippetName, $props);

Для получения параметров сниппета, установленных по умолчанию используется следующий код:

$snippet = $modx->getObject('modSnippet',array('name'=>'SnippetName')); $properties = $snippet->getProperties();

Встраиваем каптчу «QapTcha»!

Я взял каптчу с сайта QapTcha. Для начала включите в шаблон, на странице которого будет размещаться форма регистрации js и css файлы, как указано ниже:

После вставляем сниппет регистрации, он доступен по умолчанию и включен в состав сниппета "Login".

[[!Register? &submitVar=`registerbtn` &activationResourceId=`5` &activationEmailTpl=`myActivationEmailTpl` &activationEmailSubject=`Спасибо за регистрацию!` &submittedResourceId=`1` ]] <script type="text/javascript"> $(function(){ $('#QapTcha').QapTcha({}); }); </script> ....... здесь форма с полями для регистрации нового пользователя .......

Следующий код нужно вставить в форму регистрации, - там где Вам нужно, обычно это перед кнопкой отправки формы. То есть данный код создаёт каптчу.

Далее заменить строку 69 сниппета "Register", находящийся в разделе сниппетов плагина "Login":

if (!empty($_POST) && (empty($submitVar) || !empty($_POST[$submitVar]))) {

if (!empty($_POST) && (empty($submitVar) || !empty($_POST[$submitVar])) && !empty($_SESSION['iQaptcha'])) {

В итоге на странице, где у Вас расположена форма будет находится красивая и простая каптча:

Для правильной работы каптчи нужен php, сохраняющий данные в сессию, который указан ниже:

<?php $aResponse['error'] = false; $_SESSION['iQaptcha'] = false; if(isset($_POST['action'])) { if(htmlentities($_POST['action'], ENT_QUOTES, 'UTF-8') == 'qaptcha') { $_SESSION['iQaptcha'] = true; if($_SESSION['iQaptcha']) echo json_encode($aResponse); else { $aResponse['error'] = true; echo json_encode($aResponse); } } else { $aResponse['error'] = true; echo json_encode($aResponse); } } else { $aResponse['error'] = true; echo json_encode($aResponse); }

Заключение

Теперь многое для Вас в Modx станет доступным. А если не совсем, - для этого есть комментарии или форум со специальным разделом "MODX REVOLUTION"!

Оценка

539 просмотров

Взаимосвязанные материалы

# 1. Самое необходимое при разработках в ModX Revolution! (понедельник, мая 28, 2018 - 18:45 ),

# 2. Правильный Ajax в ModX Revo! (вторник, ноября 27, 2012 - 20:43 ),

Ajax запросы в Modx Revo можно делать различными способами:

читать...

# 3. ModX Revo - Галерея ColorBox и её установка (суббота, ноября 12, 2011 - 21:08 ),

Установка галерей изображений в Modx Revo вызывает наибольшее затруднение у начинающих пользователей Modx. читать...

# 4. ModX Revo - Загрузка статьи из фронтенда в бакэнед (воскресенье, октября 30, 2011 - 18:34 ),

Пример загрузки статьи с сайта в админ панель Modx Revo. После загрузки пользователь будет перенаправлен на страницу с id "251". читать...

# 5. Что такое Wayfinder? (четверг, мая 5, 2011 - 21:24 ),
//