ScheduleTable extends DataManager
Class ScheduleTable
Table of Contents
Constants
- ALLOWED_DEVICES_B24TIME = 'b24time'
- ALLOWED_DEVICES_BROWSER = 'browser'
- ALLOWED_DEVICES_MOBILE = 'mobile'
- CONTROLLED_ACTION_END = 2
- CONTROLLED_ACTION_START = 1
- CONTROLLED_ACTION_START_AND_END = 3
- DELETED_NO = 0
- DELETED_YES = 1
- EVENT_ON_ADD = "OnAdd"
- EVENT_ON_AFTER_ADD = "OnAfterAdd"
- EVENT_ON_AFTER_DELETE = "OnAfterDelete"
- EVENT_ON_AFTER_UPDATE = "OnAfterUpdate"
- EVENT_ON_BEFORE_ADD = "OnBeforeAdd"
- EVENT_ON_BEFORE_DELETE = "OnBeforeDelete"
- EVENT_ON_BEFORE_UPDATE = "OnBeforeUpdate"
- EVENT_ON_DELETE = "OnDelete"
- EVENT_ON_UPDATE = "OnUpdate"
- REPORT_PERIOD_MONTH = 'MONTH'
- REPORT_PERIOD_OPTIONS_START_WEEK_DAY = 'START_WEEK_DAY'
- REPORT_PERIOD_OPTIONS_START_WEEK_DAY_FRIDAY = 4
- REPORT_PERIOD_OPTIONS_START_WEEK_DAY_MONDAY = 0
- REPORT_PERIOD_OPTIONS_START_WEEK_DAY_SATURDAY = 5
- REPORT_PERIOD_OPTIONS_START_WEEK_DAY_SUNDAY = 6
- REPORT_PERIOD_OPTIONS_START_WEEK_DAY_THURSDAY = 3
- REPORT_PERIOD_OPTIONS_START_WEEK_DAY_TUESDAY = 1
- REPORT_PERIOD_OPTIONS_START_WEEK_DAY_WEDNESDAY = 2
- REPORT_PERIOD_QUARTER = 'QUARTER'
- REPORT_PERIOD_TWO_WEEKS = 'TWO_WEEKS'
- REPORT_PERIOD_WEEK = 'WEEK'
- SCHEDULE_TYPE_FIXED = 'FIXED'
- SCHEDULE_TYPE_FLEXTIME = 'FLEXTIME'
- SCHEDULE_TYPE_SHIFT = 'SHIFT'
- WORKTIME_RESTRICTION_ALLOWED_TO_EDIT_RECORD = 'ALLOWED_TO_EDIT_RECORD'
- WORKTIME_RESTRICTION_ALLOWED_TO_REOPEN_RECORD = 'ALLOWED_TO_REOPEN_RECORD'
- WORKTIME_RESTRICTION_MAX_SHIFT_START_OFFSET = 'MAX_SHIFT_START_OFFSET'
Methods
- add() : AddResult
- Adds row to entity table
- addMulti() : AddResult
- checkFields() : mixed
- Checks the data fields before saving to DB. Result stores in the $result object
- cleanCache() : void
- Cleans the tablet cache after data modifications.
- createCollection() : ScheduleCollection
- createObject() : Schedule
- cryptoEnabled() : bool
- Returns true if crypto is enabled for a field.
- delete() : DeleteResult
- Deletes row in entity table by primary key
- enableCrypto() : mixed
- Sets a flag indicating crypto support for a field.
- getById() : EO_Schedule_Result
- Returns selection by entity's primary key
- getByPrimary() : EO_Schedule_Result
- Returns selection by entity's primary key and optional parameters for getList()
- getCollectionClass() : string|Collection
- Returns class of Object collection for current entity.
- getCollectionClassName() : string
- Returns class name (without namespace) of Object collection for current entity.
- getCollectionParentClass() : Collection|string
- getConnectionName() : string
- Returns connection name for entity
- getControlledActionTypes() : mixed
- getCount() : int
- Performs COUNT query on entity and returns the result.
- getEntity() : EO_Schedule_Entity
- Returns entity object
- getEntityClass() : Entity|string
- getList() : EO_Schedule_Result
- Executes the query and returns selection by parameters of the query. This function is an alias to the Query object functions
- getMap() : array<string|int, mixed>
- Returns entity map definition.
- getObjectClass() : string|EntityObject
- Returns class of Object for current entity.
- getObjectClassName() : string
- Returns class name (without namespace) of Object for current entity.
- getObjectParentClass() : EntityObject|string
- getQueryClass() : Query|string
- getRow() : array<string|int, mixed>|null
- Returns one row (or null) by parameters for getList()
- getRowById() : array<string|int, mixed>|null
- Returns one row (or null) by entity's primary key
- getTableName() : string
- Returns DB table name for entity.
- getTitle() : string|null
- getUfId() : mixed
- getWorktimeRestrictionsKeys() : mixed
- isCacheable() : bool
- You can disable cache for the tablet completely.
- isUtm() : mixed
- isUts() : mixed
- onAdd() : mixed
- onAfterAdd() : mixed
- onAfterDelete() : mixed
- onAfterUpdate() : mixed
- onBeforeAdd() : mixed
- onBeforeDelete() : mixed
- onBeforeUpdate() : mixed
- onDelete() : mixed
- onUpdate() : mixed
- postInitialize() : null
- query() : EO_Schedule_Query
- Creates and returns the Query object for the entity
- setCurrentDeletingObject() : void
- setDefaultScope() : Query
- unsetEntity() : mixed
- update() : UpdateResult
- Updates row in entity table by primary key
- updateMulti() : UpdateResult
- wakeUpCollection() : ScheduleCollection
- wakeUpObject() : Schedule
Constants
ALLOWED_DEVICES_B24TIME
public
mixed
ALLOWED_DEVICES_B24TIME
= 'b24time'
ALLOWED_DEVICES_BROWSER
public
mixed
ALLOWED_DEVICES_BROWSER
= 'browser'
ALLOWED_DEVICES_MOBILE
public
mixed
ALLOWED_DEVICES_MOBILE
= 'mobile'
CONTROLLED_ACTION_END
public
mixed
CONTROLLED_ACTION_END
= 2
CONTROLLED_ACTION_START
public
mixed
CONTROLLED_ACTION_START
= 1
CONTROLLED_ACTION_START_AND_END
public
mixed
CONTROLLED_ACTION_START_AND_END
= 3
DELETED_NO
public
mixed
DELETED_NO
= 0
DELETED_YES
public
mixed
DELETED_YES
= 1
EVENT_ON_ADD
public
mixed
EVENT_ON_ADD
= "OnAdd"
EVENT_ON_AFTER_ADD
public
mixed
EVENT_ON_AFTER_ADD
= "OnAfterAdd"
EVENT_ON_AFTER_DELETE
public
mixed
EVENT_ON_AFTER_DELETE
= "OnAfterDelete"
EVENT_ON_AFTER_UPDATE
public
mixed
EVENT_ON_AFTER_UPDATE
= "OnAfterUpdate"
EVENT_ON_BEFORE_ADD
public
mixed
EVENT_ON_BEFORE_ADD
= "OnBeforeAdd"
EVENT_ON_BEFORE_DELETE
public
mixed
EVENT_ON_BEFORE_DELETE
= "OnBeforeDelete"
EVENT_ON_BEFORE_UPDATE
public
mixed
EVENT_ON_BEFORE_UPDATE
= "OnBeforeUpdate"
EVENT_ON_DELETE
public
mixed
EVENT_ON_DELETE
= "OnDelete"
EVENT_ON_UPDATE
public
mixed
EVENT_ON_UPDATE
= "OnUpdate"
REPORT_PERIOD_MONTH
public
mixed
REPORT_PERIOD_MONTH
= 'MONTH'
REPORT_PERIOD_OPTIONS_START_WEEK_DAY
public
mixed
REPORT_PERIOD_OPTIONS_START_WEEK_DAY
= 'START_WEEK_DAY'
REPORT_PERIOD_OPTIONS_START_WEEK_DAY_FRIDAY
public
mixed
REPORT_PERIOD_OPTIONS_START_WEEK_DAY_FRIDAY
= 4
REPORT_PERIOD_OPTIONS_START_WEEK_DAY_MONDAY
public
mixed
REPORT_PERIOD_OPTIONS_START_WEEK_DAY_MONDAY
= 0
REPORT_PERIOD_OPTIONS_START_WEEK_DAY_SATURDAY
public
mixed
REPORT_PERIOD_OPTIONS_START_WEEK_DAY_SATURDAY
= 5
REPORT_PERIOD_OPTIONS_START_WEEK_DAY_SUNDAY
public
mixed
REPORT_PERIOD_OPTIONS_START_WEEK_DAY_SUNDAY
= 6
REPORT_PERIOD_OPTIONS_START_WEEK_DAY_THURSDAY
public
mixed
REPORT_PERIOD_OPTIONS_START_WEEK_DAY_THURSDAY
= 3
REPORT_PERIOD_OPTIONS_START_WEEK_DAY_TUESDAY
public
mixed
REPORT_PERIOD_OPTIONS_START_WEEK_DAY_TUESDAY
= 1
REPORT_PERIOD_OPTIONS_START_WEEK_DAY_WEDNESDAY
public
mixed
REPORT_PERIOD_OPTIONS_START_WEEK_DAY_WEDNESDAY
= 2
REPORT_PERIOD_QUARTER
public
mixed
REPORT_PERIOD_QUARTER
= 'QUARTER'
REPORT_PERIOD_TWO_WEEKS
public
mixed
REPORT_PERIOD_TWO_WEEKS
= 'TWO_WEEKS'
REPORT_PERIOD_WEEK
public
mixed
REPORT_PERIOD_WEEK
= 'WEEK'
SCHEDULE_TYPE_FIXED
public
mixed
SCHEDULE_TYPE_FIXED
= 'FIXED'
SCHEDULE_TYPE_FLEXTIME
public
mixed
SCHEDULE_TYPE_FLEXTIME
= 'FLEXTIME'
SCHEDULE_TYPE_SHIFT
public
mixed
SCHEDULE_TYPE_SHIFT
= 'SHIFT'
WORKTIME_RESTRICTION_ALLOWED_TO_EDIT_RECORD
public
mixed
WORKTIME_RESTRICTION_ALLOWED_TO_EDIT_RECORD
= 'ALLOWED_TO_EDIT_RECORD'
WORKTIME_RESTRICTION_ALLOWED_TO_REOPEN_RECORD
public
mixed
WORKTIME_RESTRICTION_ALLOWED_TO_REOPEN_RECORD
= 'ALLOWED_TO_REOPEN_RECORD'
WORKTIME_RESTRICTION_MAX_SHIFT_START_OFFSET
public
mixed
WORKTIME_RESTRICTION_MAX_SHIFT_START_OFFSET
= 'MAX_SHIFT_START_OFFSET'
Methods
add()
Adds row to entity table
public
static add(array<string|int, mixed> $data) : AddResult
Parameters
- $data : array<string|int, mixed>
-
An array with fields like array( "fields" => array( "FIELD1" => "value1", "FIELD2" => "value2", ), "auth_context" => \Bitrix\Main\Authentication\Context object ) or just a plain array of fields.
Tags
Return values
AddResult —Contains ID of inserted row
addMulti()
public
static addMulti(mixed $rows[, bool $ignoreEvents = false ]) : AddResult
Parameters
- $rows : mixed
- $ignoreEvents : bool = false
Tags
Return values
AddResultcheckFields()
Checks the data fields before saving to DB. Result stores in the $result object
public
static checkFields(Result $result, mixed $primary, array<string|int, mixed> $data) : mixed
Parameters
- $result : Result
- $primary : mixed
- $data : array<string|int, mixed>
Tags
cleanCache()
Cleans the tablet cache after data modifications.
public
static cleanCache() : void
createCollection()
public
static createCollection() : ScheduleCollection
Return values
ScheduleCollectioncreateObject()
public
static createObject([mixed $setDefaultValues = = 'true' ]) : Schedule
Parameters
- $setDefaultValues : mixed = = 'true'
Return values
SchedulecryptoEnabled()
Returns true if crypto is enabled for a field.
public
static cryptoEnabled(string $field[, string $table = null ]) : bool
Parameters
- $field : string
- $table : string = null
Return values
booldelete()
Deletes row in entity table by primary key
public
static delete(mixed $primary) : DeleteResult
Parameters
- $primary : mixed
Tags
Return values
DeleteResultenableCrypto()
Sets a flag indicating crypto support for a field.
public
static enableCrypto(string $field[, string $table = null ][, bool $mode = true ]) : mixed
Parameters
- $field : string
- $table : string = null
- $mode : bool = true
getById()
Returns selection by entity's primary key
public
static getById(mixed $id) : EO_Schedule_Result
Parameters
- $id : mixed
-
Primary key of the entity
Return values
EO_Schedule_ResultgetByPrimary()
Returns selection by entity's primary key and optional parameters for getList()
public
static getByPrimary(mixed $primary[, array<string|int, mixed> $parameters = = '[]' ]) : EO_Schedule_Result
Parameters
- $primary : mixed
-
Primary key of the entity
- $parameters : array<string|int, mixed> = = '[]'
-
Additional parameters for getList()
Return values
EO_Schedule_ResultgetCollectionClass()
Returns class of Object collection for current entity.
public
static getCollectionClass() : string|Collection
Return values
string|CollectiongetCollectionClassName()
Returns class name (without namespace) of Object collection for current entity.
public
final static getCollectionClassName() : string
Return values
stringgetCollectionParentClass()
public
static getCollectionParentClass() : Collection|string
Return values
Collection|stringgetConnectionName()
Returns connection name for entity
public
static getConnectionName() : string
Return values
stringgetControlledActionTypes()
public
static getControlledActionTypes() : mixed
getCount()
Performs COUNT query on entity and returns the result.
public
static getCount([array<string|int, mixed>|ConditionTree $filter = array() ][, array<string|int, mixed> $cache = array() ]) : int
Parameters
- $filter : array<string|int, mixed>|ConditionTree = array()
- $cache : array<string|int, mixed> = array()
-
An array of cache options "ttl" => integer indicating cache TTL
Tags
Return values
intgetEntity()
Returns entity object
public
static getEntity() : EO_Schedule_Entity
Return values
EO_Schedule_EntitygetEntityClass()
public
static getEntityClass() : Entity|string
Return values
Entity|stringgetList()
Executes the query and returns selection by parameters of the query. This function is an alias to the Query object functions
public
static getList([array<string|int, mixed> $parameters = = '[]' ]) : EO_Schedule_Result
Parameters
- $parameters : array<string|int, mixed> = = '[]'
-
An array of query parameters, available keys are:
"select" => array of fields in the SELECT part of the query, aliases are possible in the form of "alias"=>"field";
"filter" => array of filters in the WHERE/HAVING part of the query in the form of "(condition)field"=>"value"; also could be an instance of Filter;
"group" => array of fields in the GROUP BY part of the query;
"order" => array of fields in the ORDER BY part of the query in the form of "field"=>"asc|desc";
"limit" => integer indicating maximum number of rows in the selection (like LIMIT n in MySql);
"offset" => integer indicating first row number in the selection (like LIMIT n, 100 in MySql);
"runtime" => array of entity fields created dynamically;
"cache => array of cache options:
"ttl" => integer indicating cache TTL;
"cache_joins" => boolean enabling to cache joins, false by default.
Return values
EO_Schedule_ResultgetMap()
Returns entity map definition.
public
static getMap() : array<string|int, mixed>
Return values
array<string|int, mixed>getObjectClass()
Returns class of Object for current entity.
public
static getObjectClass() : string|EntityObject
Return values
string|EntityObjectgetObjectClassName()
Returns class name (without namespace) of Object for current entity.
public
final static getObjectClassName() : string
Return values
stringgetObjectParentClass()
public
static getObjectParentClass() : EntityObject|string
Return values
EntityObject|stringgetQueryClass()
public
static getQueryClass() : Query|string
Return values
Query|stringgetRow()
Returns one row (or null) by parameters for getList()
public
static getRow(array<string|int, mixed> $parameters) : array<string|int, mixed>|null
Parameters
- $parameters : array<string|int, mixed>
-
Primary key of the entity
Tags
Return values
array<string|int, mixed>|nullgetRowById()
Returns one row (or null) by entity's primary key
public
static getRowById(mixed $id) : array<string|int, mixed>|null
Parameters
- $id : mixed
-
Primary key of the entity
Tags
Return values
array<string|int, mixed>|nullgetTableName()
Returns DB table name for entity.
public
static getTableName() : string
Return values
stringgetTitle()
public
static getTitle() : string|null
Return values
string|nullgetUfId()
public
static getUfId() : mixed
getWorktimeRestrictionsKeys()
public
static getWorktimeRestrictionsKeys() : mixed
isCacheable()
You can disable cache for the tablet completely.
public
static isCacheable() : bool
Return values
boolisUtm()
public
static isUtm() : mixed
isUts()
public
static isUts() : mixed
onAdd()
public
static onAdd(Event $event) : mixed
Parameters
- $event : Event
onAfterAdd()
public
static onAfterAdd(Event $event) : mixed
Parameters
- $event : Event
onAfterDelete()
public
static onAfterDelete(Event $event) : mixed
Parameters
- $event : Event
onAfterUpdate()
public
static onAfterUpdate(Event $event) : mixed
Parameters
- $event : Event
onBeforeAdd()
public
static onBeforeAdd(Event $event) : mixed
Parameters
- $event : Event
onBeforeDelete()
public
static onBeforeDelete(Event $event) : mixed
Parameters
- $event : Event
onBeforeUpdate()
public
static onBeforeUpdate(Event $event) : mixed
Parameters
- $event : Event
onDelete()
public
static onDelete(Event $event) : mixed
Parameters
- $event : Event
onUpdate()
public
static onUpdate(Event $event) : mixed
Parameters
- $event : Event
postInitialize()
public
static postInitialize(Entity $entity) : null
Parameters
- $entity : Entity
Return values
nullquery()
Creates and returns the Query object for the entity
public
static query() : EO_Schedule_Query
Return values
EO_Schedule_QuerysetCurrentDeletingObject()
public
static setCurrentDeletingObject(EntityObject $object) : void
Parameters
- $object : EntityObject
setDefaultScope()
public
static setDefaultScope(Query $query) : Query
Parameters
- $query : Query
Return values
QueryunsetEntity()
public
static unsetEntity(mixed $class) : mixed
Parameters
- $class : mixed
update()
Updates row in entity table by primary key
public
static update(mixed $primary, array<string|int, mixed> $data) : UpdateResult
Parameters
- $primary : mixed
- $data : array<string|int, mixed>
-
An array with fields like array( "fields" => array( "FIELD1" => "value1", "FIELD2" => "value2", ), "auth_context" => \Bitrix\Main\Authentication\Context object ) or just a plain array of fields.
Tags
Return values
UpdateResultupdateMulti()
public
static updateMulti(array<string|int, mixed> $primaries, array<string|int, mixed> $data[, bool $ignoreEvents = false ]) : UpdateResult
Parameters
- $primaries : array<string|int, mixed>
- $data : array<string|int, mixed>
- $ignoreEvents : bool = false
Tags
Return values
UpdateResultwakeUpCollection()
public
static wakeUpCollection(mixed $rows) : ScheduleCollection
Parameters
- $rows : mixed
Return values
ScheduleCollectionwakeUpObject()
public
static wakeUpObject(mixed $row) : Schedule
Parameters
- $row : mixed