Skip Navigation

UNL
pear.unl.edu
UNL_UCBCN_Frontend
API Documentation

UNL_UCBCN_Frontend API Documentation

Developers, developers, developers, devel…

[UNL_UCBCN_Frontend] element index

_

__construct: UNL_UCBCN_Frontend_Upcoming::__construct() in Upcoming.php

Constructs an upcoming event view for this calendar.
__construct: UNL_UCBCN_Frontend_Week::__construct() in Week.php

Constructs this week object.
__construct: UNL_UCBCN_Frontend_Year::__construct() in Year.php

Constructor for a year calendar.
__construct: UNL_UCBCN_Frontend_Search::__construct() in Search.php

Constructs this search output.
__construct: UNL_UCBCN_Frontend_NoEvents::__construct() in NoEvents.php

Constructs an object when no events are present
__construct: UNL_UCBCN_Frontend::__construct() in Frontend.php

Constructor for the frontend.
__construct: UNL_UCBCN_Frontend_Month::__construct() in Month.php

This function constructs the month widget and populates the heading, caption, footer and body for the MonthWidget.
__construct: UNL_UCBCN_Frontend_MonthWidget::__construct() in MonthWidget.php

This function constructs the month widget and populates the heading, caption, footer and body for the MonthWidget.
__construct: UNL_UCBCN_Frontend_Day::__construct() in Day.php

Constructor for an individual day.

a

AllTests.php: AllTests.php in AllTests.php

c

$calendar: UNL_UCBCN_Frontend_Search::$calendar in Search.php

Calendar we are searching
$calendar: UNL_UCBCN_Frontend_Upcoming::$calendar in Upcoming.php

Calendar UNL_UCBCN_Calendar Object
$calendar: UNL_UCBCN_Frontend_Week::$calendar in Week.php

Calendar to show events for UNL_UCBCN_Month object
$calendar: UNL_UCBCN_Frontend_Year::$calendar in Year.php

Calendar to display year for.
$calendar: UNL_UCBCN_Frontend_MonthWidget::$calendar in MonthWidget.php

Calendar UNL_UCBCN_Calendar Object
$calendar: UNL_UCBCN_Frontend_Month::$calendar in Month.php

Calendar to show events for UNL_UCBCN_Month object
$calendar: UNL_UCBCN_Frontend::$calendar in Frontend.php

Calendar UNL_UCBCN_Calendar Object
$calendar: UNL_UCBCN_Frontend_Day::$calendar in Day.php

Calendar UNL_UCBCN_Calendar Object
$caption: UNL_UCBCN_Frontend_MonthWidget::$caption in MonthWidget.php

Caption for the month widget.
$createFiles: UNL_UCBCN_Frontend_setup_postinstall::$createFiles in Frontend_setup.php
$createIndex: UNL_UCBCN_Frontend_setup_postinstall::$createIndex in Frontend_setup.php
createFiles: UNL_UCBCN_Frontend_setup_postinstall::createFiles() in Frontend_setup.php

This function creates/upgrades the template files, as well as the sample index page.

d

$day: UNL_UCBCN_Frontend_Week::$day in Week.php

Day included in the week the user is viewing.
$day: UNL_UCBCN_Frontend::$day in Frontend.php

Day to show events for
$day: UNL_UCBCN_Frontend_Day::$day in Day.php

Day to show events for
$dsn: UNL_UCBCN_Frontend_setup_postinstall::$dsn in Frontend_setup.php
dailyEventCount: UNL_UCBCN_Frontend_MonthWidget::dailyEventCount() in MonthWidget.php

Determines the days of this month with events.
dayHasEvents: UNL_UCBCN_Frontend::dayHasEvents() in Frontend.php

This function checks if a calendar has events on the day requested.
dbStringToHtml: UNL_UCBCN_Frontend::dbStringToHtml() in Frontend.php

This function converts a string stored in the database to html output.
determineView: UNL_UCBCN_Frontend::determineView() in Frontend.php

This function attempts to determine the view parameters for the frontend output.
dircpy: UNL_UCBCN_Frontend_setup_postinstall::dircpy() in Frontend_setup.php

