Bitrix API

CAllMain

AbstractYes

Table of Contents

Properties

$__view  : mixed
$_menu_recalc_counter  : mixed
$aCachedComponents  : mixed
$arAdditionalChain  : mixed
$arAuthResult  : mixed
$arComponentMatch  : array<string|int, mixed>
$arDirProperties  : mixed
$arHeadAdditionalCSS  : mixed
Additional css, js and inline strings. Need to include in specifik place.
$arHeadAdditionalScripts  : mixed
$arHeadAdditionalStrings  : mixed
$arHeadScripts  : mixed
$arHeadStrings  : mixed
$arIncludeDebug  : mixed
$arPageProperties  : mixed
$arPagePropertiesChanger  : mixed
$arPanelButtons  : mixed
$arPanelFutureButtons  : mixed
$auto_buffer_cleaned  : mixed
$bInAjax  : mixed
$buffer_content  : mixed
$buffer_content_type  : mixed
$buffer_man  : mixed
$buffer_manual  : mixed
$buffered  : mixed
$editArea  : CEditArea
$ERROR_STACK  : mixed
$FILE_PERMISSION_CACHE  : mixed
$LAST_ERROR  : CApplicationException
$ma  : mixed
$oAsset  : Asset
$PanelShowed  : mixed
$sDirPath  : mixed
$sDocPath2  : mixed
$sDocTitle  : mixed
$sDocTitleChanger  : mixed
$ShowIncludeStat  : mixed
$ShowPanel  : mixed
$showPanelWasInvoked  : mixed
$sPath2css  : mixed
Array of css, js, and inline strings
$version  : mixed

Methods

__construct()  : mixed
__GetConditionFName()  : mixed
_mkchain()  : mixed
_ReplaceNonLatin()  : mixed
AddAdditionalJS()  : mixed
AddBufferContent()  : mixed
AddChainItem()  : mixed
AddCSSKernelInfo()  : mixed
AddHeadScript()  : mixed
AddHeadString()  : mixed
AddJSKernelInfo()  : mixed
AddLangJS()  : mixed
AddPanelButton()  : mixed
AddPanelButtonMenu()  : mixed
AddViewContent()  : mixed
AuthForm()  : mixed
CaptchaCheckCode()  : mixed
CaptchaGetCode()  : mixed
clearViewContent()  : void
Clears vew content area by code.
ConvertCharset()  : mixed
ConvertCharsetArray()  : mixed
CopyFileAccessPermission()  : mixed
DelGroupRight()  : mixed
EndBufferContent()  : mixed
EndBufferContentMan()  : mixed
EpilogActions()  : mixed
FinalActions()  : void
Sends the response and terminates the application.
ForkActions()  : bool|null
get_cookie()  : mixed
GetAdditionalCSS()  : mixed
getComponentStack()  : array<string|int, mixed>
Returns a current component stack.
GetCookieDomain()  : string
GetCSS()  : mixed
GetCSSArray()  : mixed
GetCurDir()  : mixed
GetCurPage()  : mixed
GetCurPageParam()  : mixed
GetCurParam()  : mixed
getCurrentIncludedComponent()  : bool|CBitrixComponent
Returns false or instance of current component being executed.
GetCurUri()  : mixed
GetDefaultRightList()  : mixed
GetDirProperty()  : mixed
GetDirPropertyList()  : mixed
GetException()  : mixed
GetFileAccessPermission()  : mixed
GetFileAccessPermissionByUser()  : mixed
GetFileContent()  : mixed
GetFileRecursive()  : mixed
GetGroupRight()  : mixed
GetGroupRightList()  : mixed
GetHeadScripts()  : mixed
GetHeadStrings()  : mixed
GetLang()  : mixed
GetLangSwitcherArray()  : mixed
GetLink()  : mixed
GetMainRightList()  : mixed
GetMenu()  : mixed
GetMenuHtml()  : mixed
GetMenuHtmlEx()  : mixed
GetMeta()  : mixed
GetNavChain()  : mixed
GetPageProperty()  : mixed
GetPagePropertyList()  : mixed
GetPanel()  : mixed
GetPopupLink()  : mixed
GetProperty()  : mixed
GetPublicShowMode()  : mixed
GetServerUniqID()  : mixed
GetShowIncludeAreas()  : mixed
GetSiteByDir()  : mixed
GetSiteSwitcherArray()  : mixed
GetSpreadCookieHTML()  : mixed
GetSpreadCookieUrls()  : array<string|int, mixed>
Returns array of urls which contain signed cross domain cookies.
GetTemplatePath()  : mixed
GetTitle()  : mixed
GetUserRight()  : mixed
Returns an array of rights for a module W - max rights (admin) D - min rights (access denied)
GetUserRightArray()  : mixed
GetUserRoles()  : mixed
GetViewContent()  : mixed
GroupModuleCSS()  : mixed
GroupModuleJS()  : mixed
HoldSpreadCookieHTML()  : mixed
IncludeAdminFile()  : mixed
IncludeComponent()  : mixed
IncludeFile()  : mixed
IncludeString()  : mixed
IncludeStringAfter()  : mixed
IncludeStringBefore()  : mixed
InitDirProperties()  : mixed
InitPathVars()  : mixed
IsExternalLink()  : mixed
IsHTTPS()  : bool
LPAComponentChecker()  : mixed
MoveJSToBody()  : mixed
NeedCAPTHA()  : bool
NeedCAPTHAForLogin()  : mixed
OnChangeFileComponent()  : mixed
PrintHKGlobalUrlVar()  : mixed
ProcessLPA()  : mixed
PrologActions()  : mixed
RemoveFileAccessPermission()  : mixed
ResetException()  : mixed
RestartBuffer()  : mixed
RestartWorkarea()  : mixed
SaveFileContent()  : mixed
set_cookie()  : mixed
Sets a cookie and spreads it through domains.
SetAdditionalCSS()  : mixed
SetAuthResult()  : mixed
SetCurPage()  : mixed
SetDirProperty()  : mixed
SetEditArea()  : mixed
SetFileAccessPermission()  : mixed
SetGroupRight()  : mixed
SetNeedCAPTHA()  : mixed
SetPageProperty()  : mixed
SetPublicShowMode()  : mixed
SetShowIncludeAreas()  : mixed
SetTemplateCSS()  : mixed
SetTitle()  : mixed
SetUniqueCSS()  : mixed
SetUniqueJS()  : mixed
ShowAjaxHead()  : mixed
ShowAuthForm()  : mixed
ShowBanner()  : mixed
ShowBodyScripts()  : mixed
ShowCSS()  : mixed
ShowFileSelectDialog()  : mixed
ShowHead()  : mixed
ShowHeadScripts()  : mixed
ShowHeadStrings()  : mixed
ShowLink()  : mixed
ShowMeta()  : mixed
ShowNavChain()  : mixed
ShowNavChainEx()  : mixed
ShowPanel()  : mixed
ShowProperty()  : mixed
ShowSpreadCookieHTML()  : mixed
ShowTitle()  : mixed
ShowViewContent()  : mixed
StoreCookies()  : mixed
ThrowException()  : mixed
UnJSEscape()  : mixed

