Package Date Element Index

a

$activeCells: in file Calendar.php, variable Calendar::$activeCells
Contains a list of the active cells in the Calendar matrix. Active cells are the days that are in use.
add: in file Date.php, method Date::add()
Adds to the specified date and returns the finished calculation.
addEvent: in file vCalendar.php, method vCal::addEvent()
Adds an event to the list. Returns a reference to the new event object. The $type can be any valid vCalendar event type.
addHTML: in file Simple.php, method SimpleCal::addHTML()
Adds the specified HTML to the specified day.
addLink: in file Simple.php, method SimpleCal::addLink()
Sets the specified day to link to the specified link.
addLink: in file Mini.php, method MiniCal::addLink()
Sets the specified day to link to the specified link.
addParameter: in file vCalProperty.php, method vCalProperty::addParameter()
Adds a parameter to the list.
addProperty: in file vCalendar.php, method vCal::addProperty()
Adds a property to the list. Returns a reference to the new property object. The $name can be any valid vCalendar property.
addProperty: in file vCalEvent.php, method vCalEvent::addProperty()
Adds a property to the list. Returns a reference to the new property object. The $name can be any valid vCalendar property.

b

$beginWeekOn: in file Calendar.php, variable Calendar::$beginWeekOn
Tells the calendar what day of the week to start the calendar on. Value may be one of 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', and 'Sat'.
$bottomBlock: in file Calendar.php, variable Calendar::$bottomBlock
Reference to the cell that contains the space after the last day of the month in the 'month' $showPeriod.

c

$calendars: in file vCalendar.php, variable vCal::$calendars
List of calendars in this calendar container. All calendars are vCal objects. A vCal object may act as either a calendar or as a container of multiple calendars. This property is false if this is not a container.
$cellTemplate: in file Calendar.php, variable Calendar::$cellTemplate
Contains a default template for use in each cell. The cell template is not to be confused with the item template, which displays an individual item on any given day.
$currentDay: in file Calendar.php, variable Calendar::$currentDay
Contains the current date (Y-m-d format).
Calendar: in file Calendar.php, method Calendar::Calendar()
Constructor Method. $date is a date in the format Y-m-d.
Calendar: in file Calendar.php, class Calendar
Calendar implements a graphical calendar generator. This class derives most of its functionality from the saf.GUI.Layout package, so for more information and additional functionality, please read up on that one as well.
compare: in file Date.php, method Date::compare()
Compares two dates, full date/time ('YmdHis' or 'Y-m-d H:i:s' formats),
convert: in file Date.php, method Date::convert()
Calendar.php: procedural page Calendar.php

f

$firstDay: in file Calendar.php, variable Calendar::$firstDay
Contains the date (Y-m-d format) of the first day to include in the current calendar view.
fillCalendar: in file Calendar.php, method Calendar::fillCalendar()
Fills the calendar based on an optional SQL query, some
fold: in file vCalendar.php, method vCal::fold()
Folds a block of text by inserting a Carriage Return (\r), a Line Feed (\n), and a single space every 70 characters.
format: in file Date.php, method Date::format()
Formats a date provided in ISO format (YYYY-MM-DD) in the new format specified.

g

getFirstAndLastDay: in file Calendar.php, method Calendar::getFirstAndLastDay()
Sets the $firstDay and $lastDay properties based on
getXCells: in file Calendar.php, method Calendar::getXCells()
Returns an array of weekdays (Mon, Tue, Wed) corresponding with the X cell value they fall under, based on the $beginWeekOn property.

i

isActive: in file Simple.php, method SimpleCal::isActive()
Determines whether the specified row and column is active.
isActive: in file Mini.php, method MiniCal::isActive()
Determines whether the specified row and column is active.
isCurrent: in file Simple.php, method SimpleCal::isCurrent()
Determines whether the specified day is the current date.
isCurrent: in file Mini.php, method MiniCal::isCurrent()
Determines whether the specified day is the current date.
isLink: in file Mini.php, method MiniCal::isLink()
Determines whether there is a link for the specified day.
isLink: in file Simple.php, method SimpleCal::isLink()
Determines whether there is a link for the specified day.
isWeekend: in file Simple.php, method SimpleCal::isWeekend()
Determines whether the specified day is on a weekend.
isWeekend: in file Mini.php, method MiniCal::isWeekend()
Determines whether the specified day is on a weekend.

