Calendar_RecuringEvents_Model
extends Base
in package
Recurring Events Class.
Tags
Table of Contents
- UPDATE_ALL_EVENTS = 1
- UPDATE_FUTURE_EVENTS = 3
- UPDATE_THIS_EVENT = 2
- $changes : mixed
- $isNew : mixed
- $recordModel : mixed
- $templateRecordId : mixed
- $typeSaving : mixed
- $value : array<string|int, mixed>
- __construct() : mixed
- Constructor.
- createRecords() : mixed
- Function to create new records.
- delete() : mixed
- Function to remove records.
- 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.
- getData() : array<string|int, mixed>
- Function to get all the values of the Object.
- getDates() : array<string|int, mixed>
- Function to get dates.
- 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() : Calendar_RecuringEvents_Model
- Function to get empty instance.
- getInstanceFromRequest() : Calendar_RecuringEvents_Model
- Function to get instance of class.
- getKeys() : array<string|int, string>
- Function to get keys.
- getLastRecord() : array<string|int, mixed>
- Function to get the last record in series.
- getRecords() : array<string|int, mixed>
- Function to get related records.
- has() : bool
- Function to check if the key exists.
- isEmpty() : bool
- Function to check if the key is empty.
- isNeverEndingRule() : type
- Check if recurrence rule is never ending.
- remove() : mixed
- Function to remove the value.
- save() : mixed
- Save records.
- set() : $this
- Function to set the value for a given key.
- setChanges() : mixed
- Function to set changes which user modified.
- setData() : $this
- Function to set data to record model.
- updateNeverEndingEvents() : mixed
- Function to create new records in never ending events. Function uses only by cron.
- updateOmmitedRecords() : mixed
- Update ommited records, change recuring rule for each records.
- updateRecord() : mixed
- Function to edit record.
Constants
UPDATE_ALL_EVENTS
public
mixed
UPDATE_ALL_EVENTS
= 1
UPDATE_FUTURE_EVENTS
public
mixed
UPDATE_FUTURE_EVENTS
= 3
UPDATE_THIS_EVENT
public
mixed
UPDATE_THIS_EVENT
= 2
Properties
$changes
public
mixed
$changes
$isNew
public
mixed
$isNew
$recordModel
public
mixed
$recordModel
$templateRecordId
public
mixed
$templateRecordId
$typeSaving
public
mixed
$typeSaving
$value
protected
array<string|int, mixed>
$value
Values
Methods
__construct()
Constructor.
public
__construct([array<string|int, mixed> $values = [] ]) : mixed
Parameters
- $values : array<string|int, mixed> = []
Return values
mixed —createRecords()
Function to create new records.
public
createRecords(array<string|int, mixed> $dates) : mixed
Parameters
- $dates : array<string|int, mixed>
Return values
mixed —delete()
Function to remove records.
public
delete() : mixed
Return values
mixed —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> —getData()
Function to get all the values of the Object.
public
getData() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDates()
Function to get dates.
public
getDates(string $startDateTime, string $endDateTime[, string $recurrenceRule = false ]) : array<string|int, mixed>
Parameters
- $startDateTime : string
- $endDateTime : string
- $recurrenceRule : string = false
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()
Function to get empty instance.
public
static getInstance() : Calendar_RecuringEvents_Model
Return values
Calendar_RecuringEvents_Model —getInstanceFromRequest()
Function to get instance of class.
public
static getInstanceFromRequest(Request $request) : Calendar_RecuringEvents_Model
Parameters
- $request : Request
Return values
Calendar_RecuringEvents_Model —getKeys()
Function to get keys.
public
getKeys() : array<string|int, string>
Return values
array<string|int, string> —getLastRecord()
Function to get the last record in series.
public
getLastRecord(int $id) : array<string|int, mixed>
Parameters
- $id : int
Return values
array<string|int, mixed> —getRecords()
Function to get related records.
public
getRecords(int $id) : array<string|int, mixed>
Parameters
- $id : int
Return values
array<string|int, 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 —isNeverEndingRule()
Check if recurrence rule is never ending.
public
isNeverEndingRule(type $recurrenceRule) : type
Parameters
- $recurrenceRule : type
Return values
type —remove()
Function to remove the value.
public
remove(string $key) : mixed
Parameters
- $key : string
Return values
mixed —save()
Save records.
public
save() : mixed
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 —setChanges()
Function to set changes which user modified.
public
setChanges(type $values) : mixed
Parameters
- $values : type
Return values
mixed —setData()
Function to set data to record model.
public
setData(array<string|int, mixed> $values) : $this
Parameters
- $values : array<string|int, mixed>
Return values
$this —updateNeverEndingEvents()
Function to create new records in never ending events. Function uses only by cron.
public
updateNeverEndingEvents(int $recordId) : mixed
Parameters
- $recordId : int
Return values
mixed —updateOmmitedRecords()
Update ommited records, change recuring rule for each records.
public
updateOmmitedRecords(type $records, type $dateStart) : mixed
Parameters
- $records : type
- $dateStart : type
Return values
mixed —updateRecord()
Function to edit record.
public
updateRecord(int $recordId, array<string|int, mixed> $dates) : mixed
Parameters
- $recordId : int
- $dates : array<string|int, mixed>