Properties

$__view

public mixed $__view = []

$_menu_recalc_counter

public mixed $_menu_recalc_counter = 0

$aCachedComponents

public mixed $aCachedComponents = []

$arAdditionalChain

public mixed $arAdditionalChain = []

$arAuthResult

public mixed $arAuthResult

$arComponentMatch

public array<string|int, mixed> $arComponentMatch = \false

$arDirProperties

public mixed $arDirProperties = []

$arHeadAdditionalCSS

Additional css, js and inline strings. Need to include in specifik place.

public mixed $arHeadAdditionalCSS = []

$arHeadAdditionalScripts

public mixed $arHeadAdditionalScripts = []

$arHeadAdditionalStrings

public mixed $arHeadAdditionalStrings = []

$arHeadScripts

public mixed $arHeadScripts = []

$arHeadStrings

public mixed $arHeadStrings = []

$arIncludeDebug

public mixed $arIncludeDebug = []

$arPageProperties

public mixed $arPageProperties = []

$arPagePropertiesChanger

public mixed $arPagePropertiesChanger = []

$arPanelButtons

public mixed $arPanelButtons = []

$arPanelFutureButtons

public mixed $arPanelFutureButtons = []

$auto_buffer_cleaned

public mixed $auto_buffer_cleaned

$bInAjax

public mixed $bInAjax = \false

$buffer_content

public mixed $buffer_content = []

$buffer_content_type

public mixed $buffer_content_type = []

$buffer_man

public mixed $buffer_man = \false

$buffer_manual

public mixed $buffer_manual = \false

$buffered

public mixed $buffered = \false

$editArea

public CEditArea $editArea = \false

$ERROR_STACK

public mixed $ERROR_STACK = []

