Версия: 6.x
burger close
Класс PageApi
Граф наследования:PageApi:
EntityList BaseModel

Подробное описание

API отвечает за страницу с секциями и блоками

Открытые члены

 __construct ()
 
 importXML ($post_file_arr, $context=null)
 
 importFromXmlFile ($file, $site_id=null, $context=null)
 
 getSectionIdWithCreationContainerAndSections ($page_id, $type, $context)
 
 getBlocksXML ($context=null)
 
 getBlocksDom ($context=null)
 
 saveThemeBlocks ()
 
 getPageGridSystem ($page_id)
 
- Открытые члены унаследованные от EntityList
 __construct (AbstractObject $orm_element, array $options=[])
 
 setDefaultOrder ($order)
 
 getNameField ()
 
 setNameField ($field)
 
 setAliasField ($field)
 
 setSortField ($field)
 
 setIdField ($field)
 
 getIdField ()
 
 getSiteIdField ()
 
 setLoadOnDelete ($bool)
 
 setSiteContext ($site_id=null)
 
 getSiteContext ()
 
 setMultisite ($bool)
 
 isMultisite ()
 
 resetQueryObject ()
 
 getCleanQueryObject ()
 
 queryObj ()
 
 setQueryObj (\RS\Orm\Request $q)
 
 defAlias ()
 
 setFilter ($key, $value=null, $type= '=', $prefix= 'AND', array $options=[])
 
 clearFilter ()
 
 getList ($page=null, $page_size=null, $order=null)
 
 getListAsArray ($page=0, $page_size=0, $order= '')
 
 getListAsResource ($page=0, $page_size=0, $order= '')
 
 getPagedList ($page_size)
 
 loadAssocList ($key_field, $value=null)
 
 getAssocList ($key_field, $value=null)
 
 setOrder ($order=null, array $values=null)
 
 setGroup ($group=null)
 
 getListCount ()
 
 getFirst ()
 
 getOneItem ($id)
 
 getById ($id, $request=null)
 
 getElement ()
 
 setElement ($object)
 
 getElementClass ()
 
 getNewElement ()
 
 save ($id=null, array $user_post=[])
 
 addFilterControl (\RS\Html\Filter\Control $filter_control)
 
 addTableControl (\RS\Html\Table\Control $table_control)
 
 del (array $ids)
 
 multiDelete ($ids)
 
 getSelectList ($first=[])
 
 multieditFormView ($tpl_path, $formfile, array $addparam=[])
 
 multiUpdate (array $data, $ids=[])
 
 moveElement ($from, $to, $flag,\RS\Orm\Request $extra_expr=null)
 
 noWriteRights ($right=DefaultModuleRights::RIGHT_UPDATE)
 
 getIdByAlias ($alias_or_id, $alias_field=null)
 
 saveRequest ($key)
 
 getIdsByRequest (\RS\Orm\Request $request)
 
- Открытые члены унаследованные от BaseModel
 addError ($message, $fieldname=null, $form=null)
 
 hasError ()
 
 getErrors ()
 
 cleanErrors ()
 
 getDisplayErrors ()
 
 getErrorsStr ()
 
 getFormErrors ($form, $separator= ', ')
 
 getNonFormErrors ($separator= ', ')
 
 exportErrors ()
 
 importErrors ($data)
 

Открытые статические члены

static setupModule ($route_id, $block_class, array $params, $section_alias=null)
 
- Открытые статические члены унаследованные от EntityList
static getInstance ($key= 'default')
 
static staticSelectList ($first=[])
 
static getSavedRequest ($key, $default=null)
 

Поля данных

const DEFAULT_CONTEXT = 'theme'
 
- Поля данных унаследованные от EntityList
const WHERE_CONDITION_VAR = 'where_conditions'
 
- Поля данных унаследованные от BaseModel
 $form_fieldname = []
 
 $errors_by_form = []
 
 $errors_non_form = []
 
 $errors = []
 

Защищенные члены

 attrToArray ($attrs, $unserialize=false)
 
 importSectionsRecursive ($sections, $parent_id, $page_id)
 
 addTemplateHookSort (\DomDocument $dom,\DomElement $root, $context)
 
 addTemplateModules (\DomDocument $dom,\DomElement $root, $context)
 
 addXmlAttributes (\DomElement $dom_element,\RS\Orm\AbstractObject $orm_object)
 
