Содержание
Список иллюстраций
Список таблиц
Интерфейс администратора Cairo, с одной стороны, используется для решения повседневных задач управления контентом, а с другой - предоставляет разработчику визуальные инструменты для создания и редактирования структуры данных разрабатываемых ресурсов. Кроме того, интерфейс администратора позволяет управлять пользователями и группами пользователей, импортировать данные в систему.
Для работы с интерфейсом администратора Вам понадобится веб-браузер и доступ к серверу, на котором установлена система Cairo. Установка дополнительного ПО на клиентской машине не требуется.
Интерфейс администратора Cairo поддерживается основными браузерами, работающими на различных операционных системах.
Для работы с интерфейсом администратора необходим один из следующих браузеров:
Microsoft Internet Explorer, версия не младше 5.0;
Mozilla Firefox, версия не младше 1.5;
Mozilla, версия не младше 1.0;
Opera, версия не младше 7.0;
Konqueror, версия не младше 3.2.
В настройках браузера должна быть включена поддержка Cookie и JavaScript.
При работе с Internet Explorer адрес интерфейса администратора следует добавить в надежные узлы, что позволит использовать функцию предварительного просмотра изображений, добавляемых с локального компьютера.
Тип поля "Форматированный текст" является одним из встроенных типов полей Cairo. Значениями полей такого типа является текст, отформатированный при помощи тэгов HTML. По умолчанию в интерфейсе администратора для ввода и редактирования полей типа "Форматированный текст" используется простое поле ввода текста. В таком случае HTML-тэги необходимо указывать явным образом.
Существует множество WYSIWYG-редакторов, которые работают через веб-браузер и предоставляют пользователю визуальные средства для форматирования текста при помощи HTML. Функциональность таких редакторов во многом схожа с функциональностью текстовых процессоров
Аббревиатура WYSIWYG расшифровывается как "What You See Is What You Get" (в буквальном переводе означает: "Что видишь - то и получаешь"). WYSIWYG HTML-редактор предоставляет визуальные средства для работы с HTML-кодом.
Интерфейс администратора Cairo поставляется без WYSIWYG HTML-редактора. Однако, система предусматривает подключение редакторов сторонних поставщиков. В документе "Система управления контентом Cairo: Установка и настройка" подробно описано подключение WYSIWYG HTML-редактора на примере популярного редактора FCKEditor.
В большинстве случаев комфортная работа с WYSIWYG HTML-редактором напрямую зависит от аппаратного обеспечения клиентского компьютера. Подобные редакторы, будучи реализованными с использованием технологий ActiveX или Java, зачастую предъявляют повышенные требования к оборудованию.
WYSIWYG-редактор имеет собственные требования к веб-браузеру. Данные требования не должны противоречить системным требованиям интерфейса администратора Cairo.
Для начала работы с системой в адресной строке браузера введите URL, по которому доступен интерфейс администратора Cairo.
По умолчанию доступ к интерфейсу администратора Cairo имеет только пользователь root. Чтобы другие пользователи получили возможность работать с интерфейсом администратора, необходимо прописать идентификаторы этих пользователей или идентификаторы групп, к которым данные пользователи относятся, в файле настроек login.ini. Подробную информацию о соответствующих настройках можно получить в документе "Система управления контентом Cairo: Файлы конфигурации".
Работа с системой начинается со страницы авторизации. В форме авторизации необходимо ввести имя пользователя и пароль. Интерфейс администратора может быть настроен на работу с несколькими ресурсами данных, поэтому в форме авторизации предлагается выбрать ресурс данных. Выбор автоматически сохраняется, и при следующей загрузке данной страницы в выпадающем списке "Ресурс" по умолчанию будет установлено значение, которое было указано при последней авторизации, выполненной с данного компьютера.
Начальная страница интерфейса администратора содержит данные о времени последней авторизации пользователя, а также информацию об IP-адресе, с которого была выполнена последняя и текущая авторизация.
Интерфейс администратора состоит из пяти разделов:
Управление данными;
Управление справочниками;
Управление структурой данных;
Импорт данных;
Управление пользователями и группами.
При входе в систему активным по умолчанию является раздел «Управление данными»: подменю данного раздела отображается в развернутом виде.
Число доступных в меню разделов зависит от набора установленных модулей. Кроме того, авторизированный пользователь может не иметь доступа к некоторым разделам. Так, нецелесообразно открывать доступ к разделам «Управление структурой данных» и «Управление пользователями и группами» рядовым пользователям системы. Пользователь root имеет доступ ко всем разделам. Доступ пользователя к разделам определяется в настройках файла login.ini. Подробнее об этом можно прочитать в документе "Система управления контентом Cairo: Файлы конфигурации".
Условно, страницу интерфейса администратора можно поделить на три области: верхняя панель, левая панель меню и основная часть.
В верхней панели слева выводится путь к текущей странице интерфейса администратора. В правой части данной панели отображается имя авторизированного пользователя и название текущего ресурса данных, правее находится ссылка "Выход".
В левой панели меню расположены ссылки на разделы интерфейса администратора Cairo. Если активный раздел имеет подменю, оно выводится в раскрытом виде. Выпадающий список "Типы сущностей" расположен над списком разделов и предназначен для быстрого доступа к перечню всех сущностей определенного типа. Данный элемент управления выводится в любом разделе интерфейса администратора.
Содержимое основной части страницы зависит от контекста.
Для вызова формы редактирования регистрационных данных авторизированного пользователя используйте ссылку на имени пользователя, которое выводится в правом верхнем углу страницы.
К регистрационным данным пользователя относятся как параметры справочного характера (фамилия, дата рождения и т.п.), так и системные параметры, такие как системное имя пользователя и пароль.
Системное имя вводится при авторизации в поле "Логин" и является единственным параметром учетной записи пользователя, который не может быть изменен.
Чтобы завершить работу с системой, используйте ссылку "Выход", расположенную в правом верхнем углу страницы.
Выход может быть выполнен автоматически по истечении времени жизни сессии. Сессия считается завершенной, если с момента последнего действия пользователя (таким действием может быть переход по ссылке или нажатие кнопки) прошел период времени, который превышает время жизни сессии. Сессия прерывается автоматически при закрытии браузера.
Время жизни сессии зависит от настроек PHP на сервере и может быть изменено. В большинстве случаев время жизни сессии составляет порядка 20 минут.
По истечении времени жизни сессии, при попытке продолжить работу с интерфейсом администратора, будет выведена страница авторизации. После авторизации работа с интерфейсом администратора будет продолжена с той страницы, на которую попытался перейти пользователь в момент запроса авторизации.
Раздел "Управление данными" служит для выполнения повседневных задач управления контентом. В этом разделе пользователь может просматривать, создавать и редактировать сущности, управлять связями между сущностями, регулировать права доступа к сущностям.
В главном меню выводятся ссылки на корневые сущности. Чтобы увидеть ссылку на сущность в меню, пользователь должен иметь право на чтение данной сущности.
Корневой является сущность, которая не имеет родительских сущностей. Корневые сущности добавляются в процессе создания структуры данных.
В меню могут выводиться не только корневые сущности. Сущность, которая не является корневой, выводится в меню в том случае, если авторизированный пользователь не имеет прав доступа к родителю данной сущности. Благодаря этому, система может быть настроена таким образом, что пользователь, который не имеет доступа к сущности "Каталог товаров", но при этом имеет доступ к некоторым категориям каталога, увидит в главном меню ссылки на эти категории.
В любом случае, для того чтобы ссылка на сущность выводилась в главном меню в параметрах типа сущности должно быть определено, что сущности данного типа могут выводиться в меню. Это относится как к простым, так и корневым сущностям. Подробнее об установке параметров типа сущности можно узнать в разделе "Управление структурой данных".
Для облегчения навигации по разделу «Управление данными» предназначена вспомогательная панель навигации. Она выводится в боковом меню над перечнем ссылок на сущности. Содержимое вспомогательной панели зависит от того, на какой странице она выводится.
На странице перечня сущностей вспомогательная панель навигации содержит ссылку на страницу сущности, к которой относится данный перечень, а также ссылки на остальные перечни вложений, относящиеся к ней.
На странице сущности вспомогательная панель навигации содержит ссылку на родительскую сущность; перечень вложений, к которому относится текущая сущность; ссылки на остальные перечни вложений, относящиеся к родительской сущности.
Особенностью навигации в разделе «Управление данными» является поведение пути в верхней панели страницы. Путь содержит ссылки на страницы отдельных сущностей, однако, не содержит ссылок на точки вложения. Таким образом, используя только путь, Вы не сможете перейти на перечень сущностей, а значит не всегда сможете вернуться на предыдущую страницу. Этот недостаток компенсирует вспомогательная панель навигации, где выводятся ссылки на точки вложения текущей сущности.
Страница сущности состоит из следующих блоков:
заголовочный блок
вложения
поля
пути
Закладка «Дополнительно» ведет на страницу с информацией о создании и последнем изменении сущности.
Заголовочный блок содержит следующую информацию:
Заголовок сущности
Идентификатор сущности
Владелец сущности
Группа сущности
Права на сущность
Тип сущности
Заголовок сущности – это строка текста длиной до 255 символов. Заголовок присваивается сущности в момент ее создания и обновляется в момент ее изменения. В заголовок сущности могут входить значения нескольких ее полей. Значения полей разделяются в заголовке знаком пробела и идут в порядке, соответствующем порядку полей сущности, который определяется на уровне ее типа. Если длина заголовка превышает допустимое число символов, строка будет автоматически обрезана до нужной длины.
Идентификатор сущности может принимать значения от 1 до 2 147 483 647. Идентификационный номер присваивается сущности автоматически при ее создании и не может быть изменен впоследствии. В системе не может существовать сущностей с одинаковыми идентификаторами.
Владельцем сущности может выступать как зарегистрированный, так и анонимный пользователь. Как правило, владелец сущности имеет более широкий набор прав. Из всех пользователей только владелец и root имеют возможность изменять права на сущность. По умолчанию владельцем является создатель сущности, однако, владелец сущности и ее создатель не всегда одно и то же лицо.
Пользователи одной из групп имеют особый набор прав на работу с сущностью. Для данной сущности эта группа пользователей выступает «группой сущности». По умолчанию сущности присваивается группа родительской сущности.
Права на сущность состоят из трех триплетов. Первый триплет определяет права владельца сущности, второй – группы сущности, третий – права остальных пользователей. Каждый триплет устанавливает права на чтение (R), запись (W) и добавление вложений (X).
Тип сущности определяет набор полей и точек вложения каждого экземпляра типа. Ссылка на названии типа в заголовочном блоке ведет на перечень всех сущностей данного типа.
Блок «Вложения» содержит перечень точек вложения. Каждой точке вложения соответствует ссылка, которая ведет на список вложений, а также ссылки на добавление новой и прикрепление существующей сущности.
Точки вложения позволяют строго регламентировать связи между сущностями. Точка вложения создается на уровне типа сущности. Она может содержать сущности только одного типа. При этом для типа сущности может быть задано несколько точек вложения. Например, сущность типа "Отель" может содержать и сущности типа "Номер отеля", и "Фото отеля". Для этого на уровне типа сущности "Отель" задаются две точки вложения: "Перечень номеров отеля" и "Галерея изображения отеля".
Более подробную информацию о точках вложения можно получить в документе "Система управления контентом Cairo: Руководство разработчика".
Ссылка "Создать" предназначена для добавления новой сущности в качестве вложения, а ссылка "Выбрать" - для добавления вложения из числа имеющихся сущностей соответствующего типа. Переход на перечень вложенных сущностей выполняется нажатием на кнопку со стрелкой.
Наличие ссылок на пунктах «Создать» и «Выбрать» зависит от прав авторизированного пользователя и настроек точки вложения. Так, на уровне типа сущности для точки вложения может быть установлено ограничение на добавление новых сущностей. В таком случае в точку вложения могут быть добавлены только ссылки на существующие сущности. Об этом свидетельствует неактивный пункт «Создать». Если в полях добавления новой и добавления существующей сущности вместо пунктов «Создать» и «Выбрать» выводится «Недопустимо», это говорит и об отсутствии у авторизированного пользователя права на добавление вложений (Х) в текущую сущность.
Если вложенный тип содержит несколько подтипов – пользователю предоставляется возможность либо вывести все сущности типа, либо сущности определенного подтипа, относящиеся к данной точке вложения. Для этих целей служит выпадающий список выбора подтипа, который появляется автоматически, когда тип, относящийся к точке вложения, содержит подтипы.
Если тип, соответствующий точке вложения, содержит несколько подтипов, при создании сущности необходимо выбрать конкретный подтип. Создание сущностей без указания подтипа (при наличии таковых) не допускается.
Сущность может выступать вложением для нескольких других сущностей одновременно. Ссылки на эти сущности выводятся в блоке "Пути", который расположен в нижней части страницы.
Для перехода на страницу просмотра дополнительной информации о сущности служит закладка «Дополнительно», расположенная в верхней части страницы сущности.
Дополнительная информация о сущности включает данные о создании сущности:
дата/время создания сущности
имя пользователя, который создал сущность
а также данные о последнем изменении сущности:
дата/время последнего изменения значений полей сущности
имя пользователя, который внес последние изменения в значения полей сущности
Переход на страницу редактирования значений полей сущности можно выполнить как со страницы перечня сущностей: иконка «Редактировать», так и со страницы сущности: кнопка «Изменить». Если иконка/кнопка редактирования не активна – это свидетельствует об отсутствии у авторизированного пользователя права (W) на редактирование сущности.
После нажатия на кнопке «Отмена» на странице редактирования сущности, пользователь попадает на страницу данной сущности.
По степени важности поля разделяются на «Обязательные», «Важные» и «Необязательные».
Сущность не может быть создана либо отредактирована, если не заполнено хотя бы одно из ее обязательных полей, а также, если любое из ее полей содержит недопустимое значение. Допустимость значений определяется на уровне типа сущности для каждого отдельного поля. На странице просмотра и редактирования сущности обязательные поля маркируются значком «*».
Заполнение важных полей не является обязательным. Система напоминает пользователю о том, что не заполнено одно из важных полей, однако, позволяет сохранять сущность с незаполненными важными полями.
Система обеспечивает проверку значений полей как на стороне клиента (средствами JavaScript), так и на стороне сервера.
Страница, на которую попадает пользователь после редактирования сущности при нажатии на кнопке «Сохранить», зависит от значения, установленного в панели «После сохранения», расположенной в нижней части страницы. Доступны следующие варианты: «Страница сущности», «Редактирование сущности» и «Вернуться в список». Выбор может быть зафиксирован путем установки флага «Сохранить выбор».
Если редактируемая сущность является корневой, опция «Вернуться в список» не доступна.
В системе существует три вида перечней сущностей
Сквозной перечень сущностей одного типа
Перечень сущностей, относящихся к отдельной точке вложения
Перечень сущностей, доступных для вложения
Для вывода сквозных перечней сущностей одного типа предназначен выпадающий список над боковым меню. Сквозной перечень сущностей содержит все сущности отдельного типа/подтипа, доступные в рамках текущего ресурса.
Для просмотра перечня сущностей, относящихся к одной точке вложения, необходимо выбрать соответствующую точку вложения в блоке «Вложения» на странице сущности.
Перечень сущностей доступных для вложения содержит полный перечень сущностей определенного типа за исключением тех, что уже присутствуют в точке вложения. Для перехода к перечню сущностей, доступных для вложения, необходимо воспользоваться ссылкой «Выбрать» в блоке «Вложения» на странице сущности.
Перечень сущностей всегда содержит сущности одного типа. При этом тип может включать несколько подтипов. Если перечень содержит подтипы, в левой части шапки перечня отображается выпадающий список для выбора подтипа.
Сущности в перечне отображаются постранично. По умолчанию отдельная страница содержит 40 позиций. Пользователь имеет возможность выбирать количество сущностей, выводимых на странице. Выбранное значение действительно для любого перечня сущностей в системе. Данная настройка сохраняется в файле cookie и будет утрачена при удалении файла. При авторизации пользователя с другого компьютера, настройка также не будет действовать.
Любой перечень сущностей поддерживает операции сортировки и фильтрации, позволяет регулировать набор и порядок выводимых столбцов.
К перечню сущностей может быть применен фильтр. Поля сущностей, по которым могут быть установлены значения фильтра, зависят от набора столбцов, отображаемых в перечне.
По умолчанию строка фильтрации перечня находится в свернутом состоянии. Чтобы отобразить строку фильтров нажмите на ссылке «Показать/скрыть» фильтры, которая расположена в шапке таблицы перечня сущностей. Чтобы применить значения фильтров используйте кнопку «Применить фильтры», расположенную в правой части строки фильтров.
До тех пор, пока к перечню применен фильтр, строка фильтров находится в развернутом состоянии. В такой ситуации при нажатии на ссылке «Показать/скрыть фильтры» строка фильтров будет свернута, а фильтр автоматически отменен. Если необходимо отменить значения фильтра, не сворачивая строку фильтров, воспользуйтесь кнопкой «Отменить фильтр», расположенной в правой части строки фильтров.
Для сортировки перечня сущностей служат соответствующие иконки, расположенные справа от названий столбцов. Треугольник, вершина которого направлена вверх, предназначен для сортировки перечня по убыванию, треугольник с вершиной, направленной вниз – по возрастанию.
Перечень может быть отсортирован по нескольким столбцам одновременно. Сортировка по нескольким столбцам производится в порядке расположения столбцов слева – направо. Чтобы отсортировать перечень по нескольким столбцам, необходимо установить флаг «Множественная сортировка» в шапке таблицы перечня. Чтобы отменить множественную сортировку, нужно снять флаг «Множественная сортировка» и произвести сортировку по любому из столбцов.
Сортировка по умолчанию для перечня устанавливается на уровне типа сущности. Но, если перечень является упорядоченным (см. подраздел "Упорядоченный перечень"), сущности будут сортироваться по порядку, не зависимо от значения сортировки по умолчанию. Кроме того, система запоминает последнее значение сортировки перечня.
Пользователь может самостоятельно установить порядок и набор отображаемых столбцов для перечня сущностей отдельного типа/подтипа. Для вызова окна редактирования набора и порядка столбцов служит кнопка «Столбцы», расположенная в верхней части страницы перечня сущностей.
Кроме полей сущности (набор которых зависит от типа сущности) в перечне могут быть выведены столбцы со значениями служебных параметров сущности. Набор служебных параметров является неизменным для сущностей любого типа.
К служебным относятся следующие параметры:
ID (идентификатор сущности)
Тип сущности
Создатель
Владелец
Группа
Права
Дата добавления
Дата редактирования
Если в перечне выводятся сущности нескольких подтипов, относящихся к одному типу, то в столбцах могут быть выведены только поля типа, общие для всех подтипов. Чтобы в окне столбцов стали доступны поля, специфические для отдельного подтипа, необходимо вывести в перечне сущности данного подтипа. Для этого следует воспользоваться выпадающим списком выбора подтипа, который расположен в шапке перечня сущностей.
Если пользователю необходимо регулировать порядок сущностей в перечне произвольным образом, создается упорядоченный перечень сущностей. Чтобы изменить порядок в таком перечне - установите новые значения порядка в соответствующих выпадающих списках столбца управления порядком, расположенного в левой части перечня, и нажмите кнопку «Применить».
Если перечень является упорядоченным, то значение сортировки по умолчанию для сущностей данного типа игнорируется и перечень сортируется по порядку.
Когда упорядоченный перечень содержит сущности нескольких подтипов, столбец управления порядком в таком перечне отображается только в том случае, если в перечне выведены сущности всех подтипов данного типа. Если в перечне выведены сущности только одного подтипа, столбец управления порядком не отображается. Чтобы увидеть порядок в выпадающем списке выбора подтипов на странице перечня нужно выбрать значение «Все».
В некоторых случаях столбец управления порядком отображается, но не является активным. Это происходит тогда, когда сущности отсортированы не по порядку. Также столбец является неактивным, если авторизированный пользователь не имеет прав на просмотр всех сущностей перечня. Фактически, это означает, что пользователь не имеет права изменять порядок.
Сущность может быть создана либо как корневая сущность, либо как вложение другой сущности. Сущности связаны между собой ссылками. Структура данных строго ограничивает типы прикрепляемых друг к другу сущностей. Например, сущность типа «Новость» можно вкладывать в сущность типа «Лента новостей», но не наоборот.
Сущность может быть прикреплена в нескольких местах к нескольким другим сущностям. При этом существует два способа прикрепления сущности: жесткой и символической ссылками. От типа ссылки зависит результат ее удаления. Символические ссылки являются, своего рода, ярлыками. При удалении сущности из системы все ее символические ссылки удаляются автоматически, а при удалении символической ссылки – удаляется только сама ссылка. Удаление сущности из системы происходит при удалении последней жесткой ссылки на нее.
Символическая ссылка не может существовать без жесткой ссылки. Таким образом, при удалении символической ссылки сущность удаляется только из текущей точки вложения. Остальные жесткие и символические ссылки данной сущности, как и сама сущность, остаются нетронутыми.
Жесткие и символические ссылки можно визуально распознать в перечне сущностей по иконке слева. Иконка символической ссылки обозначена как ярлык.
Новая сущность может быть создана либо как корневая, либо как вложение другой сущности. Создание корневых сущностей происходит в разделе "Управление структурой данных". Зачастую, этот раздел не доступен для рядовых пользователей, имеющих доступ к интерфейсу администратора Cairo. В разделе "Управление данными" новая сущность может быть создана только как вложение уже существующей сущности.
При создании сущности в качестве вложения, фактически, производится две операции: создается сущность и в соответствующей точке вложения добавляется жесткая ссылка на нее.
Для создания новой сущности необходимо воспользоваться ссылкой «Создать», выбрав нужную точку вложения в блоке вложений на странице родительской сущности. При создании сущности, как и при ее редактировании, выполняется проверка на важность параметров и допустимость вводимых значений. Ссылка «Создать» не всегда является доступной, что зависит от настроек типа сущности, которая является родительской по отношению к создаваемой сущности и прав авторизированного пользователя.
Новое вложение может быть создано и со страницы перечня сущностей. Для этого следует воспользоваться кнопкой "Создать" в верхней части страницы. Кнопка создания сущности может быть неактивной, если тип сущностей содержит подтипы и при этом на странице выведены сущности всех подтипов, относящихся к типу. В таком случае, чтобы кнопка создания сущности стала активной необходимо вывести в перечне сущности того подтипа, к которому должна относиться создаваемая сущность. Выбор подтипа производится при помощи выпадающего списка, расположенного в шапке перечня. Кроме того, кнопка может быть неактивной по причине отсутствия у авторизированного пользователя прав на добавление вложений в сущность, к которой относится выведенный перечень.
Пользователь может выбрать страницу, которая будет загружена после нажатия кнопки «Сохранить». Доступны следующие варианты: «Страница сущности», «Вернуться в список», «Добавить новую сущность», «Редактирование сущности». Данный выбор может быть зафиксирован путем установки флага «Запомнить». Так, например, при добавлении нескольких сущностей подряд в одну точку вложения, будет удобно установить значение «Добавить новую сущность», отметив флаг «Сохранить выбор».
Часто бывает необходимо создать связь между уже существующими сущностями. Для этого следует нажать «Выбрать» в блоке «Вложения» на странице сущности, в которую производится добавление ссылки.
После перехода по ссылке «Выбрать», отображается перечень всех сущностей типа, соответствующего выбранной точке вложения за исключением тех, что уже присутствуют в данной точке вложения. Перечень допустимых для вложения сущностей может быть полноценно отфильтрован и отсортирован, также можно изменять набор и порядок отображаемых столбцов. Из данного перечня нельзя выполнить переход на страницу сущности, а информация о параметрах и путях прикрепления данной сущности открывается в новом окне.
Чтобы прикрепить сущности, выделите их в правом столбце, выберите способ прикрепления (жесткая или символическая ссылка) и нажмите кнопку «Применить». По умолчанию предлагается использовать символическую ссылку.
Доступна также функция копирования сущности. При копировании создается новая сущность с собственным идентификатором.
Сущность может быть прикреплена в нескольких местах. Удаление сущности производится в момент удаления последней жесткой ссылки на нее. Во всех остальных случаях удаляется только ссылка на сущность. Все символические ссылки данной сущности удаляются автоматически при удалении сущности. Перечень всех сущностей, к которым прикреплена отдельная сущность, выводится в блоке «Пути» на странице этой сущности.
Операция удаления ссылки на сущность производится со страницы перечня сущностей. Для того, чтобы удалить ссылку на сущность, перейдите на страницу точки вложения, выделите сущность, ссылку на которую вы собираетесь удалить, и нажмите кнопку «Применить».
Для каждой сущности определено три набора прав:
права для пользователя, который является владельцем сущности
права для группы пользователей, к которой относится сущность
права для остальных пользователей, включая анонимных
В каждом из наборов устанавливаются права на чтение (R) и запись (W) – редактирование значений полей сущности, а также право на добавление вложений (X) к данной сущности.
Права на работу с сущностями распространяются на всех пользователей кроме пользователя root. Пользователь root имеет абсолютные права на работу с сущностями.
Редактировать права для работы с сущностью может либо ее владелец, либо пользователь root. В остальных случаях кнопка «Права доступа» не является активной. При редактировании прав имеется возможность выбирать владельца и группу сущности, а также устанавливать значения каждого из трех наборов прав.
Окно редактирования прав может быть вызвано со страницы сущности и со страницы редактирования полей сущности нажатием на кнопке «Права доступа», расположенной в правом верхнем углу страницы.
Для работы с наборами значений в системе используются два похожих типа полей сущности: справочник и перечисление. Если набор значений используется только в одном типе сущностей, целесообразно использовать перечисление. Когда набор значений применяется в нескольких типах сущностей – следует использовать справочник. Кроме того, в отличие от перечислений, значения нескольких справочников могут быть связаны друг с другом.
Для управления справочниками в системе предусмотрен специальный раздел. Ссылка на раздел управления справочниками находится в боковом меню. Управление справочниками сводится к управлению элементами отдельных справочников и связями между справочниками и их элементами.
Начальная страница раздела «Управление справочниками» содержит постраничный перечень всех справочников ресурса. При работе с перечнем справочников доступны функции сортировки и фильтрации.
Справочник состоит из заголовка, комментария и набора элементов. Заголовок справочника должен быть уникальным. Для редактирования заголовка и комментария справочника служит иконка «Редактировать», расположенная в перечне справочников.
Для добавления справочника используйте кнопку «Создать» на странице перечня справочников.
Справочник содержит набор элементов. Технически, справочник может содержать неограниченное количество элементов. На практике рекомендуется использовать не более 1000 элементов для одного справочника.
Для перехода к управлению набором элементов справочника служит соответствующая иконка в перечне справочников.
Элемент справочника характеризуется следующими параметрами:
Псевдоним
Значение
Комментарий
Параметры «Псевдоним» и «Значение» являются обязательными для заполнения.
При работе со справочником в разделе «Управление данными» для вывода элементов справочника в выпадающем списке используются не значения, а псевдонимы элементов.
В качестве значения элемента справочника используется строка. Часто, в качестве значений используются числа, поэтому поле «Значение» по умолчанию содержит номер, который является следующим по порядку после максимального числового значения справочника.
Справочник не может содержать элементов с повторяющимися значениями. При попытке ввода элемента с повторяющимся значением система выдаст предупреждение и предложит заменить старый элемент справочника на добавляемый.
Справочник не может содержать элементов с повторяющимися псевдонимами. При попытке ввода элемента с повторяющимся псевдонимом система выдаст предупреждение о том, что элемент не может быть добавлен.
Параметр «Комментарий» не является обязательным для заполнения. Он носит информативный характер и может содержать произвольный текст, описывающий элемент справочника.
Для редактирования элемента справочника выберите соответствующую ему позицию в списке «Элементы справочника» и нажмите кнопку «Редактировать». Значения параметров элемента справочника будут автоматически подставлены в форму редактирования. После нажатия на кнопке «Добавить» система выдаст предупреждение о том, что старый элемент справочника будет заменен.
В некоторых ситуациях возникает необходимость установки соответствий между значениями справочников. Примером связанных справочников выступают Страна-Город-Район, Группа-Подгруппа, Город-Способ доставки и т.д.
Чтобы установить соответствие между элементами двух справочников, эти справочники необходимо связать. Причем один из справочников должен выполнять роль главного, другой – подчиненного. В соответствии с этими ролями будут устанавливаться отношения между элементами справочника.
Элемент подчиненного справочника может соответствовать нескольким элементам главного справочника. Одному элементу главного справочника может соответствовать несколько элементов подчиненного справочника.
Для вывода перечня связей между справочниками воспользуйтесь пунктом «Связи справочников» в подменю раздела «Управление справочниками». При работе с перечнем связей между справочниками доступны функции сортировки и фильтрации.
Система не позволяет заменять как главный, так и подчиненный справочники для существующей связи. При возникновении такой потребности нужно создать новую связь и удалить старую.
Страница редактирования связей между элементами справочников содержит заголовки главного и подчиненного справочников, а также форму редактирования связей между элементами.
Форма редактирования связей между элементами справочника состоит из трех полей:
выбор элемента главного справочника
перечень всех элементов подчиненного справочника (за исключением тех, что были указаны как соответствующие выбранному элементу главного справочника)
перечень элементов подчиненного справочника, соответствующих выбранному элементу родительского справочника
Система позволяет создавать цепочки связанных справочников. Примером цепочки из трех справочников является связь Город-Район-Улица. Количество спарвочников, связанных в цепочку не ограничено.
Связи между справочниками учитываются при работе с фильтрами и формами редактирования сущности, которые содержат поля, использующие связанные между собой справочники.
Ссылка на раздел управления пользователями и группами находится в боковом меню.
Начальная страница раздела «Управление пользователями» содержит постраничный перечень всех пользователей, зарегистрированных в системе. При работе с перечнем пользователей доступны функции сортировки и фильтрации.
Пользователь системы характеризуется следующим набором параметров:
Идентификатор пользователя
Псевдоним
Пароль
Фамилия
Имя
Отчество
Пол
Город
Должность
Компания
ICQ
Веб-сайт
Дата рождения
Дополнительная информация
Телефон
Дата регистрации
Каждый пользователь имеет уникальный идентификатор. Идентификатор пользователя со значением «1» зарезервирован для пользователя root.
Псевдоним пользователя может состоять из символов латиницы, цифр и знаков подчеркивания, не может быть короче четырех и длиннее двадцати символов.
Пароль пользователя может состоять из символов латиницы, цифр и знаков подчеркивания. Пароль пользователя не может быть короче шести и длиннее двадцати символов.
При редактировании регистрационных данных пользователя поле пароль может быть оставлено незаполненным. В таком случае пароль пользователя не будет изменен. Если необходимо изменить пароль пользователя, его нужно ввести дважды: в поле «Пароль» и в поле «Подтверждение пароля».
Идентификатор, присваиваемый пользователю при его создании, не доступен для редактирования.
Для создания пользователя служит кнопка «Добавить пользователя», расположенная в верхней части страницы перечня пользователей, а также страницы пользователя.
В форме добавления пользователя система предлагает ввести идентификатор добавляемого пользователя. Если поле ввода идентификатора оставить незаполненным, система самостоятельно присвоит идентификатор добавляемому пользователю.
Удаление пользователей производится со страницы перечня пользователей. Для удаления пользователей необходимо выделить соответствующие позиции перечня и нажать кнопку «Применить». Пользователь root не может быть удален из системы, поэтому поле выбора пользователя root является неактивным.
Хозяином сущностей, владелец которых был удален, автоматически становится пользователь root.
Пользователь root всегда существует в системе и не может быть удален. Root имеет неограниченные права на сущности и доступ ко всем разделам интерфейса администратора. Для повседневной работы с системой не рекомендуется использовать учетную запись пользователя root. Даже если с системой работает один человек, для него целесообразно завести отдельную учетную запись пользователя.
Зарегистрированные в системе пользователи могут быть организованы в группы. Пользователь может не принадлежать ни к одной из групп, а может принадлежать к нескольким группам одновременно.
Группу характеризует единственный параметр: «Имя группы».
Перечень всех групп, в которые входит пользователь, доступен со страницы пользователя: закладка «Перечень групп». Перечень групп является постраничным, доступны функции сортировки и фильтрации перечня групп.
Для добавления пользователя в группу выберите нужные группы в крайнем правом столбце перечня и нажмите кнопку «Применить».
Перечень всех групп, зарегистрированных в системе, доступен через пункт меню «Группы» в разделе «Управление пользователями». Перечень групп является постраничным, доступны функции сортировки и фильтрации перечня групп.
Тип определяет перечень полей и точек вложения относящихся к нему сущностей. Структура данных представляет собой совокупность всех типов сущностей, соответствующих ресурсу данных.
Ссылка на раздел «Управление структурой данных» находится в боковом меню. Для доступа к разделу управления структурой данных пользователь должен быть наделен соответствующими правами. Данный раздел, зачастую, недоступен для рядовых пользователей системы, но всегда доступен для пользователя root.
Начальная страница раздела «Управление структурой данных» содержит постраничный перечень всех типов сущностей, относящихся к ресурсу. При работе с перечнем типов доступны функции сортировки и фильтрации. Для перехода на страницу типа воспользуйтесь иконкой "Просмотр", которая расположена в правой части перечня.
Тип сущностей может иметь подтипы. В таком случае при переходе на страницу типа отображается промежуточная страница, где выводятся как ссылки на подтипы, так и ссылка на главный тип.
Тип может быть добавлен со страницы перечня типов. Для добавления типа воспользуйтесь кнопкой «Добавить тип», которая расположена в верхней части страницы перечня типов. Параметры, обозначенные значком «*», являются обязательными для заполнения.
При удалении типа удаляются все подтипы, точки вложения и сущности, относящиеся к данному типу. Таким образом, операция удаления типа способна внести серьезные изменения в структуру и данные ресурса.
Для удаления типа выберите соответствующую позицию в перечне всех типов и нажмите кнопку «Применить».
Страница перечня подтипов доступна только в случае, если тип сущностей содержит подтипы. Количество подтипов для каждого типа выводится на странице перечня типов.
Страница перечня подтипа появляется автоматически при попытке перехода со страницы перечня типов на страницу типа, содержащего подтипы.
Главный тип выделен в данном перечне серым цветом, соответствующая маркировка присутствует в колоке "Главный тип".
Чтобы добавить подтип, воспользуйтесь кнопкой «Добавить подтип» на странице типа или на странице перечня подтипов (если данная страница доступна).
При удалении подтипа удаляются все сущности, относящиеся к данному подтипу.
Для удаления подтипов, выделите соответствующие позиции на странице перечня подтипов и воспользуйтесь кнопкой «Применить».
Главный тип не может быть удален со страницы перечня подтипов. Удаление главного типа производится со страницы перечня всех типов.
Страница типа/подтипа содержит три блока: «Параметры», «Допустимые для вложения типы» и «Список полей».
Тип сущностей характеризуется следующими параметрами:
Имя типа
Имя таблицы
Права по умолчанию
Появляется в главном меню
Комментарий
Имя типа используется в интерфейсе администратора.
Параметр «Имя таблицы» определяет имя таблицы в базе данных, где будет храниться информация о сущностях данного типа.
Права по умолчанию определяют начальные настройки прав для создаваемых сущностей, относящихся к данному типу.
В главном меню могут выводиться как корневые сущности, так и простые сущности. Простые сущности отображаются в меню в том случае, если авторизированный пользователь не имеет права на просмотр корневых сущностей, вложениями которых они являются. Параметр "Появляется в главном меню" определяет возможность для сущностей данного типа отображаться в главном меню.
«Комментарий» носит информативный характер и не является обязательным для заполнения.
Типы допустимых для вложения сущностей определяются набором точек вложения. Перечень точек вложения, относящихся к типу содержится в блоке «Допустимые для вложения типы» на странице типа.
Точка вложения может соответствовать только одному типу сущностей. Тип сущностей может содержать неограниченное количество точек вложения.
Точка вложения характеризуется следующими параметрами:
Тип вложения
Псевдоним
Только символические ссылки
Порядок
Параметр "Тип вложения" определяет тип допустимых для вложения сущностей. Допустимый для вложения тип должен быть выбран из числа существующих типов. Если в качестве допустимого для вложения типа необходимо использовать тип, которого еще не существует, его нужно создать предварительно. Точка вложения может содержать сущности любого из подтипов, относящихся к указанному типу.
Псевдоним задает название точки вложения и является важной информацией при идентификации точки вложения в интерфейсе управления данными. Например: товары, прикрепляемые к другому товару, могут называться “Аксессуары”.
Параметр «Только символические ссылки» должен быть установлен в том случае, когда точка вложения не допускает добавление новых сущностей, а может содержать только ссылки на существующие в системе сущности.
Параметр «Порядок» определяет, является ли перечень вложений упорядоченным.
Переход на редактирование параметров точки вложения может быть выполнен со страницы списка точек вложения. Для перехода на страницу списка точек вложения воспользуйтесь кнопкой «Список» в блоке «Допустимые для вложения типы» на странице типа сущности.
Чтобы добавить новый допустимый для вложения тип – воспользуйтесь кнопкой «Добавить тип» на странице типа в блоке «Допустимые для вложения типы».
Для перехода к странице редактирования перечня точек вложения воспользуйтесь кнопкой «Список» в блоке «Допустимые для вложения типы» на странице типа сущностей.
Выделите позиции, которые должны быть удалены и нажмите кнопку «Применить», расположенную в нижней части списка.
Список полей является общим для всех сущностей типа. Подтипы могут расширять список полей главного типа. Расширенный список полей подтипа будет общим для всех сущностей подтипа.
На странице подтипа в блоке "Список полей" выводятся только поля, специфические для данного подтипа.
Порядок полей учитывается при выводе полей сущности в разделе "Управление данными".
Для редактирования списка и изменения порядка полей типа предназначена кнопка «Список» в блоке «Список полей» на странице типа.
Чтобы изменить порядок полей – установите новые значения порядка в столбце управления порядком, расположенном в левой части перечня, и нажмите кнопку «Изменить порядок».
Чтобы добавить новое поле воспользуйтесь кнопкой «Добавить новое поле» в блоке «Список полей» на странице типа сущностей.
Информация о поле включает:
Псевдоним поля
Имя поля
Тип поля
Формат поля
Шаблон поля
Размер
Регулярное выражение
Значение по умолчанию
Условие
Сообщение об ошибке
Предупреждающее сообщение
Важность поля
Комментарий
Видимость
Может ли выводиться в списке
Отображается в списке
Тип сортировки
Входит в заголовок
Имя поля используется для идентификации поля и хранения информации о поле в БД. Имя поля может содержать символы латиницы, цифры и знаки подчеркивания. Первым символом в имени поля должен быть символ латиницы.
Для хранения и работы с различными данными в системе предусмотрено более двадцати типов полей. От типа поля зависит как будет выглядеть форма редактирования поля в разделе управления данными, допустимые значения поля и т.д.
По умолчанию предусмотрены следующие типы полей:
Таблица 6.1. Типы полей
# | Название | Описание | Комментарий |
---|---|---|---|
1 | string | строка | |
2 | адрес электронной почты | ||
3 | url | URL-адрес | |
4 | password | пароль | |
5 | select | перечисление с единственным выбором | |
6 | set | перечисление с множественным выбором | |
7 | hidden | скрытый | |
8 | integer | целый | |
9 | user | пользователь | |
10 | group | группа пользователей | |
11 | etype | тип сущности | |
12 | permissions | права | |
13 | datetime | дата/время | |
14 | dictionary | справочник | |
15 | image | изображение | |
16 | file | файл | |
17 | frmtext | форматированный текст | |
18 | text | текстовый | |
19 | bool | логический | |
20 | float | вещественный | |
21 | date | дата | |
22 | time | время | |
23 | money | денежный | |
24 | entity | ссылка на сущность |
Параметр «Формат поля» предназначен для тонкой настройки вариантов отображения поля. Например, данный параметр может быть использован для определения набора кнопок в панели инструментов WYSIWYG HTML-редактора, применяемого в формах редактирования полей типа «Форматированный текст».
Значение по умолчанию параметра «Формат поля» зависит от типа поля.
Значение параметра «Шаблон поля» содержит префикс имени файла шаблона. Файлы шаблона определяют то, как будет выводиться поле в разделе «Управление данными».
Значение по умолчанию параметра «Шаблон поля» зависит от типа поля и устанавливается автоматически.
Параметр содержит Perl-совместимое регулярное выражение, предназначенное для проверки значений поля. Такая проверка выполняется при создании и редактированиии сущностей в разделе "Управление данными" и производится как на стороне клиента (средствами JavaScript), так и на стороне сервера (средствами PHP).
Значение по умолчанию параметра «Регулярное выражение» зависит от типа поля и устанавливается автоматически.
Параметр может содержать строку кода на языке PHP с описанием условия проверки значения поля на допустимость. Применяется там, где не хватает возможностей Perl-совместимых регулярных выражений. В строке условия поле именуется как <$имя_поля>. Допускается использование функций PHP. Строка должна быть корректным логическим выражением: проверка введенного условия на корректность не производится.
Данный параметр содержит текст сообщения об ошибке, которое будет выдано пользователю, в случае если заданное значение является недопустимым.
Данный параметр содержит текст предупреждающего сообщения, которое будет выдано пользователю в случае если поле является «Важным» (см. «Важность поля»).
Параметр «Важность поля» может принимать одно из трех значений:
Не обязательное
Важное
Обязательное
Система не позволит отредактировать или создать сущность, если не задано значение одного из обязательных полей. Если же не задано значение одного из важных полей, система выдаст предупреждающее сообщение, однако, по желанию пользователя, пропустит пустые значения соответствующих полей.
Параметр «Видимость» влияет на возможность отображения поля в разделе «Управление данными».
Параметр определяет возможность вывода соответствующего столбца в перечне сущностей данного типа. Например, целесообразно отключать возможность вывода для полей, содержащих большие фрагменты текста.
Параметр определяет, присутствует ли по умолчанию столбец, соответствующий данному полю, в перечне сущностей в разделе «Управление данными».
Допускаются следующие варианты сортировки по значению поля:
По возрастанию
По убыванию
Отключена
Корневые сущности - это сущности верхнего уровня, к которым будут прикрепляться все остальные сущности ресурса.
Для добавления корневой сущности необходимо зайти на страницу соответствующего типа и воспользоваться кнопкой «Добавить корневую сущность».