Bitrix API

MemcachedResponse extends AbstractResponse

FinalYes

Represents interface for the html cache response Class AbstractResponse

Table of Contents

Constants

MEMCACHED_GZIP_FLAG  = 65536

Methods

__construct()  : mixed
close()  : mixed
Closes connection to the memcached server
exists()  : bool
Checks whether the cache exists
getConnection()  : Memcache|false
Returns the object that represents the connection to the memcached server
getContents()  : string|false
Returns the cache contents
getContentType()  : string|false
Returns the content type of the cache
getEtag()  : string|int
Returns the Entity Tag of the cache
getLastModified()  : int|false
Returns the time the cache was last modified
getProp()  : string|false
Returns the $property value
getProps()  : stdClass|false
Returns an array of the cache properties
isGzipped()  : bool
Returns true if content is gzipped
shouldCountQuota()  : bool
Should we count a quota limit

Constants

MEMCACHED_GZIP_FLAG

public mixed MEMCACHED_GZIP_FLAG = 65536

Methods

__construct()

public __construct(mixed $cacheKey, array<string|int, mixed> $configuration, array<string|int, mixed> $htmlCacheOptions) : mixed
Parameters
$cacheKey : mixed

unique cache identifier

$configuration : array<string|int, mixed>

storage configuration

$htmlCacheOptions : array<string|int, mixed>

html cache options

close()

Closes connection to the memcached server

public static close() : mixed

exists()

Checks whether the cache exists

public exists() : bool
Return values
bool

getConnection()

Returns the object that represents the connection to the memcached server

public static getConnection(array<string|int, mixed> $configuration, array<string|int, mixed> $htmlCacheOptions) : Memcache|false
Parameters
$configuration : array<string|int, mixed>

memcached configuration

$htmlCacheOptions : array<string|int, mixed>

html cache options

Return values
Memcache|false

getContents()

Returns the cache contents

public getContents() : string|false
Return values
string|false

getContentType()

Returns the content type of the cache

public getContentType() : string|false
Return values
string|false

getEtag()

Returns the Entity Tag of the cache

public getEtag() : string|int
Return values
string|int

getLastModified()

Returns the time the cache was last modified

public getLastModified() : int|false
Return values
int|false

getProp()

Returns the $property value

public getProp(string $property) : string|false
Parameters
$property : string

the property name

Return values
string|false

getProps()

Returns an array of the cache properties

public getProps() : stdClass|false
Return values
stdClass|false

isGzipped()

Returns true if content is gzipped

public isGzipped() : bool
Return values
bool

shouldCountQuota()

Should we count a quota limit

public shouldCountQuota() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results