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

Классы и методы

Ядро системы состоит из функций, событий и следующих классов:

Класс Описание С версии
CMain Основной класс. 3.0.3
CDatabase Класс для работы с базой данной. 3.0.7
CDBResult Класс результата выполнения запроса. 3.0.7
CAgent Класс для работы с агентами. 3.0.14
CEvent Класс для отправки почтовых событий. 3.0.3
CEventMessage Класс для работы с шаблонами почтовых событий. 3.0.3
CEventType Класс для работы с типами почтовых событий. 3.0.3
CFile Класс для работы с файлами и изображениями. 3.0.3
CUser Класс для работы с пользователями. 3.0.6
CGroup Класс для работы с группами пользователей. 3.0.6
CSite Класс для работы с сайтами. 3.3.21
CLanguage Класс для работы с языками. 3.3.21
CMainPage Класс для использования на индексной странице портала. 4.0.3
CMenu Обработка меню. 3.0.16
CModule Управление модулями. 3.0.1
COption Класс для работы с параметрами модулей. 3.0.7
CPageOption Класс для работы с параметрами действующими только на странице. 3.3.6
CPageCache Класс для кеширования HTML. 3.1.8
CPHPCache Класс для кеширования PHP переменных и HTML. 3.2.7
CAdminFileDialog Класс для работы с файловым диалогом в административной части системы. 6.0.2
CComponentEngine Класс инкапсулирует вспомогательные методы. 5.1.7
CDiskQuota Класс для работы с дисковыми квотами. 6.5.0
CUserTypeEntity Класс для работы с пользовательскими полями. 6.0.2
CAdminPage 5.0.0
CApplicationException Класс для работы с исключениями. 4.0.6
CBitrixComponent Класс - оболочка компонента. 5.1.8
CBitrixComponentTemplate Класс - оболочка шаблона компонента. 5.1.8
CRatings Класс для работы с рейтингами. 9.5.0
CUserFieldEnumКласс для работы с пользовательскими полями типа "список".6.0.2
CUserCounterКласс предназначен для работы с счётчиками.11.5.2
CBXSanitizerКласс для очистки введённого пользователем HTML - текста от тэгов и атрибутов которые не содержатся в "белом списке" разрешенных к использованию.11.5.2
CAdminNotifyКласс для работы с уведомлениями.11.5.6
CBXVirtualIoКласс для работы с файлами публичной части.11.0.1
CBXVirtualFileКласс файла публичной части.11.0.1
CBXVirtualDirectoryКласс папки публичной части.11.0.1
CSmileКласс для работы со смайлами.12.5.7
CSmileSet Класс для работы с пакетами смайлов.12.5.7
CSmileGallery Класс для работы с галереями смайлов.12.5.7
CEventLog Класс для работы с логом.7.0.1

Важно! В параметрах классов есть LID. Он имеет разное значение, если используется в административной или публичной части. В административной части LID - это идентификатор языка, в публичной части LID - это идентификатор сайта.



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

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

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

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

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

Код
CJSCore::Init('jquery');

подключает на страницу jquery
5
Evgenius
Также бывают полезны следующие классы:
Код
class CUtil
{
   function addslashes($s);
   function JSEscape($s);
   function JSUrlEscape($s);
   function PhpToJSObject($arData);
   function JsObjectToPhp($data);
   function JSPostUnescape();
   function decodeURIComponent(&$item);
   function DetectUTF8($url, $bBinary=false);
}

class CHTTP
{
   var $url = '';
    var $status = 0;
   var $result = '';
   var $headers = array();
   var $cookies = array();

   var $http_timeout = 120;

   var $user_agent;

   var $follow_redirect = false;
   var $errno;
   var $errstr;

   function CHTTP();
   function Get($url);
   function Post($url, $arPostData);
   function HTTPQuery($method, $url, $postdata = '');
   function Query($method, $host, $port, $path, $postdata = false, $proto = '', $post_content_type = 'N');
   function ParseURL($url, $arUrlOld = false);
   function ParseHeaders($strHeaders);
   function setFollowRedirect($follow);
   /*public static*/
   function sGet($url, $follow_redirect = false);
   /*public static*/
   function sPost($url, $arPostData, $follow_redirect = false);
   /*public static*/
   function SetStatus($status);
}
© «Битрикс», 2001-2018, «1С-Битрикс», 2018
Наверх