$FILE_PERMISSION_CACHE

public mixed $FILE_PERMISSION_CACHE = []

$oAsset

public Asset $oAsset

$PanelShowed

public mixed $PanelShowed = \false

$sDirPath

public mixed $sDirPath

$sDocPath2

public mixed $sDocPath2

$sDocTitle

public mixed $sDocTitle

$sDocTitleChanger

public mixed $sDocTitleChanger = \null

$ShowIncludeStat

public mixed $ShowIncludeStat = \false

$ShowPanel

public mixed $ShowPanel = \null

$showPanelWasInvoked

public mixed $showPanelWasInvoked = \false

$sPath2css

Array of css, js, and inline strings

public mixed $sPath2css = []

$version

public mixed $version

Methods

__construct()

public __construct() : mixed

__GetConditionFName()

public static __GetConditionFName() : mixed

_mkchain()

public _mkchain(mixed $arChain, mixed $strChainTemplate[, mixed $bIncludeOnce = false ][, mixed $bShowIcons = true ]) : mixed
Parameters
$arChain : mixed
$strChainTemplate : mixed
$bIncludeOnce : mixed = false
$bShowIcons : mixed = true

_ReplaceNonLatin()

public static _ReplaceNonLatin(mixed $str) : mixed
Parameters
$str : mixed

AddAdditionalJS()

public AddAdditionalJS(mixed $content) : mixed

use Asset::getInstance()->addString($content, false, \Bitrix\Main\Page\AssetLocation::AFTER_JS, $mode)

Parameters
$content : mixed

AddBufferContent()

public AddBufferContent(mixed $callback) : mixed
Parameters
$callback : mixed

AddChainItem()

public AddChainItem(mixed $title[, mixed $link = "" ][, mixed $bUnQuote = true ]) : mixed
Parameters
$title : mixed
$link : mixed = ""
$bUnQuote : mixed = true

AddCSSKernelInfo()

public AddCSSKernelInfo([mixed $module = '' ][, mixed $arCSS = [] ]) : mixed

deprecated use Asset::addCssKernelInfo()

Parameters
$module : mixed = ''
$arCSS : mixed = []

AddHeadScript()

public AddHeadScript(mixed $src[, mixed $additional = false ]) : mixed

use Asset::getInstance()->addJs($src, $additional)

Parameters
$src : mixed
$additional : mixed = false

AddHeadString()

public AddHeadString(mixed $str[, mixed $bUnique = false ][, mixed $location = \AssetLocation::AFTER_JS_KERNEL ]) : mixed

$Asset::getInstance->addString($str, $bUnique, $location);

Parameters
$str : mixed
$bUnique : mixed = false
$location : mixed = \AssetLocation::AFTER_JS_KERNEL

AddJSKernelInfo()

public AddJSKernelInfo([mixed $module = '' ][, mixed $arJS = [] ]) : mixed

deprecated use Asset::addJsKernelInfo()

Parameters
$module : mixed = ''
$arJS : mixed = []

AddLangJS()

public AddLangJS(mixed $content) : mixed

use Asset::getInstance()->addBeforeJs($content)

Parameters
$content : mixed

AddPanelButton()

public AddPanelButton(mixed $arButton[, mixed $bReplace = false ]) : mixed
Parameters
$arButton : mixed
$bReplace : mixed = false

AddPanelButtonMenu()

public AddPanelButtonMenu(mixed $button_id, mixed $arMenuItem) : mixed
Parameters
$button_id : mixed
$arMenuItem : mixed

AddViewContent()

public AddViewContent(mixed $view, mixed $content[, mixed $pos = 500 ]) : mixed
Parameters
$view : mixed
$content : mixed
$pos : mixed = 500

AuthForm()

public AuthForm(mixed $mess[, mixed $show_prolog = true ][, mixed $show_epilog = true ][, mixed $not_show_links = "N" ][, mixed $do_die = true ]) : mixed
Parameters
$mess : mixed
$show_prolog : mixed = true
$show_epilog : mixed = true
$not_show_links : mixed = "N"
$do_die : mixed = true

CaptchaCheckCode()

public CaptchaCheckCode(mixed $captcha_word, mixed $captcha_sid) : mixed
Parameters
$captcha_word : mixed
$captcha_sid : mixed

CaptchaGetCode()

public CaptchaGetCode() : mixed

clearViewContent()

Clears vew content area by code.

public clearViewContent(string $view) : void
Parameters
$view : string

View content code.

