Bitrix API

YandexBannerTable extends AdvEntity

Class YandexBannerTable

Local mirror for Yandex.Direct banners

Fields:

  • ID int mandatory
  • ENGINE_ID int mandatory
  • XML_ID string(255) mandatory
  • LAST_UPDATE datetime optional
  • SETTINGS string optional
  • CAMPAIGN_ID int mandatory
  • GROUP_ID int optional - Yandex.Direct supports groups only in Live version, so we add this entity but won't use it right now
  • AUTO_QUANTITY char(1) optional

Table of Contents

Constants

CACHE_LIFETIME  = 3600
ENGINE  = 'yandex_direct'
MARKED  = 'D'
MAX_TEXT_LENGTH  = 81
MAX_TITLE_LENGTH  = 35

Methods

createCollection()  : EO_YandexBanner_Collection
createObject()  : EO_YandexBanner
getById()  : EO_YandexBanner_Result
getByPrimary()  : EO_YandexBanner_Result
getEngine()  : YandexDirect|null
Returns link to transport engine object.
getEntity()  : EO_YandexBanner_Entity
getFilePath()  : string
Returns path to the file which contains definition of the class.
getList()  : EO_YandexBanner_Result
getMap()  : array<string|int, mixed>
Returns entity map definition.
getTableName()  : string
Returns DB table name for entity
markResumed()  : mixed
markStopped()  : mixed
onBeforeAdd()  : EventResult
Makes fields validation and adds new Yandex.Direct banner.
onBeforeUpdate()  : EventResult
Makes fields validation and updates Yandex.Direct banner.
onDelete()  : void
Deletes Yandex.Direct banner.
query()  : EO_YandexBanner_Query
unMarkResumed()  : mixed
unMarkStopped()  : mixed
wakeUpCollection()  : EO_YandexBanner_Collection
wakeUpObject()  : EO_YandexBanner

Constants

Methods

createCollection()

public static createCollection() : EO_YandexBanner_Collection
Return values
EO_YandexBanner_Collection

createObject()

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

getById()

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

getByPrimary()

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

getEntity()

public static getEntity() : EO_YandexBanner_Entity
Return values
EO_YandexBanner_Entity

getFilePath()

Returns path to the file which contains definition of the class.

public static getFilePath() : string
Return values
string

getList()

public static getList([array<string|int, mixed> $parameters = = '[]' ]) : EO_YandexBanner_Result
Parameters
$parameters : array<string|int, mixed> = = '[]'
Return values
EO_YandexBanner_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

markResumed()

public static markResumed(array<string|int, mixed> $idList) : mixed
Parameters
$idList : array<string|int, mixed>

markStopped()

public static markStopped(array<string|int, mixed> $idList) : mixed
Parameters
$idList : array<string|int, mixed>

onBeforeAdd()

Makes fields validation and adds new Yandex.Direct banner.

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

Event data.

Tags
throws
YandexException
throws
ArgumentException
throws
ArgumentNullException
Return values
EventResult

onBeforeUpdate()

Makes fields validation and updates Yandex.Direct banner.

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

Event data.

Tags
throws
YandexException
throws
ArgumentException
throws
ArgumentNullException
Return values
EventResult

onDelete()

Deletes Yandex.Direct banner.

public static onDelete(Event $event) : void
Parameters
$event : Event

Event data.

Tags
throws
YandexException
throws
ArgumentException

query()

public static query() : EO_YandexBanner_Query
Return values
EO_YandexBanner_Query

unMarkResumed()

public static unMarkResumed(array<string|int, mixed> $idList) : mixed
Parameters
$idList : array<string|int, mixed>

unMarkStopped()

public static unMarkStopped(array<string|int, mixed> $idList) : mixed
Parameters
$idList : array<string|int, mixed>

wakeUpCollection()

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

wakeUpObject()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results