Руководство программиста системы управления разделом «электронная россия»

1 Введение 4

2 Архитектура системы 5

2.1 Разделы 5

2.1.1 Структура разделов 5

2.1.2 Область раздела 6

2.2 Информационный блок 6

2.2.1 Элементы контента 6

2.2.2 Параметры представления 7

2.3 Программный модуль 7

2.4 Шаблоны 7

2.4.1 Шаблон раздела 7

2.4.2 Шаблон представления 7

2.5 Языковая поддержка 8

2.5.1 Языковая поддержка в структуре сайта 8

2.5.2 Языковая поддержка в информационном наполнении 8

3 Методика разработки программных модулей 9

3.1 Состав модуля 9

3.2 Структура Данных модуля 9

3.3 Регистрация модуля в системе 10

3.4 Параметры представления 10

3.5 Клиентская часть модуля 11

3.5.1 API клиентской части модуля 11

3.5.2 Шаблоны модуля 13

3.6 Администраторская часть модуля 13

3.6.1 Интерфейс администратора 13

3.6.2 Последовательность шагов при разработке модуля 15

3.7 Безопасность при разработке модулей 15

3.7.1 Защита от SQL-injection 15

3.7.2 Защита от XSS (межсайтовый скриптинг) 16

4 Описание библиотечных функций 17

4.1 Библиотека resources.php 17

4.2 Библиотека vLibTemplate 24

5 Концептуальные схемы БД 25

5.1 Схема БД Ядра 25

5.1.1 Таблица CONTENT_MAP 26

5.1.2 Таблица CONTENT_TEXT 26

5.1.3 Таблица INF_BLOCK 26

5.1.4 Таблица MODULE_PARAM 26

5.1.5 Таблица MODULE_TEMPLATE 27

5.1.6 Таблица NEWS 27

5.1.7 Таблица PAGE 28

5.1.8 Таблица PAGE_AREA 28

5.1.9 Таблица PAGE_AREA_PARAM 29

5.1.10 Таблица PARAM_VALUE 29

5.1.11 Таблица PRG_MODULE 29

5.1.12 Таблица SITE 30

5.1.13 Таблица TEMPLATE 30

5.1.14 Таблица TEMPLATE_AREA 30

5.1.15 Таблица TEMPLATE_AREA_MAP 30

5.1.16 Таблица TEMPLATE_TYPE 30

5.2 Схема цепочки публикаций БД (workflow) 31

5.2.1 Таблица ADMINISTRATOR 31

5.2.2 Таблица ADMINISTRATOR_ROLE 32

5.2.3 Таблица BLOCK_USER_ROLE 32

5.2.4 Таблица CONTENT_TEXT 32

5.2.5 Таблица INF_BLOCK 32

5.2.6 Таблица LANG 33

5.2.7 Таблица RESOLUTION 33

5.2.8 Таблица STATE 33

5.2.9 Таблица STATUS_GRAPH 33

1Введение

Система RBC Contents построена по модульному принципу, что обеспечивает гибкость и масштабируемость системы. Таким образом, начальный функционал системы может быть расширен за счет написания соответствующих модулей. Настоящий документ предназначен разработчикам програмных модуелей для системы RBC Contents. Структурно документ делится на четыре части, не считая настоящего введения.

• 
  Архитектуры системы. В этой части вводятся основные понятия и определения, объясняются принципы взаимодействий между различными системными компонентами.
  
• 
  Методика разработки программных модулей. Эта часть документа посвещена практическим советам и рекомендациям по разработке модулей, а так же описанию существующих библиотечных функций системы, которые могут использоваться при разработке.
  
• 
  Описание библиотечных функций. Раздел одержит описание функций основной библиотеки, а также ссылки на документацию используемых программных решений сторонних разработчиков.
  
• 
  Концептуальные схемы БД. В четвертой заключительной части описывается структура таблиц ядра системы, их связи и назначение полей.
  

Перед прочтением настоящего документа рекомендуется ознакомиться c руководством контент-менеджера RBC Contents.