Открытые статические члены
static	getRequestUri ()
static	getHttpHost ($host=null)
static	getDomains ()
static	getSpaPostfixByUri ($requestUri)
static	getSpaPostfix ()
static	getRealPrivateKey ($privateKey=null, $postfix=null)
static	getUserPrivateKey ()
static	setUserPrivateKey ($prefix, $expire=0)
static	deleteUserPrivateKey ()
static	isAjaxRequest ()
static	isAppCacheRequest ()
static	isCompositeRequest ()
static	isBitrixFolder ()
static	isSpaMode ()
static	gzdecode ($data)
static	getAjaxRandom ()
static	removeRandParam ()
static	convertUriToPath ($uri, $host=null, $privateKey=null)
static	removeIgnoredParams ($queryString)
static	isOn ()
static	isCompositeEnabled ()
static	getEnabledFilePath ()
static	getConfigFilePath ()
static	getSizeFilePath ()
static	setOptions ($arOptions=array())
static	makeDirPath ($path)
static	escapePHPString ($str)
static	getOptions ()
static	resetOptions ()
static	compileOptions (&$arOptions)
static	getCacheFileSize ()
static	updateCacheFileSize ($bytes=0.0)
static	readStatistic ()
static	writeStatistic ($hits=0, $writings=0, $quota=0, $posts=0, $files=0.0)
static	checkQuota ($requiredFreeSpace=0)
static	updateQuota ($bytes)
static	__callStatic ($name, $arguments)
static	getDomainName ($url)
static	setEnabled ($status, $setDefaults=true)
static	cleanAll ()

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

См. определение в файле helper.php строка 12

Методы

◆ __callStatic()

__callStatic	(		$name,
			$arguments )

static

См. определение в файле helper.php строка 823

◆ checkQuota()

checkQuota ( $requiredFreeSpace = 0 )

static

Checks disk quota. Returns true if quota is not exceeded.

Аргументы

int $requiredFreeSpace

Возвращает: bool

См. определение в файле helper.php строка 795

◆ cleanAll()

cleanAll ( )

static

См. определение в файле helper.php строка 884

◆ compileOptions()

compileOptions ( & $arOptions )

static

См. определение в файле helper.php строка 581

◆ convertUriToPath()

convertUriToPath	(	$uri,
		$host = null,
		$privateKey = null )

static

Converts URI to a cache key (file path) / => /index.html /index.php => /index.html /aa/bb/ => /aa/bb/index.html /aa/bb/index.php => /aa/bb/index.html /?a=b&b=c => /index=b&b=c.html

Аргументы

string	$uri
string	$host
string	$privateKey

Возвращает: string

См. определение в файле helper.php строка 287

◆ deleteUserPrivateKey()

deleteUserPrivateKey ( )

static

См. определение в файле helper.php строка 126

◆ escapePHPString()

escapePHPString ( $str )

static

См. определение в файле helper.php строка 493

◆ getAjaxRandom()

getAjaxRandom ( )

static

Returns bxrand value

Возвращает: string|false

См. определение в файле helper.php строка 223

◆ getCacheFileSize()

getCacheFileSize ( )

static

Returns the number of bytes of file cache. If file .size doesn't exist returns false

Возвращает: bool|float

См. определение в файле helper.php строка 675

◆ getConfigFilePath()

getConfigFilePath ( )

static

См. определение в файле helper.php строка 375

◆ getDomainName()

getDomainName ( $url )

static

Аргументы

$url

Возвращает: mixed|string

См. определение в файле helper.php строка 839

◆ getDomains()

getDomains ( )

static

Returns valid domains from the composite options

Возвращает: array

См. определение в файле helper.php строка 50

◆ getEnabledFilePath()

getEnabledFilePath ( )

static

См. определение в файле helper.php строка 370

◆ getHttpHost()

getHttpHost ( $host = null )

static

Returns HTTP hostname

Аргументы

string $host

Возвращает: string

См. определение в файле helper.php строка 41

◆ getOptions()

getOptions ( )

static

Returns an array with cache options.

Возвращает: array

См. определение в файле helper.php строка 504

◆ getRealPrivateKey()

getRealPrivateKey	(		$privateKey = null,
			$postfix = null )

static

См. определение в файле helper.php строка 92

◆ getRequestUri()

getRequestUri ( )

static

Returns Request URI

Возвращает: string

См. определение в файле helper.php строка 22

◆ getSizeFilePath()

getSizeFilePath ( )

static

См. определение в файле helper.php строка 380

◆ getSpaPostfix()

getSpaPostfix ( )

static

См. определение в файле helper.php строка 81

◆ getSpaPostfixByUri()

getSpaPostfixByUri ( $requestUri )