ConvertCharset()

public ConvertCharset(mixed $string, mixed $charset_in, mixed $charset_out) : mixed

Use Main\Text\Encoding::convertEncoding()

Parameters
$string : mixed
$charset_in : mixed
$charset_out : mixed

ConvertCharsetArray()

public ConvertCharsetArray(mixed $arData, mixed $charset_from, mixed $charset_to) : mixed

Use Main\Text\Encoding::convertEncoding()

Parameters
$arData : mixed
$charset_from : mixed
$charset_to : mixed

CopyFileAccessPermission()

public CopyFileAccessPermission(mixed $path_from, mixed $path_to[, mixed $bOverWrite = false ]) : mixed
Parameters
$path_from : mixed
$path_to : mixed
$bOverWrite : mixed = false

DelGroupRight()

public static DelGroupRight([mixed $module_id = '' ][, mixed $arGroups = [] ][, mixed $site_id = false ]) : mixed
Parameters
$module_id : mixed = ''
$arGroups : mixed = []
$site_id : mixed = false

EndBufferContent()

public EndBufferContent([mixed $content = "" ]) : mixed
Parameters
$content : mixed = ""

EndBufferContentMan()

public & EndBufferContentMan() : mixed

EpilogActions()

public static EpilogActions() : mixed

Will be removed soon

FinalActions()

Sends the response and terminates the application.

public static FinalActions([string $output = "" ]) : void
Parameters
$output : string = ""

String to output before termination

ForkActions()

public static ForkActions([string|bool $func = false ][, array<string|int, mixed> $args = [] ]) : bool|null

Use \Bitrix\Main\Application::addBackgroundJob()

Parameters
$func : string|bool = false
$args : array<string|int, mixed> = []
Return values
bool|null
public get_cookie(mixed $name[, mixed $name_prefix = false ]) : mixed
Parameters
$name : mixed
$name_prefix : mixed = false

GetAdditionalCSS()

public GetAdditionalCSS() : mixed

getComponentStack()

Returns a current component stack.

public getComponentStack() : array<string|int, mixed>
Return values
array<string|int, mixed>

GetCookieDomain()

public GetCookieDomain() : string

Use \Bitrix\Main\Web\Cookie::getCookieDomain().

Return values
string

GetCSS()

public GetCSS([mixed $cMaxStylesCnt = true ][, mixed $bXhtmlStyle = true ][, mixed $assetTargetType = \Main\Page\AssetShowTargetType::ALL ]) : mixed

use Asset::getInstance()->getCss()

Parameters
$cMaxStylesCnt : mixed = true
$bXhtmlStyle : mixed = true
$assetTargetType : mixed = \Main\Page\AssetShowTargetType::ALL

GetCSSArray()

public GetCSSArray() : mixed

GetCurDir()

public GetCurDir() : mixed

GetCurPage()

public GetCurPage([mixed $get_index_page = null ]) : mixed
Parameters
$get_index_page : mixed = null

GetCurPageParam()

public GetCurPageParam([mixed $strParam = "" ][, mixed $arParamKill = [] ][, mixed $get_index_page = null ]) : mixed
Parameters
$strParam : mixed = ""
$arParamKill : mixed = []
$get_index_page : mixed = null

GetCurParam()

public GetCurParam() : mixed

getCurrentIncludedComponent()

Returns false or instance of current component being executed.

public getCurrentIncludedComponent() : bool|CBitrixComponent
Return values
bool|CBitrixComponent

GetCurUri()

public GetCurUri([mixed $addParam = "" ][, mixed $get_index_page = null ]) : mixed
Parameters
$addParam : mixed = ""
$get_index_page : mixed = null

GetDefaultRightList()

public static GetDefaultRightList() : mixed

GetDirProperty()

public GetDirProperty(mixed $PROPERTY_ID[, mixed $path = false ][, mixed $default_value = false ]) : mixed
Parameters
$PROPERTY_ID : mixed
$path : mixed = false
$default_value : mixed = false

GetDirPropertyList()

public GetDirPropertyList([mixed $path = false ]) : mixed
Parameters
$path : mixed = false

GetException()

public GetException() : mixed

GetFileAccessPermission()

public GetFileAccessPermission(mixed $path[, mixed $groups = false ][, mixed $task_mode = false ]) : mixed
Parameters
$path : mixed
$groups : mixed = false
$task_mode : mixed = false

GetFileAccessPermissionByUser()

