Bitrix API

RestActivityTable extends DataManager

Class RestActivityTable

Fields:

  • ID int mandatory
  • APP_ID string(128) mandatory
  • APP_NAME text mandatory
  • CODE string(128) mandatory
  • INTERNAL_CODE(32) string mandatory
  • HANDLER string(1000) mandatory
  • AUTH_USER_ID int optional default 0
  • USE_SUBSCRIPTION bool optional default ''
  • NAME text mandatory
  • DESCRIPTION text optional
  • PROPERTIES text optional
  • RETURN_PROPERTIES text optional
  • DOCUMENT_TYPE text optional
  • FILTER text optional
  • IS_ROBOT bool optional default 'N'

Table of Contents

Methods

createCollection()  : EO_RestActivity_Collection
createObject()  : EO_RestActivity
getById()  : EO_RestActivity_Result
getByPrimary()  : EO_RestActivity_Result
getEntity()  : EO_RestActivity_Entity
getFilePath()  : string
Returns path to the file which contains definition of the class.
getList()  : EO_RestActivity_Result
getLocalization()  : string
getLocalizationSaveModifiers()  : array<string|int, mixed>
getMap()  : array<string|int, mixed>
Returns entity map definition.
getTableName()  : string
Returns DB table name for entity
prepareLocalization()  : array<string|int, mixed>
query()  : EO_RestActivity_Query
validateAppId()  : array<string|int, mixed>
Returns validators for APP_ID field.
validateCode()  : array<string|int, mixed>
Returns validators for CODE field.
validateHandler()  : array<string|int, mixed>
Returns validators for HANDLER field.
validateProperties()  : array<string|int, mixed>
Returns validators for PROPERTIES and RETURN_PROPERTIES fields
wakeUpCollection()  : EO_RestActivity_Collection
wakeUpObject()  : EO_RestActivity

Methods

createCollection()

public static createCollection() : EO_RestActivity_Collection
Return values
EO_RestActivity_Collection

createObject()

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

getById()

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

getByPrimary()

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

getEntity()

public static getEntity() : EO_RestActivity_Entity
Return values
EO_RestActivity_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_RestActivity_Result
Parameters
$parameters : array<string|int, mixed> = = '[]'
Return values
EO_RestActivity_Result

getLocalization()

public static getLocalization(mixed $field, string $langId) : string
Parameters
$field : mixed

Activity field value.

$langId : string

Language ID.

Return values
string

getLocalizationSaveModifiers()

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

Array of callbacks.

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

prepareLocalization()

public static prepareLocalization(mixed $value) : array<string|int, mixed>
Parameters
$value : mixed

Original value.

Return values
array<string|int, mixed>

Array to serialize.

query()

public static query() : EO_RestActivity_Query
Return values
EO_RestActivity_Query

validateAppId()

Returns validators for APP_ID field.

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

validateCode()

Returns validators for CODE field.

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

validateHandler()

Returns validators for HANDLER field.

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

validateProperties()

Returns validators for PROPERTIES and RETURN_PROPERTIES fields

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

wakeUpCollection()

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

wakeUpObject()

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

        
On this page

Search results