- Защищенные члены унаследованные от EntityList
 parseArrayFilter ($filters)
 
 filterLike ($key, $value, $type, $prefix, $options)
 
 filterIs ($key, $value, $type, $prefix, $options)
 
 filterFullText ($key, $value, $type, $prefix, $options)
 
 filterIn ($key, $value, $type, $prefix, $options)
 
 filterNotin ($key, $value, $type, $prefix, $options)
 
 filterDefault ($key, $value, $type, $prefix, $options)
 
 setPage ($page, $pageSize)
 
 moveArrayUp ($arr)
 
 moveArrayDown ($arr)
 

Дополнительные унаследованные члены

- Защищенные данные унаследованные от EntityList
 $default_order
 
 $load_on_delete = false
 
 $id_field = 'id'
 
 $alias_field
 
 $sort_field
 
 $name_field
 
 $site_id_field = 'site_id'
 
 $is_multisite = false
 
 $site_context
 
 $def_table_alias = 'A'
 
 $obj
 
 $obj_instance
 
 $filter_active = false
 
 $multiedit_template = '%system%/coreobject/multiedit_form.tpl'
 
 $assocPlainList = []
 
 $parsePrefixes = ['&' => 'AND'
 
 $q
 
- Защищенные данные унаследованные от BaseModel
 $default_error_fieldname = 'Информация'
 
- Статические защищенные данные унаследованные от EntityList
static $instance = []
 

Конструктор(ы)

__construct ( )

Методы

addTemplateHookSort ( \DomDocument  $dom,
\DomElement  $root,
  $context 
)
protected

Добавляет информацию о сортировке модулей, при обработке хуков в шаблонах

Аргументы
\DomDocument$dom
\DomElement$root
mixed$context
addTemplateModules ( \DomDocument  $dom,
\DomElement  $root,
  $context 
)
protected

Добавляет информацию о блоках, добавленых через moduleinsert

Аргументы
\DomDocument$dom- объект DOM документа
\DomElement$root- корневой DOM элемент
$context
addXmlAttributes ( \DomElement  $dom_element,
\RS\Orm\AbstractObject  $orm_object 
)
protected

Добавляет атрибуты из свойств ORM объекта к узлу XML

Аргументы
DomElement$dom_element
\RS\Orm\AbstractObject$orm_object
attrToArray (   $attrs,
  $unserialize = false 
)
protected

Конвертирует атрибуты SimpleXML в обычный array

Аргументы
\SimpleXMLElement$attrs- Атрибуты
bool$unserialize- Если true, значит требуется десериализация данных
Возвращает
array
getBlocksDom (   $context = null)

Возвращает XML структуры блоков для всех страниц

Возвращает
DomDocument
getBlocksXML (   $context = null)

Возвращает xml со структурой блоков

Аргументы
string$context- идентификатор схемы блоков
Возвращает
void
getPageGridSystem (   $page_id)

Возвращает тип сеточного фреймворка, используемого на странице

Аргументы
Integer$page_id
Возвращает
string
getSectionIdWithCreationContainerAndSections (   $page_id,
  $type,
  $context 
)

Создаёт контейнер, строку, секцию для добавления модуля в него и возвращает id секции

Аргументы
integer$page_id- id страницы
integer$type- тип страницы
string$context- контекcт шаблона
Возвращает
integer
importFromXmlFile (   $file,
  $site_id = null,
  $context = null 
)

Импортирует структуру блоков из xml файла

Аргументы
string$file- Путь к xml файлу
integer$site_id- ID сайта
string$context- идентификатор структуры блоков
Возвращает
bool(true) | string возвращает true, в случае успеха, иначе текст ошибки
importSectionsRecursive (   $sections,
  $parent_id,
  $page_id 
)
protected

Рекурсивно импортирует секции в базу

Аргументы
\DomElement$sections- указатель на элемент секций
integer$parent_id- родительский элемент
integer$page_id- ID страницы
importXML (   $post_file_arr,
  $context = null 
)

Производит импорт структуры блоков из XML файла

Аргументы
array$post_file_arr- массив одного файла из $_FILES
string$context- идентификатор контекста темы оформления
Возвращает
bool(true) | string возвращает true, в случае успеха, иначе текст ошибки
saveThemeBlocks ( )

Сохраняет текущее распололожение блоков на страницах в файле blocks.xml текущей темы

Возвращает
boolean
static setupModule (   $route_id,
  $block_class,
array  $params,
  $section_alias = null 
)
static

Позволяет настроить параметры блока(ов)

Аргументы
string  |  null$route_id- ID маршрута(страница, на которой нужно править блок)
string$block_class- имя класса блочного контроллера
array$params- параметры, которые необходимо установить.
string$section_alias- псевдоним секции в которой нужно искать модуль
Возвращает
bool Возвращает true, если параметры установлены, иначе - false

Поля

const DEFAULT_CONTEXT = 'theme'