static

См. определение в файле helper.php строка 62

◆ getUserPrivateKey()

getUserPrivateKey ( )

static

См. определение в файле helper.php строка 106

◆ gzdecode()

gzdecode ( $data )

static

Decodes a gzip compressed string

Аргументы

$data

Возвращает: string

См. определение в файле helper.php строка 202

◆ isAjaxRequest()

isAjaxRequest ( )

static

Returns true if the current request was initiated by Ajax.

Возвращает: bool

См. определение в файле helper.php строка 140

◆ isAppCacheRequest()

isAppCacheRequest ( )

static

См. определение в файле helper.php строка 152

◆ isBitrixFolder()

isBitrixFolder ( )

static

Returns true if the current request URI has bitrix folder

Возвращает: bool

См. определение в файле helper.php строка 171

◆ isCompositeEnabled()

isCompositeEnabled ( )

static

Return true if composite mode is enabled

Возвращает: bool

См. определение в файле helper.php строка 365

◆ isCompositeRequest()

isCompositeRequest ( )

static

См. определение в файле helper.php строка 159

◆ isOn()

isOn ( )

static

Return true if html cache is on

Возвращает: bool

См. определение в файле helper.php строка 356

◆ isSpaMode()

isSpaMode ( )

static

См. определение в файле helper.php строка 187

◆ makeDirPath()

makeDirPath ( $path )

static

См. определение в файле helper.php строка 466

◆ readStatistic()

readStatistic ( )

static

Returns array with cache statistics data. Returns an empty array in case of disabled html cache.

Возвращает: array

См. определение в файле helper.php строка 721

◆ removeIgnoredParams()

removeIgnoredParams ( $queryString )

static

См. определение в файле helper.php строка 318

◆ removeRandParam()

removeRandParam ( )

static

Removes bxrand parameter from the current request and returns its value

Возвращает: string|false

См. определение в файле helper.php строка 238

◆ resetOptions()

resetOptions ( )

static

См. определение в файле helper.php строка 537

◆ setEnabled()

setEnabled	(		$status,
			$setDefaults = true )

static

Аргументы

	$status
bool	$setDefaults

См. определение в файле helper.php строка 866

◆ setOptions()

setOptions ( $arOptions = array() )

static

Saves cache options

Аргументы

array $arOptions

Возвращает: void

См. определение в файле helper.php строка 392

◆ setUserPrivateKey()

setUserPrivateKey	(		$prefix,
			$expire = 0 )

static

См. определение в файле helper.php строка 117

◆ updateCacheFileSize()

updateCacheFileSize ( $bytes = 0.0 )

static

См. определение в файле helper.php строка 687

◆ updateQuota()

updateQuota ( $bytes )

static

Updates disk quota and cache statistic

Аргументы

float $bytes positive or negative value

См. определение в файле helper.php строка 811

◆ writeStatistic()

writeStatistic	(	$hits = 0,
		$writings = 0,
		$quota = 0,
		$posts = 0,
		$files = 0.0 )

static

Updates cache usage statistics. Each of parameters is added to appropriate existing stats.

Аргументы

integer \| false	$hits	Number of cache hits.
integer \| false	$writings	Number of cache writing.
integer \| false	$quota	Quota change in bytes.
integer \| false	$posts	Number of POST requests.
float \| false	$files	File size in bytes.

Возвращает: void

См. определение в файле helper.php строка 752

Объявления и описания членов класса находятся в файле:

C:/bitrix/modules/main/lib/composite/helper.php

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

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

Методы

◆ __callStatic()

◆ checkQuota()

◆ cleanAll()

◆ compileOptions()

◆ convertUriToPath()

◆ deleteUserPrivateKey()

◆ escapePHPString()

◆ getAjaxRandom()

◆ getCacheFileSize()

◆ getConfigFilePath()

◆ getDomainName()

◆ getDomains()

◆ getEnabledFilePath()

◆ getHttpHost()

◆ getOptions()

◆ getRealPrivateKey()

◆ getRequestUri()

◆ getSizeFilePath()

◆ getSpaPostfix()

◆ getSpaPostfixByUri()

◆ getUserPrivateKey()

◆ gzdecode()

◆ isAjaxRequest()

◆ isAppCacheRequest()

◆ isBitrixFolder()

◆ isCompositeEnabled()

◆ isCompositeRequest()

◆ isOn()

◆ isSpaMode()

◆ makeDirPath()

◆ readStatistic()

◆ removeIgnoredParams()

◆ removeRandParam()

◆ resetOptions()

◆ setEnabled()

◆ setOptions()

◆ setUserPrivateKey()

◆ updateCacheFileSize()

◆ updateQuota()

◆ writeStatistic()