Класс CMain

CMain - главный класс страницы.

При создании каждой страницы создаётся глобальный объект этого класса с именем $APPLICATION.

Методы класса:

Заголовок страницы

Метод	Описание	С версии
ShowTitle	Отображает заголовок страницы.	3.3.21
GetTitle	Возвращает заголовок страницы.
SetTitle	Устанавливает заголовок страницы.

CSS стили

Метод	Описание	С версии
ShowCSS	Отображает HTML для подключения CSS на странице.	3.3.22
GetCSS	Возвращает HTML для подключения CSS на странице.	3.3.22
SetTemplateCSS	Устанавливает путь к файлу с CSS стилями компонента.	3.3.22
SetAdditionalCSS	Устанавливает путь к файлу с CSS стилями.

Навигационная цепочка

Метод	Описание	С версии
ShowNavChain	Отображает HTML с навигационной цепочкой.	3.3.21
GetNavChain	Возвращает HTML с навигационной цепочкой.
AddChainItem	Добавляет пункт в конец навигационной цепочки.

Метод	Описание	С версии
GetMenu	Возвращает объект CMenu для текущей папки.
GetMenuHtml	Возвращает строку с меню типа type для текущей папки в виде HTML.
GetMenuHtmlEx	Аналог GetMenuHtml с применением другого типа шаблона меню.	3.3.7

Свойства страниц и разделов

Метод	Описание	С версии
ShowProperty	Отображает свойство страницы, учитывая свойства раздела.	4.0.6
GetProperty	Возвращает свойство страницы, учитывая свойства раздела.	3.3.12
GetPageProperty	Возвращает свойство страницы.	3.3.12
GetDirProperty	Возвращает свойство раздела.	3.3.12
GetPagePropertyList	Возвращает массив всех свойств страницы.	3.3.12
GetDirPropertyList	Возвращает массив всех свойств раздела.	3.3.12
SetPageProperty	Устанавливает свойство страницы.	3.3.12
SetDirProperty	Устанавливает свойство раздела.	3.3.12
ShowMeta	Отображает свойство раздела/страницы обрамленное тегом <meta>.	3.3.21
GetMeta	Возвращает свойство раздела/страницы обрамленное тегом <meta>.	3.3.12

Файлы

Метод	Описание	С версии
SaveFileContent	Сохраняет страницу на диске.
GetFileContent	Возвращает содержимое файла.
GetFileRecursive	Ищет файл с заданным именем последовательно вверх по иерархии каталогов.
GetFileAccessPermission	Определяет права доступа к файлу или каталогу.
SetFileAccessPermission	Устанавливает права доступа к файлу или каталогу.
CopyFileAccessPermission	Копирует права доступа одного файла (каталога) другому файлу (каталогу).
RemoveFileAccessPermission	Удаляет права доступа для файла или каталогу.

Права доступа и роли

Метод	Описание	С версии
GetUserRight	Возвращает максимальное право пользователя на тот или иной модуль.	3.3.18
GetUserRoles	Возвращает массив ролей пользователя в том или ином модуле.	3.3.18

Текущий адрес страницы

Метод	Описание	С версии
GetCurUri	Возвращает адрес текущей страницы с параметрами.	3.3.4
GetCurPage	Возвращает адрес текущей страницы без параметров.
GetCurPageParam	Возвращает URL текущей страницы c добавленными новыми и(или) удаленными параметрами.
GetCurDir	Возвращает раздел текущей страницы.
SetCurPage	Устанавливает адрес текущей страницы.	3.3.0

Панель управления

Метод	Описание	С версии
ShowPanel	Отображает HTML представляющий из себя панель управления публичной частью.	3.3.21
GetPanel	Возвращает HTML представляющий из себя панель управления публичной частью.	3.0.14
AddPanelButton	Добавляет кнопку в панель управления публичной частью.	3.0.14
GetPublicShowMode	Метод возвращает текущий режим отображения административной панели.	6.5.5

JS и тег head

Метод	Описание	С версии
AddHeadScript	Подключает java скрипты в шаблоне сайта и в шаблоне компонентов.	6.5.0
AddHeadString	Метод добавляет строку в секцию <head>…</head> сайта..	5.9.0
ShowHead	Метод предназначена для вывода в шаблоне сайта основных полей тега <head>.	7.0.0
ShowHeadStrings	Отображает специальные стили, JavaScript либо произвольный html-код.	5.9.0

Куки (cookie)

Метод	Описание	С версии
set_cookie	Устанавливает значение cookie.	3.3.21
get_cookie	Возвращает значение cookie.	3.3.21
ShowSpreadCookieHTML	Отображает HTML позволяющий установить cookie пользователю.	3.3.21

Компоненты

Метод	Описание	С версии
IncludeFile	Подключает произвольные файлы и компоненты.	3.3.21
GetTemplatePath	Возвращает полный путь к файлу следуя алгоритму подключения компонент.	3.3.23
IncludeComponent	Метод подключает компонент 2.0.	5.1.7

Исключения

Метод	Описание	С версии
GetException	Метод возвращает объект класса CApplicationException, содержащий последнее исключение.	4.0.6
ThrowException	Метод фиксирует исключение msg c кодом id.	4.0.6
ResetException	Метод очищает последнее исключение.	4.0.6

Прочие методы

Метод	Описание	С версии
IncludeAdminFile	Подключает скрипт с административным прологом и эпилогом.
IncludeString	Выводит произвольную строку (HTML код) обрамленную рамкой, в правом верхнем углу которой выводятся заданные иконки.	3.3.21
GetShowIncludeAreas	Возвращает состояние кнопки "Показать включаемые области" на панели управления.	3.3.21
AddBufferContent	Позволяет создавать Отложенные функции.	3.3.21
ShowBanner	Подключает модуль "Реклама, баннеры" и если подключение успешно, выводит баннер.	3.3.22
GetSiteByDir	Определяет сайт по заданному каталогу и хосту.	3.3.21
AuthForm	Выводит форму авторизации.
IsHTTPS	Возвращает "true" если используемый текущий протокол - HTTPS.	3.3.21
AddViewContent	Указывает место вывода контента, который будет сформирован ниже.	9.5.2
ShowViewContent	Указывает контент, который выводится методом AddViewContent. Использование двух последних методов прежде всего позволяет избежать дублирование компонентов и лишних циклов.	9.5.2
ConvertCharset	Метод используется для конвертирования строк из разных кодировок	4.1.0
ConvertCharsetArray	Метод используется для конвертирования данных из разных кодировок	8.6.0
RestartWorkarea	Метод позволяет сбросить контент рабочей области публичной страницы сайта.	15.5.0

Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.

5 Нина Рудзинская 17.03.2013 14:52:06
И интересный метод $APPLICATION->GetPopupLinkвот отсюда http://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=43&LESSON_ID=3854

Наверх