public GetFileAccessPermissionByUser(mixed $userID, mixed $path[, mixed $groups = false ][, mixed $task_mode = false ]) : mixed

Not used, will be removed.

Parameters
$userID : mixed
$path : mixed
$groups : mixed = false
$task_mode : mixed = false

GetFileContent()

public GetFileContent(mixed $path) : mixed
Parameters
$path : mixed

GetFileRecursive()

public GetFileRecursive(mixed $strFileName[, mixed $strDir = false ]) : mixed
Parameters
$strFileName : mixed
$strDir : mixed = false

GetGroupRight()

public static GetGroupRight(mixed $module_id[, mixed $arGroups = false ][, mixed $use_default_level = "Y" ][, mixed $max_right_for_super_admin = "Y" ][, mixed $site_id = false ]) : mixed
Parameters
$module_id : mixed
$arGroups : mixed = false
$use_default_level : mixed = "Y"
$max_right_for_super_admin : mixed = "Y"
$site_id : mixed = false

GetGroupRightList()

public static GetGroupRightList(mixed $arFilter[, mixed $site_id = false ]) : mixed
Parameters
$arFilter : mixed
$site_id : mixed = false

GetHeadScripts()

public GetHeadScripts([mixed $type = 0 ]) : mixed

use Asset::getInstance()->getJs($type)

Parameters
$type : mixed = 0

GetHeadStrings()

public GetHeadStrings([mixed $location = \AssetLocation::AFTER_JS_KERNEL ]) : mixed
Parameters
$location : mixed = \AssetLocation::AFTER_JS_KERNEL

GetLang()

public GetLang() : mixed

GetLangSwitcherArray()

public GetLangSwitcherArray() : mixed
public GetLink(mixed $id[, mixed $rel = null ][, mixed $bXhtmlStyle = true ]) : mixed
Parameters
$id : mixed
$rel : mixed = null
$bXhtmlStyle : mixed = true

GetMainRightList()

public static GetMainRightList() : mixed

GetMenu()

public GetMenu([mixed $type = "left" ][, mixed $bMenuExt = false ][, mixed $template = false ][, mixed $sInitDir = false ]) : mixed
Parameters
$type : mixed = "left"
$bMenuExt : mixed = false
$template : mixed = false
$sInitDir : mixed = false

GetMenuHtml()

public GetMenuHtml([mixed $type = "left" ][, mixed $bMenuExt = false ][, mixed $template = false ][, mixed $sInitDir = false ]) : mixed
Parameters
$type : mixed = "left"
$bMenuExt : mixed = false
$template : mixed = false
$sInitDir : mixed = false

GetMenuHtmlEx()

public GetMenuHtmlEx([mixed $type = "left" ][, mixed $bMenuExt = false ][, mixed $template = false ][, mixed $sInitDir = false ]) : mixed
Parameters
$type : mixed = "left"
$bMenuExt : mixed = false
$template : mixed = false
$sInitDir : mixed = false

GetMeta()

public GetMeta(mixed $id[, mixed $meta_name = false ][, mixed $bXhtmlStyle = true ]) : mixed
Parameters
$id : mixed
$meta_name : mixed = false
$bXhtmlStyle : mixed = true

GetNavChain()

public GetNavChain([mixed $path = false ][, mixed $iNumFrom = 0 ][, mixed $sNavChainPath = false ][, mixed $bIncludeOnce = false ][, mixed $bShowIcons = true ]) : mixed
Parameters
$path : mixed = false
$iNumFrom : mixed = 0
$sNavChainPath : mixed = false
$bIncludeOnce : mixed = false
$bShowIcons : mixed = true

GetPageProperty()

public GetPageProperty(mixed $PROPERTY_ID[, mixed $default_value = false ]) : mixed
Parameters
$PROPERTY_ID : mixed
$default_value : mixed = false

GetPagePropertyList()

public GetPagePropertyList() : mixed

GetPanel()

public GetPanel() : mixed
public GetPopupLink(mixed $arUrl) : mixed
Parameters
$arUrl : mixed

GetProperty()

public GetProperty(mixed $PROPERTY_ID[, mixed $default_value = false ]) : mixed
Parameters
$PROPERTY_ID : mixed
$default_value : mixed = false

GetPublicShowMode()

public GetPublicShowMode() : mixed

GetServerUniqID()

public static GetServerUniqID() : mixed

GetShowIncludeAreas()

public GetShowIncludeAreas() : mixed

GetSiteByDir()

public GetSiteByDir() : mixed

