Documentation

OSSTimeControl_Calendar_Model extends Vtiger_Calendar_Model
in package

TimeControl calendar model class.

Tags
copyright

YetiForce Sp. z o.o

license

YetiForce Public License 3.0 (licenses/LicenseEN.txt or yetiforce.com)

Table of Contents

$module  : Vtiger_Module_Model
$moduleName  : string
$value  : mixed
__construct()  : mixed
Constructor.
changeDateTime()  : array<string|int, string>
Modify date.
get()  : mixed
Function to get the value for a given key.
getArray()  : array<string|int, mixed>
Function to get the array values for a given key.
getCalendarTypes()  : array<string|int, string>
Function to get calendar types.
getData()  : array<string|int, mixed>
Function to get all the values of the Object.
getEntity()  : array<string|int, mixed>
Function to get records.
getEntityRecordsCount()  : int|string
Get records count for extended calendar left column.
getEntityYearCount()  : array<string|int, mixed>
Get entity count for year view.
getForHtml()  : mixed
Function to get the html encoded value for a given key.
getForSql()  : mixed
Function to get the value if its safe to use for SQL Query (column).
getInstance()  : mixed
Static Function to get the instance of Vtiger Module Model for the given id or name.
getKeys()  : array<string|int, string>
Function to get keys.
getModule()  : Vtiger_Module_Model
Get module model.
getModuleName()  : string
Get module name.
getPublicHolidays()  : array<string|int, mixed>
Get public holidays for rendering them on the calendar.
getQuery()  : Query
Get query.
getSideBarLinks()  : mixed
{@inheritdoc}
has()  : bool
Function to check if the key exists.
isEmpty()  : bool
Function to check if the key is empty.
remove()  : mixed
Function to remove the value.
set()  : $this
Function to set the value for a given key.
setData()  : $this
Function to set all the values.
updateEvent()  : bool
Update event.

Properties

$module

public Vtiger_Module_Model $module

$value

protected mixed $value

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $values = [] ]) : mixed
Parameters
$values : array<string|int, mixed> = []
Return values
mixed

changeDateTime()

Modify date.

public changeDateTime(string $datetime, array<string|int, mixed> $delta) : array<string|int, string>
Parameters
$datetime : string
$delta : array<string|int, mixed>
Return values
array<string|int, string>

get()

Function to get the value for a given key.

public get(string $key) : mixed
Parameters
$key : string
Return values
mixed

Value for the given key

getArray()

Function to get the array values for a given key.

public getArray(string $key[, array<string|int, mixed> $value = [] ]) : array<string|int, mixed>
Parameters
$key : string
$value : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getCalendarTypes()

Function to get calendar types.

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

getData()

Function to get all the values of the Object.

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

getEntity()

Function to get records.

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

getEntityRecordsCount()

Get records count for extended calendar left column.

public getEntityRecordsCount() : int|string
Return values
int|string

getEntityYearCount()

Get entity count for year view.

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

getForHtml()

Function to get the html encoded value for a given key.

public getForHtml(string $key) : mixed
Parameters
$key : string
Return values
mixed

getForSql()

Function to get the value if its safe to use for SQL Query (column).

public getForSql(string $key[, bool $skipEmtpy = true ]) : mixed
Parameters
$key : string
$skipEmtpy : bool = true

Skip the check if string is empty

Return values
mixed

Value for the given key

getInstance()

Static Function to get the instance of Vtiger Module Model for the given id or name.

public static getInstance(mixed $moduleName) : mixed
Parameters
$moduleName : mixed
Return values
mixed

getKeys()

Function to get keys.

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

getModule()

Get module model.

public getModule() : Vtiger_Module_Model
Return values
Vtiger_Module_Model

getModuleName()

Get module name.

public getModuleName() : string
Return values
string

getPublicHolidays()

Get public holidays for rendering them on the calendar.

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

{@inheritdoc}

public getSideBarLinks(mixed $linkParams) : mixed
Parameters
$linkParams : mixed
Return values
mixed

has()

Function to check if the key exists.

public has(string $key) : bool
Parameters
$key : string
Return values
bool

isEmpty()

Function to check if the key is empty.

public isEmpty(string $key) : bool
Parameters
$key : string
Return values
bool

remove()

Function to remove the value.

public remove(string $key) : mixed
Parameters
$key : string
Return values
mixed

set()

Function to set the value for a given key.

public set(string $key, mixed $value) : $this
Parameters
$key : string
$value : mixed
Return values
$this

setData()

Function to set all the values.

public setData(mixed $values) : $this
Parameters
$values : mixed
Return values
$this

updateEvent()

Update event.

public updateEvent(int $recordId, string $date, array<string|int, mixed> $delta) : bool
Parameters
$recordId : int
$date : string
$delta : array<string|int, mixed>
Return values
bool

Search results