◆ __construct()
__construct |
( |
|
$id = null | ) |
|
constructor
- Parameters
-
string | $id | necessary if you want JavaScript enabled for this column |
◆ addEntries()
addEntries |
( |
|
$entries_array = [] | ) |
|
◆ addEntry()
adds a new entry in the column. The entry needs to be an associative array with parameters as follows:
- Parameters
-
array | $entry_array | associative array for an entry in the column like array ( 'color' => the color in hex (css-like, without the #) 'start' => the (start hour * 100) + (start minute) 'end' => the (end hour * 100) + (end minute) 'title' => the entry`s title 'content' => whatever shall be the content of the entry as a string ) |
◆ create()
static create |
( |
|
$id = null | ) |
|
|
static |
creates instance of type CalendarColumn
- Parameters
-
string | $id | necessary if you want JavaScript enabled for this calendar |
- Returns
- CalendarColumn
◆ eraseEntries()
deletes all entries of this column. So the only way to edit an entry is getting all entries with getEntries, edit this entry, eraseEntries() and addEntries(). Not very short, but at least it works.
- Returns
- CalendarColumn
◆ getEntries()
returns all entries of this column
- Returns
- array of arrays like array ( 'color' => the color in hex (css-like, without the #) 'start' => the (start hour * 100) + (start minute) 'end' => the (end hour * 100) + (end minute) 'title' => the entry`s title 'content' => whatever shall be the content of the entry as a string )
◆ getGroupedEntries()
Returns an array of calendar-entries, grouped by day and additionally grouped by same start and end if groupEntries(true) has been called.
- Returns
- mixed the (double-)grouped entries
◆ getId()
returns the id of the column
- Returns
- string
◆ getMatrix()
returns a matrix that tells the number of entries for a given timeslot
- Returns
- array
◆ getTitle()
returns the title of this column like "monday"
- Returns
- string title of column
◆ getURL()
returns the URL of the column (see setURL)
- Returns
- string an url
◆ groupEntries()
groupEntries |
( |
|
$grouped = true | ) |
|
Call this function th enable/disable the grouping of entries with the same start and end.
- Parameters
-
bool | $group | optional, defaults to true |
- Returns
- void
◆ isGrouped()
check, if a grouped view of the entries is requested
- Returns
- bool true if grouped, false otherwise
◆ setId()
sets the id for this column, which is only necessary if you want Javascript to be enabled for this calendar
- Parameters
-
string | $id | new id for this column |
- Returns
- CalendarColumn
◆ setTitle()
sets a title like "monday" for this column, which will be displayed in the calendar
- Parameters
-
string | $new_title | new title |
- Returns
- CalendarColumn
◆ setURL()
sets the url to be directed to when clicking on the title of the column. Usually this is a single-day-view of the calendar.
- Parameters
-
- Returns
- CalendarColumn
◆ sortAndGroupEntries()
sorts and groups entries and returns them only used by columns with grouped entries like instituteschedules
- Returns
- array
◆ sortEntries()
sorts entries and returns them
- Returns
- array
◆ $entries
◆ $grouped
◆ $id
◆ $number
◆ $sorted_entries
◆ $title
◆ $url
The documentation for this class was generated from the following file: