MODx

MODX - Ресурсы

Статья, в которой описывается понятие и роль такого объекта MODX Revolution как ресурс. Кроме этого разберёмся с тем, как осуществляется работа с ресурсами в MODX, узнаем назначение полей ресурса, а также то, как связанный с ресурсом шаблон влияет на его вывод.

Что такое ресурс?

Ресурс - это некоторая сущность, которая представляет страницу в MODX.

Всего в MODX насчитывается 4 различных типа ресурсов: документы (documents), ссылки (weblinks), символические ссылки (symlinks) и статические ресурсы (Static Resources). По умолчанию ресурс имеет тип "Документ".

Ресурс "Документ (document)"

Документ - это тип ресурса MODX, который представляет собой веб-страницу на сайте.

 

Ресурс "Символическая ссылка (symlink)"

Символическая ссылка в MODX Revolution - это ресурс, с помощью которого можно отобразить контент другого ресурса сайта под определённым URL.

Символическая ссылка не позволяет изменить "привязанный" к ней контент, но зато позволяет настроить иные параметры ресурса, например, такие как шаблон, название и др.

Символическую ссылку обычно используют:

• как вид редиректа 301;
• для того, чтобы избежать дублирования контента. Т.е. ресурс (контент), имеющий тип "Документ", можно создать один раз, а затем при необходимости использовать символическую ссылку на него. Это может применяться, когда необходимо обеспечить чтобы один и тот же контент находился фактически и логически более чем в одном месте на сайте;
• когда необходимо оставить доступ к документу, который был перемещён в структуре сайта, по старой ссылке;
• для обеспечения простого и краткого URL-адреса для документа, который находится глубоко в структуре сайта;
• для того чтобы реализовать обращение к некоторому ресурсу (контенту), используя различные написания. Например: foursquare, 4square, forsquare и т.п. Каждый из этих ресурсов будет представлять собой символическую ссылку, указывающую на один и тот же контент.

 

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

При работе с символическими ссылками убедитесь в том, что ресурс, с которого она берёт контент, существует и опубликован. Если это не так, то при обращении к ресурсу (символической ссылки) будет создана ошибка.

Ресурс "Ссылка (Weblink)"

Weblink - это ресурс, представляющий собой ссылку. Шаблон для отображения или форматирования этого ресурса (ссылки) обычно не используется. Его применение может быть обусловлено только в том случае, если он будет использоваться как контейнер для переменных шаблона (TV-параметров), которые необходимо добавить к ссылке. Weblink можно использовать на сайте, например, в качестве ссылки, которая должна стать частью сгенерированного меню.

Контент веб-ссылки представляет собой URL-адрес. MODX при открытии такого ресурса просто перенаправляет пользователя на указанный адрес URL. Даже парсер такой тип ресурса не разбирает. Т.е. как только MODX видит, что это "ссылка", он просто использует контент этого ресурса в качестве аргумента метода sendRedirect($url).

В качестве ссылки можно использовать как внешний URL-адрес, так и id существующего ресурса сайта.

 

Статический ресурс (Static Resource)

Статический ресурс - это абстрактный ресурс, представляющий собой некоторый файл. Он предназначен для виртуального представления некоторого файла веб-сервера. Как и другие MODX ресурсы, эта абстракция может иметь права. Данный тип ресурса, также как и другие, отображается в админке (менеджере) MODX на левой панели в дереве ресурсов. Это позволяет использовать его в динамических меню и результатах поиска.

В поле контента статического ресурса для указания пути к файлу можно использовать теги (параметры системы). Кроме системных тегов в поле контента можно также использовать сниппеты. Это в основном используется только тогда, когда необходимо установить динамический путь к файлу.

Статические ресурсы в MODX Revolution ведут себя подобно документу (стандартному ресурсу). Но для представления файла в статическом ресурсе, ему обязательно необходимо установить соответствующее содержимое (content_type), а также способ того, как браузер должен обработать этот ресурс (content_dispo). Для того чтобы ресурс отображался в браузере, выберите в качестве значения поля "Местонахождение ресурса" вариант "Встроенный". Для того чтобы ресурс стал доступен для скачивания выберите параметр "Прикреплённый".

Обратите внимание на то, что при создании статического ресурса, псевдоним alias не должен содержать расширение файла. Расширение файла определяется типом контента ресурса.

Для того чтобы файл передавался правильно через статический ресурс, ему необходимо в качестве шаблона указывать пустой шаблон. Если к статическому ресурсу необходимо добавить некоторую дополнительную информацию через переменные шаблона (TV-параметры). То в этом случае необходимо создать новый "пустой" шаблон и установить в качестве его содержания следующее:

[[*content]]

 

 

Идентификатор ресурса

Каждый ресурс в MODX имеет уникальный идентификатор (id). Он позволяет системе MODX определить, какой ресурс необходимо выбрать, когда пользователь загружает в браузере ту или иную веб-страницу. Его также желательно использовать, когда необходимо организовать связь между ресурсами. В этом случае MODX будет генерировать ссылку автоматически, и её не придётся редактировать при изменении псевдонима (alias), типа контента или какого-нибудь другого поля ресурса.

Рассмотрим небольшой пример, а именно то, как MODX определяет какой ресурс необходимо отдать пользователю при открытии им некоторой страницы на сайте (www.mysite.ru).

Если на сайте не используются дружественные URL, то ресурс, который необходимо отобразить пользователю указывается посредством идентификатора в get параметре id страницы "index.php".

Например, отобразить в браузере страницу (ресурс) сайта, имеющий идентификатор 19:

