Правильный Ajax в ModX Revo!

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

• через коннектор Modx;
• через снипет при обращении к ресурсу на сайте;
• запросы к Modx фреймовику;

 

Ajax через коннектор Modx

Пример jQuery скрипта - запроса к Modx коннектору:

$.ajax({ url: 'assets/components/chats/connectors/connectortochat.php?action=web/gotochat&ctx=web', global: false, beforeSend:function(){ }, data:{ctx:'web',to:uid}, success:function(data){ location.href='/tet-a-tet/'; } });

Коннектор - это скрипт, содержащий код для проверки прав при выполнении запросов к администраторскому разделу, но его можно переделать для запросов к сайту:

<?php /** * Doodles Connector * * @package doodles */ require_once dirname(dirname(dirname(dirname(dirname(__FILE__))))).'/config.core.php'; require_once MODX_CORE_PATH.'config/'.MODX_CONFIG_KEY.'.inc.php'; require_once MODX_CONNECTORS_PATH.'index.php'; $corePath = $modx->getOption('chats.core_path',null,$modx->getOption('core_path').'components/chats/'); require_once $corePath.'model/chats/chats.class.php'; $modx->chats = new Chats($modx); $modx->lexicon->load('chats:default'); if ($_REQUEST['action'] == 'web/gotochat') { $version = $modx->getVersionData(); if (version_compare($version['full_version'],'2.1.1-pl') >= 0) { if ($modx->user->hasSessionContext($modx->context->get('key'))) { $_SERVER['HTTP_MODAUTH'] = $_SESSION["modx.{$modx->context->get('key')}.user.token"]; } else { $_SESSION["modx.{$modx->context->get('key')}.user.token"] = 0; $_SERVER['HTTP_MODAUTH'] = 0; } } else { $_SERVER['HTTP_MODAUTH'] = $modx->site_id; } $_REQUEST['HTTP_MODAUTH'] = $_SERVER['HTTP_MODAUTH']; } /* handle request */ $path = $modx->getOption('processorsPath',$modx->chats->config,$corePath.'processors/'); $modx->request->handleRequest(array( 'processors_path' => $path, 'location' => '', ));

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

require_once $corePath.'model/chats/chats.class.php'; $modx->chats = new Chats($modx);

после подключения класса - контроллёра, все запросы по типу "контекс/контроллёр" будут обработаны контроллёром, например "web/getchat" будет находится в директории "/core/ваш компонент/processors/web/getchat.php". Для обработки обязательно необходим следующий код:

/* handle request */ $path = $modx->getOption('processorsPath',$modx->chats->config,$corePath.'processors/'); $modx->request->handleRequest(array( 'processors_path' => $path, 'location' => '', ));

После этого контроллёр может служить хорошим средством для взаимодействия с вашим ajax скриптом.

Ajax через сниппет

Второй способ считается правильнее по словам разработчиков Modx Revo:

Создайте любой сниппет:

напишите код для сниппета, он просто выводит json:

return json_encode(array("1","2"));

после этого создайте ресурс с именем Ajax:

после этого создайте новый тип содержимого json:

сейчас, когда у Вас есть новый тип к нему можно делать запросы: 

<script> $(document).ready(function () { $.getJSON("http://{сайт}/ajax.json"); }); </script>

будьте внимательны в содержимом ресурса не должно быть тегов для формата json:

Ещё способ делать ajax запросы к Modx

Запросы можно делать ещё одним способом кторый для меня более удобен, чем предыдущие - запросы на прямую к Modx фреймовику.

Для этого кладём в корневой каталог сайта файл следующего содержимого:

<?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'); $modx->runsnippet('SimpleSearch'); echo '<?xml version=\'1.0\' encoding=\'utf-8\' ?><ul> <li><a href="http://rathersplendid.net/home/site-launch-soho-fixed">Site Launch: Soho Fixed</a></li> </ul>'; ?>

После этого все запросы к этому файлу будут выполнятся с использованием Modx Revo. В нашем примере мы выводим поле для поиска через сниппет "SimpleSearch".

Рассмотрите дополнительный пример подключения Modx Revo, с выводом содержимого статьи через ajax запрос!

<?php $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'); ?>

Удачи и успехов!