x
  • Документация для редакторов
  • banner1.png

Глоссарий/терминология concrete5

Документация concrete5 базируется на внутренних соглашениях разработчиков системы, изучив которые, cms станет более понятна в равной степени и для программистов, и для конечных пользователей.

В общем случае: каждая Страница в concrete5 имеет редактируемые области, определяемые типом страницы. Области содержат блоки (определяемые типом блока), в основе которых лежат модули (группа файлов, призванная обрабатывать данные и выводить их в указанной области на сайте), которые могут быть и редактируемым HTML кодом и настраиваемым опросом. Каждая страница имеет свои права доступа и свой шаблон оформления. Шаблоны содержат файлы, определяющие внешний вид конкретного типа страниц

Общие понятия

Страницы

Страница в cms concrete5 представляет собой точно такую же страницу, какую вы видите на любом вебсайте: она так же отображается в окне браузера и расположена по уникальному адресу URL. Адрес страницы в concrete5 может быть в виде дружественного URL или в виде стандартного URL. Например, следующие URL ведут к одинаковым страницам:

http://www.concrete5russia.ru//прочитать/docs/dev-concrete5/notes/what-is-concrete5/ http://www.concrete5russia.ru/index.php?cID=297

Каждая страница имеет уникальный идентификатор cID (“c” означает Коллекция “collection” - см. ниже) и список метаданных о странице.

Существуют некоторые исключения, когда говорят об идентичности “СтраницаКоллекция”. Стандартные страницы, например, страница авторизации и регистрации является “Статической страницей” и она расположена в конкретной директории в файловой системе Concrete5. Однако, к такой странице тоже можно применить шаблоны оформления. Читайте ниже о таких страницах для более точного понимания исключений.

Области

Области в concrete5 - это определенные части страницы, которые могут быть отредактированы средствами системы управления контентом. Без этих областей страница была бы полностью не изменяемой. Каждая область может иметь свои права доступа - это позволяет добавлять только определенные типы блоков и/или разрешать только определенным пользователям видеть конкретную область.

Модули

Модулем называют дополнительный компонент для cms, представляющий собой группу файлов, связанных между собой на основе архитектуры MVC для ввода определенных данных, их обработки и вывода на странице. После загрузки модулей на сайт через ftp или через магазин дополнений их можно установить в разделе Панель управления > Дополнения (до версии 5.5, а с версии 5.5 в разделе Панель управления > Расширьте concrete5 ), а затем добавить на сайте из режима редактирования. Существуют так же специальный модули, которые не используются для вывода какой-либо информации на страницах сайта, а используются в служебных целях, например, для управления базой данных MySQL  сайта прямо из панели управления.

Блоки

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

Типы блоков

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

Типы блоков включают:

  • HTML контент;
  • Галерею изображений на странице;
  • Навигацию;
  • Список страниц на сайте;
  • Опрос или голосование.

Все это типы блоков. После установки модуля какого-либо типа в cms, администратор (или другой пользователь с соответствующими правами) может добавить его в редактируемую область страницы. При добавлении опроса на страницу, например, опрос одновременно будет являться и модулем и типом блока и блоком. Блоки являются самостоятельными компонентами и нейтрально относятся ко всем другим элементами на странице. Каждый тип блока имеет собственный уровень представления данных: отдельную форму при добавлении модуля, отдельную форму при редактировании модуля. Эти формы представления обычно отображаются во всплывающих диалоговых окнах интерфейса Concrete5. Разработчики, заинтересованные в написании своего собственного модуля могут обратиться к разделу - создание модуля.

Типы страницы

Подобно типам модулей, в concrete5 так же существует понятие “тип страницы”. Тип страницы представляет собой своего рода “каркас” для оформления и правила, по которым на странице размещаются разные области для вставки и редактирования блоков concrete5. Типы страниц обычно именуются в зависимости от функционального назначения. Например, попробуем перечислить возможные типы страниц обычного корпоративного сайта:

  • Home - тип страницы, относящийся к главной странице сайта;
  • Product - тип страницы, который может использоваться  для описания товара;
  • Article - тип страницы, где может отображаться полный текст какой-нибудь статьи;
  • Left sidebar - тип страницы с левой панелью, в которой может разместиться навигация по страницам, информация о курсах валют, погоде и т.п.
  • Default - тип страницы по умолчанию, используемый для всех остальных страниц.