This function copies files from source to destination.
displayImage: UNL_UCBCN_Frontend::displayImage() in Frontend.php

When the image view is set, the image for a given event will be displayed to the end user. $_GET['id'] must be set to the event.id which has the image.
Day.php: Day.php in Day.php

e

$endtime: UNL_UCBCN_Frontend_Search::$endtime in Search.php

end time to search
$eventdatetime_id: UNL_UCBCN_Frontend::$eventdatetime_id in Frontend.php

Specific eventdatetime_id (if used)
EventListing_icalendar.tpl.php: EventListing_icalendar.tpl.php in EventListing_icalendar.tpl.php
EventListing_rss.tpl.php: EventListing_rss.tpl.php in EventListing_rss.tpl.php

f

$firstDay: UNL_UCBCN_Frontend_Week::$firstDay in Week.php

start day of the week 0 = Sunday
$format: UNL_UCBCN_Frontend::$format in Frontend.php

format of view
file_str_replace: UNL_UCBCN_Frontend_setup_postinstall::file_str_replace() in Frontend_setup.php

Replaces text within files.
findOngoingEvents: UNL_UCBCN_Frontend_MonthWidget::findOngoingEvents() in MonthWidget.php

This function finds ongoing events for the given month.
formatURL: UNL_UCBCN_Frontend::formatURL() in Frontend.php

Returns a formatted URL.
Frontend.php: Frontend.php in Frontend.php
Frontend_setup.php: Frontend_setup.php in Frontend_setup.php

g

getCacheKey: UNL_UCBCN_Frontend::getCacheKey() in Frontend.php

Get's a uniqe key for this object for reference in cache.
getCacheKey: UNL_UCBCN_Frontend_MonthWidget::getCacheKey() in MonthWidget.php

Returns a string identifying this month widget.
getCalendarID: UNL_UCBCN_Frontend::getCalendarID() in Frontend.php

Gets the calendar id from a shortname.
getCalendarsByStatus: UNL_UCBCN_Frontend::getCalendarsByStatus() in Frontend.php

Get a list of calendars with a given status
getCalendarShortname: UNL_UCBCN_Frontend::getCalendarShortname() in Frontend.php

Returns a calendar shortname for the calendar with the given ID.
getEventInstance: UNL_UCBCN_Frontend::getEventInstance() in Frontend.php

Gets the specified event instance.
getEventTypes: UNL_UCBCN_Frontend::getEventTypes() in Frontend.php

Get a list of event types
getURL: UNL_UCBCN_Frontend_Week::getURL() in Week.php

Returns the permanent URL to this specific week.
getURL: UNL_UCBCN_Frontend_Upcoming::getURL() in Upcoming.php

Get a permanent URL to this object.
getURL: UNL_UCBCN_Frontend_Search::getURL() in Search.php

returns the url to this search page.
getURL: UNL_UCBCN_Frontend_Day::getURL() in Day.php

Returns the permanent URL to this specific day.

i

index.php: index.php in index.php
init: UNL_UCBCN_Frontend_setup_postinstall::init() in Frontend_setup.php

Initialize the post-install task.

l

$limit: UNL_UCBCN_Frontend_Upcoming::$limit in Upcoming.php

Limit the number of records.

m

$manageruri: UNL_UCBCN_Frontend::$manageruri in Frontend.php

URI to the management interface UNL_UCBCN_Manager
$message: UNL_UCBCN_Frontend_NoEvents::$message in NoEvents.php

no events message
$month: UNL_UCBCN_Frontend_Month::$month in Month.php

Month the user is viewing.
$month: UNL_UCBCN_Frontend_MonthWidget::$month in MonthWidget.php

Month for this month widget.
$month: UNL_UCBCN_Frontend_Week::$month in Week.php

Month the user is viewing.
$month: UNL_UCBCN_Frontend_Day::$month in Day.php

Month the user is viewing.
$month: UNL_UCBCN_Frontend::$month in Frontend.php

Month the user is viewing.
$monthwidgets: UNL_UCBCN_Frontend_Year::$monthwidgets in Year.php

Array of month widgets - UNL_UCBCN_Frontend_MonthWidget
main: UNL_UCBCN_Frontend_AllTests::main() in AllTests.php