l

$lastDay: in file Calendar.php, variable Calendar::$lastDay
Contains the date (Y-m-d format) of the last day to include in the current calendar view.
local: in file Date.php, method Date::local()
Returns the specified time (or the current time, if unspecified) with an offset in hours from GMT to the local timezone. $date is a Unix timestamp in this method.

m

Mini.php: procedural page Mini.php
makeHeader: in file Calendar.php, method Calendar::makeHeader()
Creates the header of the calendar, using $contents
makeTime: in file Calendar.php, method Calendar::makeTime()
Takes a number between 0 and 23 (the $hour), and a string from the fillCalendar() method of the format 5:30 or 12:00AM, and returns a string in the format H:i:s.
MiniCal: in file Mini.php, method MiniCal::MiniCal()
Constructor method.
MiniCal: in file Mini.php, class MiniCal
A mini calendar class, useful for displaying tiny monthly calendar summaries in a web site or application UI.
monthName: in file Simple.php, method SimpleCal::monthName()
Returns the name of the current month.
monthName: in file Mini.php, method MiniCal::monthName()
Returns the name of the current month.

n

$name: in file vCalProperty.php, variable vCalProperty::$name
The name of this property. Can be any of the valid vCalendar properties based on its placement within the document.
nextDate: in file Simple.php, method SimpleCal::nextDate()
Returns the next month as a $mc value.
nextDate: in file Mini.php, method MiniCal::nextDate()
Returns the next month as a $mc value.
nextMonth: in file Simple.php, method SimpleCal::nextMonth()
Returns the name of the next month.

p

$parameters: in file vCalProperty.php, variable vCalProperty::$parameters
List of parameters in this event. All parameters are key/value pairs of strings.
$properties: in file vCalEvent.php, variable vCalEvent::$properties
List of properties in this event. All properties are vCalProperty objects.
$properties: in file vCalendar.php, variable vCal::$properties
List of properties in this calendar. All properties are vCalProperty objects.
parse: in file vCalendar.php, method vCal::parse()
Parses a vCalendar message into an array of calendar objects with events and properties. Changing $tag to 'VCARD' allows vCal to parse vCard files as well.
parseLine: in file vCalendar.php, method vCal::parseLine()
Parses a property:value line into a vCalProperty object.
prevDate: in file Mini.php, method MiniCal::prevDate()
Returns the previous month as a $mc value.
prevDate: in file Simple.php, method SimpleCal::prevDate()
Returns the previous month as a $mc value.
prevMonth: in file Simple.php, method SimpleCal::prevMonth()
Returns the name of the previous month.

r

render: in file Simple.php, method SimpleCal::render()
Renders the HTML calendar.
render: in file Mini.php, method MiniCal::render()
Renders the HTML calendar.
roundTime: in file Date.php, method Date::roundTime()
Parses a time string (format: HH:MM:SS) and rounds it to the nearest 15 minutes, 1/2 hour, or hour, depending on the interval value set. $interval may be 15, 30, or 60. Returns the time as a string in the same format as it accepts.

s

$showFromHour: in file Calendar.php, variable Calendar::$showFromHour
Tells Calendar to limit the hours displayed in 'day' view.
$showPeriod: in file Calendar.php, variable Calendar::$showPeriod
Tells the calendar what to display on a single screen. May be 'day', 'week', or 'month'.
$showToHour: in file Calendar.php, variable Calendar::$showToHour
Tells Calendar to limit the hours displayed in 'day' view.
Simple.php: procedural page Simple.php
SimpleCal: in file Simple.php, class SimpleCal
A concise calendar class, useful for displaying monthly calendars in a web site or application UI.
SimpleCal: in file Simple.php, method SimpleCal::SimpleCal()
Constructor method.
splitIntoKeys: in file vCalendar.php, method vCal::splitIntoKeys()
Parses a string for a list of properties. Properties take the
subtract: in file Date.php, method Date::subtract()
Subtracts from the specified date and returns the finished calculation. $date is in the format Y-m-d, and $amount can be either '# year', '# month', '# week', or '# day', where # is any number.