Типы страниц обычно создаются для многократно используемых страниц (Home является, пожалуй, единственным исключением из правил). О страницах однократного применения описано ниже в разделе “Статические страницы”.

Шаблоны

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

Атрибуты страницы и пользователя

Так как все страницы и пользователи имеют привязанные к себе части информации, cms concrete5 позволяет администраторам создавать свои собственные частицы данных и добавлять их к страницам или аккаунтам пользователей. Эти частицы информации в concrete именуются “атрибутами”. Пример атрибутов страницы:

  • Исключить из навигации (флажок)
  • Ключевые слова - Meta Keywords (текст)
  • Дополнительное содержимое в заголовках (текст)

Пример атрибутов пользователя:

  • Пол (выпадающий список с возможностью выбора М или Ж)
  • Адрес (текст)

Пользователи

Пользователи - это учетные записи (аккаунты),  создаваемые для возможности редактирования сайта. По своей сути, запись пользователя в concrete5 состоит лишь из ID, уникального имени пользователя(логина) и e-mail адреса. Атрибуты пользователя можно расширить добавив их в панели управления.

Группы

Создание групп - это самый простой способ объединить пользователей по семантическим признакам. Группы создаются, главным образом, для того, чтобы определенную часть пользователей наделить нужными правами: каждой конкретной группе можно разрешить чтение, редактирование, удаление информации на страницах, а так же возможность администрировать определенные страницы, области или даже отдельные блоки.

Терминология разработчиков

Если Вы заинтересованы в разработках для concrete5, то Вам наверняка понадобятся следующие понятия в дополнении ко всему вышесказанному:

Коллекции

В cms concrete до 5-ой версии, Коллекции относили ко всей странице в целом (см выше). Коллекции получили своё название из-за того, что они являлись как бы “колекцией” или “скоплением” блоков. Однако, коллекция может существовать и без записей в базе данных в таблице “Pages”, тем самым группировать блоки вместе без представления в карте сайта. Кроме того, эти коллекции можно назвать программными, которые могут быть полезны для программистов, желающих использовать мощь и гибкость встроенных блоков на программном уровне, не беспокоясь о месте расположения страницы, правах доступа и т.п.

Статические страницы

Статическая страница - это страница, не имеющая определенного типа, но при этом обращающаяся напрямую к определенному файлу в файловой системе. И в этом есть свои преимущества, так как подобные страницы могут быть добавлены вручную в соответствующую директорию и после установки в Панели управления они будут доступны по одному единственному адресу, например, http://www.somesite.ru/name-page. В большинстве случаев это хорошая практика - использовать статические страницы, когда какую-то определенную страницу не нужно будет постоянно изменять и весь контент для неё заполняется лишь однажды. При установке concrete создается множество стандартных статических страниц, среди которых:

  • Страница авторизации;
  • Страница регистрации;
  • Различные страницы панели управления;

Для статических страниц применяется архитектура модель-представление-контроллер, что делает их особенно полезными при использовании с5 в качестве платформы приложения.

Ключи атрибута

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

Категории атрибута

Каждый ключ атрибута имеет свою категорию. Категория атрибута - это связанный с ключом объект. Встроенные атрибуты страницы, как например “Мета заголовок”, или “Исключить из навигации” имеют категорию атрибута - “страница”. Атрибуты, как например ширина и высота относятся к категории “файл”. Каждая категория ключа атрибута является объектом, расширяющим объект AttributeCategory. Чтобы использовать встроенные атрибуты для своих собственных объектов необходимо разобраться в функционировании объекта категории атрибута.

Типы атрибутов

И, наконец, каждый ключ атрибута должен иметь определенный тип. Объект AttributeType определяет способ хранения и представления данных в ключе атрибута. Тип атрибута включает такие объекты, как “Рейтинг”, “Текст”, “Число” и др. Если Вы хотите расширить систему атрибутов для хранения новых типов данных или настройки существующих атрибутов необходимо разобраться на программном уровне в функционировании объекта AttributeType.

Система Orphus