Runs the test suite.
makepackage.php: makepackage.php in makepackage.php
Month.php: Month.php in Month.php
MonthWidget.php: MonthWidget.php in MonthWidget.php

n

$next_url: UNL_UCBCN_Frontend_Day::$next_url in Day.php

URL to the next day
$next_url: UNL_UCBCN_Frontend_Week::$next_url in Week.php

URL to the next week
$noevents: UNL_UCBCN_Frontend_Upcoming::$noevents in Upcoming.php

Message for when no upcoming events are found.
$noevents: UNL_UCBCN_Frontend_Day::$noevents in Day.php

no events message
NoEvents.php: NoEvents.php in NoEvents.php

o

$ongoing: UNL_UCBCN_Frontend_Week::$ongoing in Week.php

Display ongoing events?
$ongoing: UNL_UCBCN_Frontend_Day::$ongoing in Day.php

Display ongoing events?
$output: UNL_UCBCN_Frontend_Day::$output in Day.php

Listing of events on this day.
$output: UNL_UCBCN_Frontend_Upcoming::$output in Upcoming.php

Listing of events on this day.
$output: UNL_UCBCN_Frontend_Search::$output in Search.php

Listing of matching events or error.
$output: UNL_UCBCN_Frontend_Week::$output in Week.php

Listing of events on this week. This will be an array of 7 UNL_UCBCN_Frontend_Day objects.
$output: UNL_UCBCN_Frontend::$output in Frontend.php

Main content of the page sent to the client.
outputData: UNL_UCBCN_Frontend_setup_postinstall::outputData() in Frontend_setup.php

takes in a string and sends it to the client.

p

$prev_url: UNL_UCBCN_Frontend_Week::$prev_url in Week.php

URL to the previous week
$prev_url: UNL_UCBCN_Frontend_Day::$prev_url in Day.php

URL to the previous day
PHPUnit_MAIN_METHOD: PHPUnit_MAIN_METHOD in AllTests.php
postProcessPrompts: UNL_UCBCN_Frontend_setup_postinstall::postProcessPrompts() in Frontend_setup.php

Optionally used to alter responses from the prompted questions.
preRun: UNL_UCBCN_Frontend::preRun() in Frontend.php

This function is called before the run() function to handle any details prior to populating the data in the object, and sends output headers.
preRun: UNL_UCBCN_Frontend_MonthWidget::preRun() in MonthWidget.php

Runs before any output is sent or object is built.

q

$query: UNL_UCBCN_Frontend_Search::$query in Search.php

actual search string user entered

r

$right: UNL_UCBCN_Frontend::$right in Frontend.php

Right column (usually the month widget)
reformatURL: UNL_UCBCN_Frontend::reformatURL() in Frontend.php

This function is for reformmating URL address. IE, you have the url to the object, but simply want to change the format to ics etc.
run: UNL_UCBCN_Frontend_setup_postinstall::run() in Frontend_setup.php

Hub for the post-install task.
run: UNL_UCBCN_Frontend_MonthWidget::run() in MonthWidget.php

This function populates the month widget... checks for each day of this month whether the day has events.
run: UNL_UCBCN_Frontend_Search::run() in Search.php

Runs the query on the database from the calendar, currently supports two types of searches - textual or date and time hinted by passing a string supported by the strtotime() function.
run: UNL_UCBCN_Frontend::run() in Frontend.php

Runs/builds the frontend object with the display parameters set.

s

$sectitle: UNL_UCBCN_Frontend::$sectitle in Frontend.php

Section Title
$starttime: UNL_UCBCN_Frontend_Search::$starttime in Search.php

Start time to search
showEventListing: UNL_UCBCN_Frontend_Upcoming::showEventListing() in Upcoming.php

UNL_UCBCN_EventListing of events.
showEventListing: UNL_UCBCN_Frontend_Day::showEventListing() in Day.php

Shows the listing of new events for this day.
showOngoingEventListing: UNL_UCBCN_Frontend_Day::showOngoingEventListing() in Day.php

Returns the listing of ongoing events for this day.
showWeek: UNL_UCBCN_Frontend_Week::showWeek() in Week.php

