Bitrix API

EntityForm

Table of Contents

Constants

BACKLOG_TYPE  = 'backlog'
SPRINT_ACTIVE  = 'active'
SPRINT_COMPLETED  = 'completed'
SPRINT_PLANNED  = 'planned'
SPRINT_TYPE  = 'sprint'
STATE_COMPLETED_IN_ACTIVE_SPRINT  = 'completedInActiveSprint'

Methods

fillFromDatabase()  : void
To fill the object with data obtained from the database.
getChildren()  : array<string|int, mixed>
getCreatedBy()  : int
getDateEnd()  : DateTime
getDateStart()  : DateTime
getEntityType()  : string
getFieldsToCreateBacklog()  : array<string|int, mixed>
Returns a list of fields to create a backlog.
getFieldsToCreateSprint()  : array<string|int, mixed>
Returns a list of fields to create a sprint.
getFieldsToUpdateEntity()  : array<string|int, mixed>
Returns a list of fields to update an entity.
getGroupId()  : int
getId()  : int
getInfo()  : EntityInfo
getModifiedBy()  : int
getName()  : string
getSort()  : int
getStatus()  : string
getTmpId()  : string
hideContent()  : void
Makes the content invisible to the specified user.
isActiveSprint()  : bool
isCompletedSprint()  : bool
isEmpty()  : bool
Checks if an object is empty based on an Id. If id empty, it means that it was not possible to get data from the storage or did not fill out the id.
isPlannedSprint()  : bool
isShownContent()  : bool
The method checks if the content of the entity (Backlog/Sprint) is hidden for the specified user.
setChildren()  : void
setCreatedBy()  : void
setDateEnd()  : void
setDateStart()  : void
setEntityType()  : void
setGroupId()  : void
setId()  : void
setInfo()  : void
setModifiedBy()  : void
setName()  : void
setSort()  : void
setStatus()  : void
setTmpId()  : void
showContent()  : void
Makes the content visible to the specified user.
toArray()  : array<string|int, mixed>
Returns an array with keys for the client.
toRest()  : array<string|int, mixed>
Returns an array with keys for the REST.

Constants

BACKLOG_TYPE

public mixed BACKLOG_TYPE = 'backlog'

SPRINT_ACTIVE

public mixed SPRINT_ACTIVE = 'active'

SPRINT_COMPLETED

public mixed SPRINT_COMPLETED = 'completed'

SPRINT_PLANNED

public mixed SPRINT_PLANNED = 'planned'

STATE_COMPLETED_IN_ACTIVE_SPRINT

public mixed STATE_COMPLETED_IN_ACTIVE_SPRINT = 'completedInActiveSprint'

Methods

fillFromDatabase()

To fill the object with data obtained from the database.

public fillFromDatabase(array<string|int, mixed> $fields) : void
Parameters
$fields : array<string|int, mixed>

An array with fields.

getChildren()

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

getCreatedBy()

public getCreatedBy() : int
Return values
int

getEntityType()

public getEntityType() : string
Return values
string

getFieldsToCreateBacklog()

Returns a list of fields to create a backlog.

public getFieldsToCreateBacklog() : array<string|int, mixed>
Tags
throws
ArgumentNullException
Return values
array<string|int, mixed>

getFieldsToCreateSprint()

Returns a list of fields to create a sprint.

public getFieldsToCreateSprint() : array<string|int, mixed>
Tags
throws
ArgumentNullException
Return values
array<string|int, mixed>

getFieldsToUpdateEntity()

Returns a list of fields to update an entity.

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

getGroupId()

public getGroupId() : int
Return values
int

getModifiedBy()

public getModifiedBy() : int
Return values
int

getName()

public getName() : string
Return values
string

getSort()

public getSort() : int
Return values
int

getStatus()

public getStatus() : string
Return values
string

getTmpId()

public getTmpId() : string
Return values
string

hideContent()

Makes the content invisible to the specified user.

public hideContent(int $userId) : void
Parameters
$userId : int

User id.

isActiveSprint()

public isActiveSprint() : bool
Return values
bool

isCompletedSprint()

public isCompletedSprint() : bool
Return values
bool

isEmpty()

Checks if an object is empty based on an Id. If id empty, it means that it was not possible to get data from the storage or did not fill out the id.

public isEmpty() : bool
Return values
bool

isPlannedSprint()

public isPlannedSprint() : bool
Return values
bool

isShownContent()

The method checks if the content of the entity (Backlog/Sprint) is hidden for the specified user.

public isShownContent(int $userId) : bool
Parameters
$userId : int

User id.

Return values
bool

setChildren()

public setChildren(array<string|int, mixed> $children) : void
Parameters
$children : array<string|int, mixed>

setCreatedBy()

public setCreatedBy(mixed $createdBy) : void
Parameters
$createdBy : mixed

setEntityType()

public setEntityType(mixed $entityType) : void
Parameters
$entityType : mixed

setGroupId()

public setGroupId(mixed $groupId) : void
Parameters
$groupId : mixed

setId()

public setId(mixed $id) : void
Parameters
$id : mixed

setModifiedBy()

public setModifiedBy(mixed $modifiedBy) : void
Parameters
$modifiedBy : mixed

setName()

public setName(mixed $name) : void
Parameters
$name : mixed

setSort()

public setSort(mixed $sort) : void
Parameters
$sort : mixed

setStatus()

public setStatus(string $status) : void
Parameters
$status : string

setTmpId()

public setTmpId(mixed $tmpId) : void
Parameters
$tmpId : mixed

showContent()

Makes the content visible to the specified user.

public showContent(int $userId) : void
Parameters
$userId : int

User id.

toArray()

Returns an array with keys for the client.

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

toRest()

Returns an array with keys for the REST.

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results