GetSiteSwitcherArray()

public GetSiteSwitcherArray() : mixed

GetSpreadCookieHTML()

public GetSpreadCookieHTML() : mixed

GetSpreadCookieUrls()

Returns array of urls which contain signed cross domain cookies.

public GetSpreadCookieUrls() : array<string|int, mixed>
Return values
array<string|int, mixed>

GetTemplatePath()

public GetTemplatePath(mixed $rel_path) : mixed
Parameters
$rel_path : mixed

GetTitle()

public GetTitle([mixed $property_name = false ][, mixed $strip_tags = false ]) : mixed
Parameters
$property_name : mixed = false
$strip_tags : mixed = false

GetUserRight()

Returns an array of rights for a module W - max rights (admin) D - min rights (access denied)

public static GetUserRight(string $moduleId[, array<string|int, mixed>|bool $groups = false ][, string $use_default_level = 'Y' ][, string $max_right_for_super_admin = 'Y' ][, array<string|int, mixed>|bool $siteId = false ]) : mixed
Parameters
$moduleId : string
  • a module id
$groups : array<string|int, mixed>|bool = false
  • array of groups ID, if not set then for current useer
$use_default_level : string = 'Y'
  • "Y" - use default role
$max_right_for_super_admin : string = 'Y'
  • "Y" - for group ID=1 return max rights
$siteId : array<string|int, mixed>|bool = false

GetUserRightArray()

public static GetUserRightArray(mixed $moduleId, mixed $groups) : mixed
Parameters
$moduleId : mixed
$groups : mixed

GetUserRoles()

public static GetUserRoles(mixed $module_id[, mixed $arGroups = false ][, mixed $use_default_role = "Y" ][, mixed $max_role_for_super_admin = "Y" ][, mixed $site_id = false ]) : mixed
Parameters
$module_id : mixed
$arGroups : mixed = false
$use_default_role : mixed = "Y"
$max_role_for_super_admin : mixed = "Y"
$site_id : mixed = false

GetViewContent()

public GetViewContent(mixed $view) : mixed
Parameters
$view : mixed

GroupModuleCSS()

public GroupModuleCSS([mixed $from = '' ][, mixed $to = '' ]) : mixed

use Asset::getInstance()->groupCss($from, $to)

Parameters
$from : mixed = ''
$to : mixed = ''

GroupModuleJS()

public GroupModuleJS([mixed $from = '' ][, mixed $to = '' ]) : mixed

use Asset::getInstance()->groupJs($from, $to)

Parameters
$from : mixed = ''
$to : mixed = ''

HoldSpreadCookieHTML()

public HoldSpreadCookieHTML([mixed $bSet = false ]) : mixed
Parameters
$bSet : mixed = false

IncludeAdminFile()

public IncludeAdminFile(mixed $strTitle, mixed $filepath) : mixed
Parameters
$strTitle : mixed
$filepath : mixed

IncludeComponent()

public IncludeComponent(mixed $componentName, mixed $componentTemplate[, mixed $arParams = [] ][, mixed $parentComponent = null ][, mixed $arFunctionParams = [] ][, mixed $returnResult = false ]) : mixed
Parameters
$componentName : mixed
$componentTemplate : mixed
$arParams : mixed = []
$parentComponent : mixed = null
$arFunctionParams : mixed = []
$returnResult : mixed = false

IncludeFile()

public IncludeFile(mixed $rel_path[, mixed $arParams = [] ][, mixed $arFunctionParams = [] ]) : mixed
Parameters
$rel_path : mixed
$arParams : mixed = []
$arFunctionParams : mixed = []

IncludeString()

public IncludeString(mixed $string[, mixed $arIcons = false ]) : mixed
Parameters
$string : mixed
$arIcons : mixed = false

IncludeStringAfter()

public IncludeStringAfter([mixed $arIcons = false ][, mixed $arParams = [] ]) : mixed
Parameters
$arIcons : mixed = false
$arParams : mixed = []

IncludeStringBefore()

public IncludeStringBefore() : mixed

InitDirProperties()

public InitDirProperties(mixed $path) : mixed
Parameters
$path : mixed

InitPathVars()

public static InitPathVars(mixed &$site, mixed &$path) : mixed
Parameters
$site : mixed
$path : mixed
public static IsExternalLink(mixed $src) : mixed
Parameters
$src : mixed

IsHTTPS()

public static IsHTTPS() : bool

Use HttpRequest::isHttps()

Return values
bool

LPAComponentChecker()

