Справочное руководство
Функции
| Наименование | Назначение | Код |
|---|---|---|
| cms_theme |
Возвращает путь к каталогу текущего шаблона сайта. $args - переменная с аргументами, по умолчанию выводит путь к папке темы сайта. Необязательный параметр. $args = 'child' - передает путь к папке дочерней темы сайта $args = 'server' - передает полный серверный путь к папке темы сайта $args = 'child-server' - передает полный серверный путь к папке дочерней темы сайта |
|
| cms_headers | Формирует теги страницы: title, meta description, meta keywords, link canonical. Формирует запрет на индексирование страницы. Размещается в теге head. | |
| cms_headers_title |
Отображение заголовков страницы. $field - ID поля для отдельной языковой версии. Необязательный параметр. |
|
| cms_content | Формирует тело (содержание) страницы. | |
| cms_page_id | Возвращает ID текущей страницы. | |
| cms_translit | Возвращает транслитерированный текст. | |
| cms_date_translate |
Переводит данные в date() с английского на заданный язык. $date - преобразуемая дата. $lang - заданный язык. Необязательный параметр. По умолчанию - русский. |
|
| cms_search | Функция поиска по странице. | |
| cms_cache_delete | Очищает кэш сайта. | |
| cms_block_static |
Выводит статический блок. $block_id - ID блока. |
|
| cms_block_dynamic |
Выводит динамический блок. $section_id - ID блока. $array['sоrt_fields'] = массив полей для сортировки динамического блока 'sort_fields' => [ 'title' => 'asc' ] = способ написание дефолтных полей 'sort_fields' => [ 10 => [ 'desc', 0 ] ] = способ написание дополнительных полей, где последнее значение - заглушка для пустого поля (необязательный параметр) Пример: cms_block_dynamic( 10, ['sort_fields' => ['title' => 'asc', 15 => ['asc', 0]]] ); |
|
| cms_catalog |
Выводит дочерние разделы и элементы каталога относительно текущей страницы. $array['display'] - массив значений. Необязательный аргумент, по умолчанию = ['sections', 'elements'] $array['display'] = ['sections'] - выводит только подразделы $array['display'] = ['elements'] - выводит только элементы ['sections_all'] - выводит все разделы, входящие в текущий раздел, работает только вместе с ['sections'] ['elements_all'] - выводит все элементы, входящие в текущий раздел, работает только вместе с ['sections'] и ['elements'] $array['sоrt_fields'] = массив полей для сортировки динамического блока 'sort_fields' => [ 'title' => 'asc' ] = способ написание дефолтных полей 'sort_fields' => [ 10 => [ 'desc', 0 ] ] = способ написание дополнительных полей, где последнее значение - заглушка для пустого поля (необязательный параметр) Пример: cms_catalog([ 'display' => ['sections', 'elements', 'elements_all'], 'sort_fields' => ['title' => 'asc', 15 => ['asc', 0]] ]); |
|
| cms_catalog_nums | Выводит количество разделов и элементов каталога страниц. | |
| cms_faq | Выводит плагин "Вопрос-ответ". | |
| cms_page_comments | Выводит комментарии к странице. | |
| cms_gallery_cover |
Выводит обложку галереи страницы. $element_id = ID элемента, к которому привязано поле. $field_id = ID поля галереи. $img_type = тип выводимой обложки: значение 's' - малый эскиз обложки, значение 'b' - большой эскиз обложки, значение 'o' - оригинальное изображение |
|
| cms_tags_cloud | Выводит облако тегов. | |
| cms_tags_page | Выводит облако тегов на странице тегов. | |
| cms_tags_on_page | Выводит облако тегов конкретной страницы. | |
| cms_text_cut |
Обрезает текст в соответствии с параметрами. Параметры $text_cut_html, $break_words и $middle - необязательны. |
|
| cms_text_declension |
Склонение русских слов. $number - число, относительно которого будет выведен результат $array_words - одномерный массив из трех слов в разных падежах Пример: <?php echo '3 '.cms_text_declension(3,array('товар','товара','товаров')); ?> выведет "3 товара". |
|
| cms_field |
Выводит дополнительное поле. $element_id - ID страницы, элемента или блока, к которому относится поле $field_id - ID поля $array - массив значений, необязательный аргумент $array['image_type'] - аргумент для поля Изображение: значение 's' - малый эскиз, значение 'b' - большой эскиз, значение 'o' - оригинальное изображение $array['default'] - заглушка при отсутствии значения поля Пример: cms_field( 100, 10, [ 'image_type' => 'o', 'default' => 'Изображение отсутствует' ] ) |
|
| cms_field_value |
Вывод значения поля из выбранной таблицы БД. $field - имя поля таблицы $table - имя таблицы в БД $compare - условие сравнения $compare_field - имя поля сравнения $compare_operator - оператор сравнения $compare_field_value - значение поля сравнения |
|
| cms_redirect |
Редирект: $url - путь для редиректа. $type - тип редиректа: php, js (по умолчанию). Необязательный параметр. |
|
| cms_mysqli | Возвращает подключение к базе данных с помощью расширения MySQLi. | |
| cms_pdo | Возвращает подключение к базе данных с помощью модуля PDO. | |
| cms_count_query |
Функция подсчета записей в базе данных. $count_string - SQL-запрос. |
|
| cms_mail_send | Возвращает e-mail для уведомлений из CMS. |
Классы и методы
| Наименование | Назначение | Код |
|---|---|---|
| cmsPageURI::Display |
Формирует URI страницы $settings - аргумент из массива значений. $settings['page'] - ID обрабатываемой страницы. По умолчанию обрабатывает текущую страницу. Необязательный параметр. $settings['frame'] - определяет обрамление URI слэшами. По умолчанию обрамляет. Значение 0 убирает обрамление. Необязательный параметр. $settings['uri'] - по умолчанию выводит полный URI. Необязательный параметр. $settings['uri'] = 'prefix' - возвращает URI родительских страниц при включенном параметре "Префикс для URI страниц каталога". $settings$settings['uri'] = 'prefix_nolang' - возвращает URI родительских страниц без языкового параметра. $settings['uri'] = 'translit' - возвращает Транслит конкретной страницы. $settings['uri'] = 'nolang' - возвращает URI страницы без языкового параметра. Пример: cmsPageURI::Display([ 'page' => 100, 'frame' => 0, 'uri' => 'translit' ]); | |
| cmsNavigation::Display |
Выводит "хлебную крошку" на сайте относительно текущей страницы. Навигация основана на месте страницы в каталоге. $display_type = тип отображения "хлебной крошки": 0 - не выводит текущую страницу, 1 - выводит текущую страницу. Необязательный элемент. | |
| cmsCache::Check |
Проверка наличия кэша фрагмента. $cache_name = имя кэшируемого фрагмента. Необязательный параметр. | |
| cmsCache::Header | Начало кэширования фрагмента. | |
| cmsCache::Footer |
Конец кэширования фрагмента. $cache_name = имя кэшируемого фрагмента. Необязательный параметр. | |
| cmsCache::Display |
Вывод кэшированного фрагмента. $cache_name = имя кэшируемого фрагмента. Необязательный параметр. | |
| cmsPageCounter::Update |
Запись просмотра конкретной страницы. $page_id - ID страницы. Необязательный параметр. | |
| cmsPageCounter::Display |
Вывод количества просмотров конкретной страницы. $page_id - ID страницы. Необязательный параметр. | |
| cmsLang::Display |
Возвращает язык страницы в формате ISO 639-1. $settings - принимает параметр 'index' для метода Display, вывод язык сайта по умолчанию. По умолчанию обрабатывает язык текущей страницы. Необязательный параметр. Пример: cmsLang::Display( 'index' ); | |
| cmsLang::Content |
Выводит контент для конкретной языковой версии. $array - аргумент метода Content в виде массива, выводящий контент в зависимости от языковой версии. Обязательный параметр. Пример: cmsLang::Content([ 'ru' => 'Русский', 'en' => 'English' ]); |
Основные переменные страницы
| Наименование | Назначение | Код |
|---|---|---|
| id | Уникальный идентификатор страницы. Используется в шаблонах страниц, шаблонах каталога, шаблонах навигации, динамических блоках. | |
| date_time | Дата создания страницы. Используется в шаблонах страниц, шаблонах каталога, динамических блоках. | |
| date_time_update | Дата последнего обновления страницы. Используется в шаблонах страниц, шаблонах каталога, динамических блоках. | |
| title | Заголовок. Используется в шаблонах страниц, шаблонах каталога, шаблонах навигации, динамических блоках. | |
| tip | Подзаголовок. Используется в шаблонах страниц, шаблонах каталога, шаблонах навигации, динамических блоках. | |
| demo | Описание. Используется в шаблонах страниц, шаблонах каталога, динамических блоках. | |
| text | Текст. Используется в шаблонах страниц, шаблонах каталога, динамических блоках. | |
| tags | Теги. Используется в шаблонах страниц, шаблонах каталога, динамических блоках. | |
| translit | Транслит. Используется в заголовках, шаблонах страниц, шаблонах каталога, шаблонах навигации, динамических блоках. | |
| hide | Статус видимости страницы. Булево значение: 0 или 1. |