http://www.mysite.ru/index.php?id=19

Если же на сайте включены и настроены дружественные URL, то обращение к ресурсу уже будет осуществляться с использованием псевдонима. Например, отобразить ресурс с идентификатором 19, имеющий псевдоним some-page и тип содержимого "html" (суффикс, равен .html):

http://www.mysite.ru/some-page.html

Здесь some-page - это alias ресурса, а .html - это тип содержимого (контента) данного ресурса.

Кроме этого, MODX разрешает использовать вложенные URL. Например, ресурс с псевдонимом "child", который расположен внутри ресурса-контейнера с псевдонимом "parent", будет иметь адрес:

http://www.mysite.ru/parent/child.html

Работа с ресурсами в MODX

Ресурсы в админке (менеджере) MODX отображаются в левой панели на вкладке "Ресурсы". Представляются они пользователю в виде дерева.

 

Создание ресурса

Жмите Система->Типы содержимого. Вам будет представлена таблицу заполненная текущими видами содержимого. Жмите новый тип содержимого и в новом окошке увидите такие строки:

Жмите сохранить и в перечне будет представлен новый тип содержимого. 

В тот момент вы создаете ресурс, то расширение файла, характеризуемое типом содержимого, которое вы избрали, будет прибавляться к псевдониму ресурса (В случае если вы включили дружественный URL)

Редактирование ресурса

Отредактировать ресурс в админке MODX можно несколькими способами:

• с помощью нажатия левой кнопкой мыши на необходимый ресурс в дереве;
• посредством поднесения курсора к определённому ресурсу и выбором из контекстного меню пункта "Редактировать". Вызывается контекстное меню с помощью правой кнопки мыши.

 

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

Удаление ресурса

Для удаления ресурса в MODX Revolution к нему необходимо поднести курсор и в контекстном меню выбрать пункт "Удалить". Кроме этого удалить ресурс можно также в режиме редактирования с помощью кнопки "Удалить". После удаления, ресурс на самом деле не удаляется. Ему просто устанавливается включенным состояние параметра deleted, т.е. ресурс как бы помечается на удаление. Для того чтобы окончательно стереть ресурс или ресурсы, помеченные на удаление, необходимо на вкладке "Ресурсы" нажать на значок мусорного ведра.

Поля ресурса

Все ресурсы имеют следующие предопределенные поля:

 Базовые поля ресурса MODX.

Имя	Описание
id	Идентификатор (порядковый номер) ресурса.
template	Ссылка на шаблон, который будет использоваться для отображения этого ресурса.
published	Включает публикацию ресурса во front-end.
pagetitle	Заголовок (название) ресурса.
longtitle	Расширенный заголовок ресурса.
description	Описание ресурса.
introtext	Краткая информация о содержимом ресурса. Может использоваться для его представления на главной странице или в некотором разделе.
alias	URL-псевдоним по которому можно обратиться к этому ресурсу. Предназначен для сайтов, которые используют дружественные URL. Например, ресурс с псевдонимом "home" и типом контента "html" будет иметь URL "home.html" (если конечно же он не контейнер).
parent	идентификатор (id) родительского ресурса.
link_attributes	Предназначен для указания атрибутов, которые необходимо добавить к ссылке. Обычно используется сниппетом, генерирующим меню.
menutitle	Заголовок, который может использоваться сниппетами для представления ресурса в меню.
menuindex	Порядковый номер индекса ресурса в меню. Более высокие значения индекса указывают на то, что ссылку на ресурс необходимо расположить ниже.
hidemenu	Убирает ресурс из выборки при формировании меню. Обычно используется сниппетами, генерирующими меню.
content	Контент ресурса.

 Поля, осуществляющие настройку ресурса.

Имя	Описание
isfolder	Указывает, является ли ресурс "Контейнером". Если это так, то ресурс будет вместо суффикса иметь слеш (/). Это касается только тех сайтов, которые используют дружественные URL.
searchable	Определяет, необходимо ли ресурс включать в результаты поиска.
cacheable	Определяет, необходимо ли ресурс кешировать.
createdby	Содержит идентификатор (id) пользователя, который создал ресурс.
editedby	Содержит идентификатор (id) пользователя, который последним редактировал этот ресурс.
deleted	Определяет, отмечен ли ресурс на удаление или нет.
deletedby	Содержит идентификатор (id) пользователя, который отметил ресурс на удаление.
publishedby	Содержит идентификатор (id) пользователя, который опубликовал ресурс.
createdon	Содержит дату создания ресурса пользователем.
publishedon	Содержит дату публикации ресурса.
editedon	Содержит дату последнего редактирования документа.
pub_date	Содержит дату, начиная с которой ресурс будет опубликован.
unpub_date	Содержит дату, начиная с которой ресурс будет снят с публикации.

Где хранятся ресурсы

Ресурсы, как и другие объекты MODX хранятся в базе данных.

Ресурс и связанный с ним шаблон

Каждому ресурсу в MODX Revolution должен быть обязательно назначен имеющийся или пустой шаблон. Определиться, нужен ли ресурсу шаблон или нет можно следующим образом. Шаблон имеет смысл создавать, если его необходимо связать с несколькими ресурсами или использовать TV-переменные. В этом случае страница будет выводиться, используя связанный с ней шаблон. Контент ресурса в этом шаблоне будет представляться с помощью тега MODX [[*content]].

Если страница не имеет связанного с ней шаблона (выбран пустой шаблон), то она будет отображаться на основании поля "Содержимое ресурса".

На этом все.