public static LPAComponentChecker(mixed &$arParams, mixed &$arPHPparams[, mixed $parentParamName = false ]) : mixed

Use LPA::ComponentChecker()

Parameters
$arParams : mixed
$arPHPparams : mixed
$parentParamName : mixed = false

MoveJSToBody()

public MoveJSToBody([mixed $module = '' ]) : mixed

use Asset::getInstance()->moveJs($module)

Parameters
$module : mixed = ''

NeedCAPTHA()

public NeedCAPTHA() : bool
Return values
bool

NeedCAPTHAForLogin()

public NeedCAPTHAForLogin(mixed $login) : mixed
Parameters
$login : mixed

OnChangeFileComponent()

public static OnChangeFileComponent(mixed $path, mixed $site) : mixed
Parameters
$path : mixed
$site : mixed

PrintHKGlobalUrlVar()

public static PrintHKGlobalUrlVar() : mixed

ProcessLPA()

public static ProcessLPA([mixed $filesrc = false ][, mixed $old_filesrc = false ]) : mixed

Use LPA::Process()

Parameters
$filesrc : mixed = false
$old_filesrc : mixed = false

PrologActions()

public static PrologActions() : mixed

RemoveFileAccessPermission()

public RemoveFileAccessPermission(mixed $path[, mixed $arGroups = false ]) : mixed
Parameters
$path : mixed
$arGroups : mixed = false

ResetException()

public ResetException() : mixed

RestartBuffer()

public RestartBuffer() : mixed

RestartWorkarea()

public RestartWorkarea([mixed $start = false ]) : mixed
Parameters
$start : mixed = false

SaveFileContent()

public SaveFileContent(mixed $abs_path, mixed $strContent) : mixed
Parameters
$abs_path : mixed
$strContent : mixed

Sets a cookie and spreads it through domains.

public set_cookie(string $name, string $value[, bool|int $time = false ][, string $folder = "/" ][, bool|string $domain = false ][, bool $secure = false ][, bool|int $spread = true ][, bool $name_prefix = false ][, bool $httpOnly = false ]) : mixed

Use \Bitrix\Main\HttpResponse::addCookie().

Parameters
$name : string

Cookie name (without prefix)

$value : string

value

$time : bool|int = false

expire date

$folder : string = "/"

cookie dir

$domain : bool|string = false

cookie domain

$secure : bool = false

secure flag

$spread : bool|int = true

to spread or not to spread

$name_prefix : bool = false

name prefix (if not set get from options)

$httpOnly : bool = false

SetAdditionalCSS()

public SetAdditionalCSS(mixed $Path2css[, mixed $additional = false ]) : mixed
Parameters
$Path2css : mixed
$additional : mixed = false

SetAuthResult()

public SetAuthResult(mixed $arAuthResult) : mixed
Parameters
$arAuthResult : mixed

SetCurPage()

public SetCurPage(mixed $page) : mixed
Parameters
$page : mixed

SetDirProperty()

public SetDirProperty(mixed $PROPERTY_ID, mixed $PROPERTY_VALUE[, mixed $path = false ]) : mixed
Parameters
$PROPERTY_ID : mixed
$PROPERTY_VALUE : mixed
$path : mixed = false

SetEditArea()

public SetEditArea(mixed $areaId, mixed $arIcons) : mixed
Parameters
$areaId : mixed
$arIcons : mixed

SetFileAccessPermission()

public SetFileAccessPermission(mixed $path, mixed $arPermissions[, mixed $bOverWrite = true ]) : mixed
Parameters
$path : mixed
$arPermissions : mixed
$bOverWrite : mixed = true

SetGroupRight()

public static SetGroupRight(mixed $module_id, mixed $group_id, mixed $right[, mixed $site_id = false ]) : mixed
Parameters
$module_id : mixed
$group_id : mixed
$right : mixed
$site_id : mixed = false

SetNeedCAPTHA()

public SetNeedCAPTHA(bool $mode) : mixed
Parameters
$mode : bool

SetPageProperty()

public SetPageProperty(mixed $PROPERTY_ID, mixed $PROPERTY_VALUE[, mixed $arOptions = null ]) : mixed
Parameters
$PROPERTY_ID : mixed
$PROPERTY_VALUE : mixed
$arOptions : mixed = null

SetPublicShowMode()

public SetPublicShowMode(mixed $mode) : mixed
Parameters
$mode : mixed

SetShowIncludeAreas()

