Bitrix API

SiteTable extends DataManager

Class SiteTable

DO NOT WRITE ANYTHING BELOW THIS

<<< ORMENTITYANNOTATION

Table of Contents

Constants

ACTION_TYPE_ADD  = 'add'
For save callbacks.
ACTION_TYPE_UPDATE  = 'update'
For save callbacks.

Methods

checkBitrixUse()  : bool
Check 'bitrix'-named domain.
createCollection()  : EO_Site_Collection
createObject()  : EO_Site
getById()  : EO_Site_Result
getByPrimary()  : EO_Site_Result
getEntity()  : EO_Site_Entity
getList()  : Result
Get entity rows.
getMap()  : array<string|int, mixed>
Returns entity map definition.
getTableName()  : string
Returns DB table name for entity.
OnAfterAdd()  : EventResult
After add handler.
onAfterDelete()  : EventResult
After delete handler.
OnAfterUpdate()  : EventResult
After update handler.
OnBeforeAdd()  : EventResult
Before add handler.
OnBeforeDelete()  : EventResult
Before delete handler.
OnBeforeUpdate()  : EventResult
Before update handler.
query()  : EO_Site_Query
randomizeDomain()  : bool
Sets new random domain to site.
setAccessFilter()  : mixed
Set additional access filter.
switchDomain()  : bool
Switch domains between two sites. Returns true on success.
wakeUpCollection()  : EO_Site_Collection
wakeUpObject()  : EO_Site

Constants

ACTION_TYPE_ADD

For save callbacks.

public mixed ACTION_TYPE_ADD = 'add'

ACTION_TYPE_UPDATE

For save callbacks.

public mixed ACTION_TYPE_UPDATE = 'update'

Methods

checkBitrixUse()

Check 'bitrix'-named domain.

public static checkBitrixUse(string $domainName) : bool
Parameters
$domainName : string

Domain name.

Return values
bool

createCollection()

public static createCollection() : EO_Site_Collection
Return values
EO_Site_Collection

createObject()

public static createObject([mixed $setDefaultValues = = 'true' ]) : EO_Site
Parameters
$setDefaultValues : mixed = = 'true'
Return values
EO_Site

getById()

public static getById(mixed $id) : EO_Site_Result
Parameters
$id : mixed
Return values
EO_Site_Result

getByPrimary()

public static getByPrimary(mixed $primary[, array<string|int, mixed> $parameters = = '[]' ]) : EO_Site_Result
Parameters
$primary : mixed
$parameters : array<string|int, mixed> = = '[]'
Return values
EO_Site_Result

getEntity()

public static getEntity() : EO_Site_Entity
Return values
EO_Site_Entity

getList()

Get entity rows.

public static getList([array<string|int, mixed> $params = array() ]) : Result
Parameters
$params : array<string|int, mixed> = array()

Params array.

Return values
Result

getMap()

Returns entity map definition.

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

getTableName()

Returns DB table name for entity.

public static getTableName() : string
Return values
string

OnAfterAdd()

After add handler.

public static OnAfterAdd(Event $event) : EventResult
Parameters
$event : Event

Event instance.

Return values
EventResult

onAfterDelete()

After delete handler.

public static onAfterDelete(Event $event) : EventResult
Parameters
$event : Event

Event instance.

Return values
EventResult

OnAfterUpdate()

After update handler.

public static OnAfterUpdate(Event $event) : EventResult
Parameters
$event : Event

Event instance.

Return values
EventResult

OnBeforeAdd()

Before add handler.

public static OnBeforeAdd(Event $event) : EventResult
Parameters
$event : Event

Event instance.

Return values
EventResult

OnBeforeDelete()

Before delete handler.

public static OnBeforeDelete(Event $event) : EventResult
Parameters
$event : Event

Event instance.

Return values
EventResult

OnBeforeUpdate()

Before update handler.

public static OnBeforeUpdate(Event $event) : EventResult
Parameters
$event : Event

Event instance.

Return values
EventResult

query()

public static query() : EO_Site_Query
Return values
EO_Site_Query

randomizeDomain()

Sets new random domain to site.

public static randomizeDomain(int $siteId) : bool
Parameters
$siteId : int

Site id.

Return values
bool

setAccessFilter()

Set additional access filter.

public static setAccessFilter(mixed $params) : mixed
Parameters
$params : mixed

ORM params.

switchDomain()

Switch domains between two sites. Returns true on success.

public static switchDomain(int $siteId1, int $siteId2) : bool
Parameters
$siteId1 : int

First site id.

$siteId2 : int

Second site id.

Return values
bool

wakeUpCollection()

public static wakeUpCollection(mixed $rows) : EO_Site_Collection
Parameters
$rows : mixed
Return values
EO_Site_Collection

wakeUpObject()

public static wakeUpObject(mixed $row) : EO_Site
Parameters
$row : mixed
Return values
EO_Site 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results