Populates the output with the days for the events in this week.
suite: UNL_UCBCN_Frontend_AllTests::suite() in AllTests.php

Adds the UNL_UCBCN_FrontendTest suite.
Search.php: Search.php in Search.php

t

$tbody: UNL_UCBCN_Frontend_MonthWidget::$tbody in MonthWidget.php

Body for the table
$thead: UNL_UCBCN_Frontend_MonthWidget::$thead in MonthWidget.php

Header for the table

u

$uniquebody: UNL_UCBCN_Frontend::$uniquebody in Frontend.php

Unique body ID
$uri: UNL_UCBCN_Frontend::$uri in Frontend.php

URI to the management frontend
$uriformat: UNL_UCBCN_Frontend::$uriformat in Frontend.php

Format of URI's querystring|rest
$url: UNL_UCBCN_Frontend_Upcoming::$url in Upcoming.php

URL to the listing of upcoming events.
$url: UNL_UCBCN_Frontend_Week::$url in Week.php

URL to this view.
$url: UNL_UCBCN_Frontend_Day::$url in Day.php

URL of events on this day.
$url: UNL_UCBCN_Frontend_Search::$url in Search.php

URL to this search results page.
Upcoming.php: Upcoming.php in Upcoming.php
UNL_UCBCN_Frontend: UNL_UCBCN_Frontend in Frontend.php

This is the basic frontend output class through which all output to the public is generated. This class handles the determination of what view the user requested and what information to send.
UNL_UCBCN_Frontend_AllTests: UNL_UCBCN_Frontend_AllTests in AllTests.php
UNL_UCBCN_Frontend_Day: UNL_UCBCN_Frontend_Day in Day.php

Object for the view of a single day for a calendar.
UNL_UCBCN_Frontend_Month: UNL_UCBCN_Frontend_Month in Month.php

Object for a month view of the calendar.
UNL_UCBCN_Frontend_MonthWidget: UNL_UCBCN_Frontend_MonthWidget in MonthWidget.php

Class defines a month widget, basically a table with 30 boxes representing the days in the month. Days which have events will be selected.
UNL_UCBCN_Frontend_NoEvents: UNL_UCBCN_Frontend_NoEvents in NoEvents.php

Object for the view of a single day for a calendar.
UNL_UCBCN_Frontend_Search: UNL_UCBCN_Frontend_Search in Search.php

Container for search results for the frontend.
UNL_UCBCN_Frontend_setup_postinstall: UNL_UCBCN_Frontend_setup_postinstall in Frontend_setup.php

This is the post install setup script for the frontend.
UNL_UCBCN_Frontend_Upcoming: UNL_UCBCN_Frontend_Upcoming in Upcoming.php

A list of upcoming events for a calendar.
UNL_UCBCN_Frontend_Week: UNL_UCBCN_Frontend_Week in Week.php

Constructs a week view for the calendar.
UNL_UCBCN_Frontend_Year: UNL_UCBCN_Frontend_Year in Year.php

Generates a year view for the public frontend.
uriFormat: UNL_UCBCN_Frontend::uriFormat() in Frontend.php

Sets and/or returns the uri format.

v

$view: UNL_UCBCN_Frontend::$view in Frontend.php

View to be displayed

w

$weeks: UNL_UCBCN_Frontend_Month::$weeks in Month.php

Contains an array of Frontend_Day objects
Week.php: Week.php in Week.php

y

$year: UNL_UCBCN_Frontend_Week::$year in Week.php

Year the user is viewing.
$year: UNL_UCBCN_Frontend_Year::$year in Year.php

Year to show events for.
$year: UNL_UCBCN_Frontend_Day::$year in Day.php

Year the user is viewing.
$year: UNL_UCBCN_Frontend_MonthWidget::$year in MonthWidget.php

Year for this month widget
$year: UNL_UCBCN_Frontend_Month::$year in Month.php

Year the user is viewing.
$year: UNL_UCBCN_Frontend::$year in Frontend.php

Year the user is viewing.
Year.php: Year.php in Year.php

Your Feedback

Share This Page

UNL web templates and quality assurance provided by the Web Developer Network

| W3C | CSS