CalendarItem implements RestEntity uses ContextCustomer
Table of Contents
Interfaces
Methods
- getContext() : Context
- Returns the local or global context for the action.
- getCreatedBy() : int
- getDateFrom() : DateTime
- getDateTo() : DateTime
- getId() : int|null
- Returns the id of the entity
- getMembersIds() : array<string|int, int>
- getOwnerId() : int
- getRestEntityName() : string
- Returns the name of the entity that will be used in the rest response
- getTitle() : string
- getType() : string
- getUrl() : string
- initByGetListArray() : self
- initById() : self
- setContext() : self
- Sets new context for operations.
- setContextUser() : self
- setCreatedBy() : CalendarItem
- setDateFrom() : CalendarItem
- setDateTo() : CalendarItem
- setId() : CalendarItem
- setMembersIds() : CalendarItem
- setOwnerId() : CalendarItem
- setTitle() : CalendarItem
- setType() : CalendarItem
- toRestFormat() : array<string|int, mixed>|null
- Returns an array in JSON like format to return the entity as a rest response.
- withContext() : static
- Provides local context for the action.
- withContextUser() : static
- Provides local context for the action.
Methods
getContext()
Returns the local or global context for the action.
public
getContext() : Context
Return values
ContextgetCreatedBy()
public
getCreatedBy() : int
Return values
intgetDateFrom()
public
getDateFrom() : DateTime
Return values
DateTimegetDateTo()
public
getDateTo() : DateTime
Return values
DateTimegetId()
Returns the id of the entity
public
getId() : int|null
Return values
int|nullgetMembersIds()
public
getMembersIds() : array<string|int, int>
Return values
array<string|int, int>getOwnerId()
public
getOwnerId() : int
Return values
intgetRestEntityName()
Returns the name of the entity that will be used in the rest response
public
static getRestEntityName() : string
Return values
stringgetTitle()
public
getTitle() : string
Return values
stringgetType()
public
getType() : string
Return values
stringgetUrl()
public
getUrl() : string
Return values
stringinitByGetListArray()
public
static initByGetListArray(array<string|int, mixed> $calendarInfo) : self
Parameters
- $calendarInfo : array<string|int, mixed>
Return values
selfinitById()
public
static initById(int $id[, Context|null $context = null ]) : self
Parameters
- $id : int
- $context : Context|null = null
Return values
selfsetContext()
Sets new context for operations.
public
setContext(Context|null $context) : self
Parameters
- $context : Context|null
Return values
selfsetContextUser()
public
setContextUser(mixed $user) : self
Parameters
- $user : mixed
Return values
selfsetCreatedBy()
public
setCreatedBy(int $createdBy) : CalendarItem
Parameters
- $createdBy : int
Return values
CalendarItemsetDateFrom()
public
setDateFrom(DateTime $dateFrom) : CalendarItem
Parameters
- $dateFrom : DateTime
Return values
CalendarItemsetDateTo()
public
setDateTo(DateTime $dateTo) : CalendarItem
Parameters
- $dateTo : DateTime
Return values
CalendarItemsetId()
public
setId(int|null $id) : CalendarItem
Parameters
- $id : int|null
Return values
CalendarItemsetMembersIds()
public
setMembersIds(array<string|int, int> $membersIds) : CalendarItem
Parameters
- $membersIds : array<string|int, int>
Return values
CalendarItemsetOwnerId()
public
setOwnerId(int $ownerId) : CalendarItem
Parameters
- $ownerId : int
Return values
CalendarItemsetTitle()
public
setTitle(string $title) : CalendarItem
Parameters
- $title : string
Return values
CalendarItemsetType()
public
setType(string $type) : CalendarItem
Parameters
- $type : string
Return values
CalendarItemtoRestFormat()
Returns an array in JSON like format to return the entity as a rest response.
public
toRestFormat([array<string|int, mixed> $option = [] ]) : array<string|int, mixed>|null
Parameters
- $option : array<string|int, mixed> = []
Return values
array<string|int, mixed>|nullwithContext()
Provides local context for the action.
public
withContext(Context|null $context) : static
Parameters
- $context : Context|null
Return values
staticwithContextUser()
Provides local context for the action.
public
withContextUser(int|User|User $user) : static
Parameters
- $user : int|User|User