Bitrix API

Tour extends Spotlight

Table of Contents

Constants

CATEGORY_NAME  = "tour"
USER_TYPE_ALL  = "ALL"
USER_TYPE_NEW  = "NEW"
USER_TYPE_OLD  = "OLD"

Methods

__construct()  : mixed
Spotlight constructor.
activate()  : mixed
deactivate()  : mixed
getActivationDate()  : mixed
getEndDate()  : int|null
getId()  : string
getLifetime()  : int
getStartDate()  : int|null
getUserTimeSpan()  : int
getUserType()  : string
getUserTypes()  : mixed
getViewDate()  : mixed
isAvailable()  : bool
isViewed()  : mixed
setEndDate()  : mixed
setLifetime()  : mixed
setStartDate()  : mixed
setUserTimeSpan()  : mixed
setUserType()  : mixed
setViewDate()  : mixed
unsetViewDate()  : mixed

Constants

CATEGORY_NAME

public mixed CATEGORY_NAME = "tour"

USER_TYPE_ALL

public mixed USER_TYPE_ALL = "ALL"

USER_TYPE_NEW

public mixed USER_TYPE_NEW = "NEW"

USER_TYPE_OLD

public mixed USER_TYPE_OLD = "OLD"

Methods

__construct()

Spotlight constructor.

public __construct(string $id) : mixed
Parameters
$id : string

Unique identifier

Tags
throws
ArgumentTypeException

activate()

public activate([mixed $activationDate = false ]) : mixed
Parameters
$activationDate : mixed = false

getActivationDate()

public getActivationDate() : mixed

getEndDate()

public getEndDate() : int|null
Return values
int|null

getId()

public getId() : string
Return values
string

getLifetime()

public getLifetime() : int
Return values
int

getStartDate()

public getStartDate() : int|null
Return values
int|null

getUserTimeSpan()

public getUserTimeSpan() : int
Return values
int

getUserType()

public getUserType() : string
Return values
string

getUserTypes()

public static getUserTypes() : mixed

getViewDate()

public getViewDate(mixed $userId) : mixed
Parameters
$userId : mixed

isAvailable()

public isAvailable([bool $userId = false ]) : bool
Parameters
$userId : bool = false
Return values
bool

isViewed()

public isViewed(mixed $userId) : mixed
Parameters
$userId : mixed

setEndDate()

public setEndDate(int|null $endDate) : mixed
Parameters
$endDate : int|null

setLifetime()

public setLifetime(int $lifetime) : mixed
Parameters
$lifetime : int

setStartDate()

public setStartDate(int|null $startDate) : mixed
Parameters
$startDate : int|null

setUserTimeSpan()

public setUserTimeSpan(int $userTimeSpan) : mixed
Parameters
$userTimeSpan : int

setUserType()

public setUserType(string $userType) : mixed
Parameters
$userType : string

setViewDate()

public setViewDate(mixed $userId[, mixed $date = false ]) : mixed
Parameters
$userId : mixed
$date : mixed = false

unsetViewDate()

public unsetViewDate(mixed $userId) : mixed
Parameters
$userId : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results