t

$tag: in file vCalendar.php, variable vCal::$tag
This is the name of the surrounding BEGIN and END tag. It defaults to 'VCALENDAR', but can be changed to support additional formats such as 'VCARD'.
$topBlock: in file Calendar.php, variable Calendar::$topBlock
Reference to the cell that contains the space before the first day of the month in the 'month' $showPeriod.
$type: in file vCalEvent.php, variable vCalEvent::$type
The type of event. Can be any of the valid vCalendar event types.
time: in file Date.php, method Date::time()
Formats a time provided in ISO format (HH:MM:SS) in the new format specified.
timestamp: in file Date.php, method Date::timestamp()
Formats a timestamp provided in ISO format (YYYY-MM-DD HH:MM:SS) in the new format specified.
toUnix: in file Date.php, method Date::toUnix()
Accepts a date ('Y-m-d' format), full date/time ('YmdHis' or 'Y-m-d H:i:s' formats), or unix timestamp, and returns a unix timestamp equivalent (or the value passed if passed a timestamp already). Returns a timestamp of the current date/time if passed no date at all.

v

$value: in file vCalProperty.php, variable vCalProperty::$value
The value of this property.
vCalendar.php: procedural page vCalendar.php
vCalEvent.php: procedural page vCalEvent.php
vCalProperty.php: procedural page vCalProperty.php
vCal: in file vCalendar.php, method vCal::vCal()
Constructor Method. Optionally parses an existing data string into a complete vCal object.
vCal: in file vCalendar.php, class vCal
vCal implements a basic parser and mechanism for generating vCalendar and iCalendar messages. Knowledge of the names and meanings of the properties available to each message type will be required, as this class does nothing to manage those.
vCalEvent: in file vCalEvent.php, class vCalEvent
vCalEvent contains individual events for the vCal package.
vCalEvent: in file vCalEvent.php, method vCalEvent::vCalEvent()
Constructor Method.
vCalProperty: in file vCalProperty.php, method vCalProperty::vCalProperty()
Constructor Method.
vCalProperty: in file vCalProperty.php, class vCalProperty
vCalProperty contains individual properties for the vCal package.

w

weekday: in file Simple.php, method SimpleCal::weekday()
Returns an abbreviated week day formatted by strftime(). $day is a lowercase, English weekday abbreviation (sun, mon, tue, wed, thu, fri, or sat).
weekdayFri: in file Simple.php, method SimpleCal::weekdayFri()
Calls weekday() with 'fri' (as in Friday).
weekdayMon: in file Simple.php, method SimpleCal::weekdayMon()
Calls weekday() with 'mon' (as in Monday).
weekdaySat: in file Simple.php, method SimpleCal::weekdaySat()
Calls weekday() with 'sat' (as in Saturday).
weekdaySun: in file Simple.php, method SimpleCal::weekdaySun()
Calls weekday() with 'sun' (as in Sunday).
weekdayThu: in file Simple.php, method SimpleCal::weekdayThu()
Calls weekday() with 'thu' (as in Thursday).
weekdayTue: in file Simple.php, method SimpleCal::weekdayTue()
Calls weekday() with 'tue' (as in Tuesday).
weekdayWed: in file Simple.php, method SimpleCal::weekdayWed()
Calls weekday() with 'wed' (as in Wednesday).
WEEK_IN_SECONDS: in file Date.php, constant WEEK_IN_SECONDS
write: in file vCalProperty.php, method vCalProperty::write()
Writes the property out in vCalendar format.
write: in file vCalendar.php, method vCal::write()
Writes a vCalendar message out of the current object.
write: in file vCalEvent.php, method vCalEvent::write()
Writes the event portion of a message out of the current object.

Packages

Classes

Files

Element index for package Date

a

b

c

d

e

f

g

h

i

l

m

n

o

p

q

r

s

t

u

v

w

y