Свойство | Тип | Описание | |
---|---|---|---|
$cal | array | The parsed calendar | |
$defaultSpan | integer | The value in years to use for indefinite, recurring events | |
$defaultWeekStart | |||
$eventCount | integer | How many events are in this iCal? | |
$freebusyCount | integer | How many freebusy are in this iCal? | |
$todoCount | integer | How many ToDos are in this iCal? |
Свойство | Тип | Описание | |
---|---|---|---|
$alteredRecurrenceInstances | array | Event recurrence instances that have been altered | |
$dayOrdinals | |||
$frequencyConversion | |||
$monthNames | |||
$weekdays |
Метод | Описание | |
---|---|---|
__construct ( mixed $filename = false, mixed $weekStart = false ) : void | Creates the iCal Object | |
calendarDescription ( ) : calendar | Returns the calendar description | |
calendarName ( ) : string | Returns the calendar name | |
calendarTimeZone ( ) : calendar | Returns the calendar timezone | |
events ( ) : array | Returns an array of EventObjects. Every event is a class with the event details being properties within it. | |
eventsFromInterval ( string $interval ) : array | Returns a sorted array of the events following a given string, or false if no events exist in the range. | |
eventsFromRange ( string $rangeStart = false, string $rangeEnd = false ) : array | Returns a sorted array of the events in a given range, or false if no events exist in the range. | |
freeBusyEvents ( ) : array | Returns an array of arrays with all free/busy events. Every event is an associative array and each property is an element it. | |
hasEvents ( ) : boolean | Returns a boolean value whether the current calendar has events or not | |
iCalDateToUnixTimestamp ( string $icalDate ) : integer | Return Unix timestamp from iCal date time format | |
iCalDateWithTimeZone ( array $event, string $key ) : string | Return a date adapted to the calendar timezone depending on the event TZID | |
initLines ( array $lines ) : |
Initialises lines from file | |
initString ( string $contents ) : |
Initialises lines from a string | |
initURL ( string $url ) : |
Initialises lines from a URL | |
isValidTimeZoneId ( string $timezone ) : boolean | Check if a timezone is valid | |
processDateConversions ( ) : void | Processes date conversions using the timezone | |
processEvents ( ) : void | Performs some admin tasks on all events as taken straight from the ics file. | |
processRecurrences ( ) : void | Processes recurrence rules | |
sortEventsWithOrder ( array $events, integer $sortOrder = SORT_ASC ) : sorted | Sort events based on a given sort order |
Метод | Описание | |
---|---|---|
addCalendarComponentWithKeyAndValue ( string $component, string | boolean $keyword, string $value ) : void | Add to $this->ical array one value and key. | |
keyValueFromString ( string $text ) : array | Get a key-value pair of a string. |
protected addCalendarComponentWithKeyAndValue ( string $component, string | boolean $keyword, string $value ) : void | ||
$component | string | This could be VTODO, VEVENT, VCALENDAR, ... |
$keyword | string | boolean | The keyword, for example DTSTART |
$value | string | The value, for example 20110105T090000Z |
Результат | void |
public calendarDescription ( ) : calendar | ||
Результат | calendar | description |
public calendarName ( ) : string | ||
Результат | string |
public calendarTimeZone ( ) : calendar | ||
Результат | calendar | timezone |
public eventsFromInterval ( string $interval ) : array | ||
$interval | string | |
Результат | array | of EventObjects |
public freeBusyEvents ( ) : array | ||
Результат | array |
public iCalDateToUnixTimestamp ( string $icalDate ) : integer | ||
$icalDate | string | A Date in the format YYYYMMDD[T]HHMMSS[Z] or YYYYMMDD[T]HHMMSS or TZID=Timezone:YYYYMMDD[T]HHMMSS |
Результат | integer |
public initString ( string $contents ) : |
||
$contents | string | The contents of the ical file to initialise |
Результат |
public isValidTimeZoneId ( string $timezone ) : boolean | ||
$timezone | string | A timezone |
Результат | boolean |
protected keyValueFromString ( string $text ) : array | ||
$text | string | which is like "VCALENDAR:Begin" or "LOCATION:" |
Результат | array |
public processDateConversions ( ) : void | ||
Результат | void | or false if no Events exist |
public processEvents ( ) : void | ||
Результат | void | or false if no Events exist |
public processRecurrences ( ) : void | ||
Результат | void | or false if no Events exist |
public sortEventsWithOrder ( array $events, integer $sortOrder = SORT_ASC ) : sorted | ||
$events | array | An array of EventObjects |
$sortOrder | integer | Either SORT_ASC, SORT_DESC, SORT_REGULAR, SORT_NUMERIC, SORT_STRING |
Результат | sorted | array of EventObjects |
protected array $alteredRecurrenceInstances | ||
Результат | array |
public int $defaultSpan | ||
Результат | integer |
public int $eventCount | ||
Результат | integer |
public int $freebusyCount | ||
Результат | integer |
public int $todoCount | ||
Результат | integer |