public SetShowIncludeAreas([mixed $bShow = true ]) : mixed
Parameters
$bShow : mixed = true

SetTemplateCSS()

public SetTemplateCSS(mixed $rel_path) : mixed
Parameters
$rel_path : mixed

SetTitle()

public SetTitle(mixed $title[, mixed $arOptions = null ]) : mixed
Parameters
$title : mixed
$arOptions : mixed = null

SetUniqueCSS()

public SetUniqueCSS([mixed $id = '' ][, mixed $cssType = 'page' ]) : mixed

use Asset::getInstance()->setUnique($type, $id)

Parameters
$id : mixed = ''
$cssType : mixed = 'page'

SetUniqueJS()

public SetUniqueJS() : mixed

ShowAjaxHead()

public ShowAjaxHead([mixed $bXhtmlStyle = true ][, mixed $showCSS = true ][, mixed $showStrings = true ][, mixed $showScripts = true ]) : mixed
Parameters
$bXhtmlStyle : mixed = true
$showCSS : mixed = true
$showStrings : mixed = true
$showScripts : mixed = true

ShowAuthForm()

public ShowAuthForm(mixed $message) : mixed
Parameters
$message : mixed

ShowBanner()

public static ShowBanner(mixed $type[, mixed $html_before = "" ][, mixed $html_after = "" ]) : mixed
Parameters
$type : mixed
$html_before : mixed = ""
$html_after : mixed = ""

ShowBodyScripts()

public ShowBodyScripts() : mixed

ShowCSS()

public ShowCSS([mixed $cMaxStylesCnt = true ][, mixed $bXhtmlStyle = true ]) : mixed
Parameters
$cMaxStylesCnt : mixed = true
$bXhtmlStyle : mixed = true

ShowFileSelectDialog()

public static ShowFileSelectDialog(mixed $event, mixed $arResultDest[, mixed $arPath = [] ][, mixed $fileFilter = "" ][, mixed $bAllowFolderSelect = false ]) : mixed

Use CAdminFileDialog::ShowScript instead

Parameters
$event : mixed
$arResultDest : mixed
$arPath : mixed = []
$fileFilter : mixed = ""
$bAllowFolderSelect : mixed = false

ShowHead()

public ShowHead([mixed $bXhtmlStyle = true ]) : mixed
Parameters
$bXhtmlStyle : mixed = true

ShowHeadScripts()

public ShowHeadScripts() : mixed

ShowHeadStrings()

public ShowHeadStrings() : mixed
public ShowLink(mixed $id[, mixed $rel = null ][, mixed $bXhtmlStyle = true ]) : mixed
Parameters
$id : mixed
$rel : mixed = null
$bXhtmlStyle : mixed = true

ShowMeta()

public ShowMeta(mixed $id[, mixed $meta_name = false ][, mixed $bXhtmlStyle = true ]) : mixed
Parameters
$id : mixed
$meta_name : mixed = false
$bXhtmlStyle : mixed = true

ShowNavChain()

public ShowNavChain([mixed $path = false ][, mixed $iNumFrom = 0 ][, mixed $sNavChainPath = false ]) : mixed
Parameters
$path : mixed = false
$iNumFrom : mixed = 0
$sNavChainPath : mixed = false

ShowNavChainEx()

public ShowNavChainEx([mixed $path = false ][, mixed $iNumFrom = 0 ][, mixed $sNavChainPath = false ]) : mixed
Parameters
$path : mixed = false
$iNumFrom : mixed = 0
$sNavChainPath : mixed = false

ShowPanel()

public ShowPanel() : mixed

ShowProperty()

public ShowProperty(mixed $PROPERTY_ID[, mixed $default_value = false ]) : mixed
Parameters
$PROPERTY_ID : mixed
$default_value : mixed = false

ShowSpreadCookieHTML()

public ShowSpreadCookieHTML() : mixed

ShowTitle()

public ShowTitle([mixed $property_name = "title" ][, mixed $strip_tags = true ]) : mixed
Parameters
$property_name : mixed = "title"
$strip_tags : mixed = true

ShowViewContent()

public ShowViewContent(mixed $view) : mixed
Parameters
$view : mixed

StoreCookies()

public StoreCookies() : mixed

ThrowException()

public ThrowException(mixed $msg[, mixed $id = false ]) : mixed
Parameters
$msg : mixed
$id : mixed = false

UnJSEscape()

public UnJSEscape(mixed $str) : mixed
Parameters
$str : mixed

        
On this page

Search results