• UNL
• pear.unl.edu
• UNL_UCBCN_Manager
• API Documentation

UNL_UCBCN_Manager API Documentation

Developers, developers, developers, devel…

[UNL_UCBCN_Manager] element index

__construct

UNL_UCBCN_Manager_Recommend::__construct() in Recommend.php

__construct

UNL_UCBCN_Manager::__construct() in Manager.php

Constructor for the UNL_UCBCN_Manager.

__construct

UNL_UCBCN_Manager_Login::__construct() in Login.php

Constructs the login screen.

__construct

UNL_UCBCN_Manager_EventForm::__construct() in EventForm.php

Constructs the form.

$a

UNL_UCBCN_Manager::$a in Manager.php

Auth object

$account

UNL_UCBCN_Manager::$account in Manager.php

UNL_UCBCN_Account

$author

UNL_UCBCN_Manager_Plugin::$author in Plugin.php

Name of the author of the plugin.

addToCalendar

UNL_UCBCN_Manager_EventForm::addToCalendar() in EventForm.php

Adds an event to the calendar currently in the manager member variable calendar.

AllTests.php

AllTests.php in AllTests.php

$calendar

UNL_UCBCN_Manager::$calendar in Manager.php

UNL_UCBCN_Calendar this user is managing.

$calendars

UNL_UCBCN_Manager_Recommend::$calendars in Recommend.php

Calendars which this user has permission to post events to by permission.

$calendarselect

UNL_UCBCN_Manager::$calendarselect in Manager.php

Indicates which calendars you have access to.

$createAccount

UNL_UCBCN_Manager_setup_postinstall::$createAccount in Manager_setup.php

$createFiles

UNL_UCBCN_Manager_setup_postinstall::$createFiles in Manager_setup.php

$createIndex

UNL_UCBCN_Manager_setup_postinstall::$createIndex in Manager_setup.php

createAccount

UNL_UCBCN_Manager_setup_postinstall::createAccount() in Manager_setup.php

This function will create a calendar account if it does not already exist.

createFiles

UNL_UCBCN_Manager_setup_postinstall::createFiles() in Manager_setup.php

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

$doctitle

UNL_UCBCN_Manager::$doctitle in Manager.php

Title for the page.

$dsn

UNL_UCBCN_Manager_setup_postinstall::$dsn in Manager_setup.php

dircpy

UNL_UCBCN_Manager_setup_postinstall::dircpy() in Manager_setup.php

This function copies files from source to destination.

$events

UNL_UCBCN_Manager_Recommend::$events in Recommend.php

Events to build a recommendation form for.

endSession

UNL_UCBCN_Manager::endSession() in Manager.php

Ends a calendar management session for the current user.

EventForm.php

EventForm.php in EventForm.php

$frontenduri

UNL_UCBCN_Manager::$frontenduri in Manager.php

URI to the public frontend UNL_UCBCN_Frontend

file_str_replace

UNL_UCBCN_Manager_setup_postinstall::file_str_replace() in Manager_setup.php

Replaces text within files.

getCalendarsWithPermission

UNL_UCBCN_Manager_Recommend::getCalendarsWithPermission() in Recommend.php

Returns an array of the allowed permissions by calendar.

getPostedEvents

UNL_UCBCN_Manager::getPostedEvents() in Manager.php

This function returns an array of all posted events.

getRelatedLocationDateAndTimes

UNL_UCBCN_Manager_EventForm::getRelatedLocationDateAndTimes() in EventForm.php

Returns a html table of event date time and locations

index.php

index.php in index.php

init

UNL_UCBCN_Manager_setup_postinstall::init() in Manager_setup.php

Initialize the post-install task.

Login.php

Login.php in Login.php

$manager

UNL_UCBCN_Manager_Plugin::$manager in Plugin.php

Manager running this plugin.

$manager

UNL_UCBCN_Manager_Recommend::$manager in Recommend.php

Management interface to build a recommend page for.

main

UNL_UCBCN_Manager_AllTests::main() in AllTests.php

Runs the test suite.

Manager.php

Manager.php in Manager.php

Manager_setup.php

Manager_setup.php in Manager_setup.php

$name

UNL_UCBCN_Manager_Plugin::$name in Plugin.php

Name for the plugin.

$output

UNL_UCBCN_Manager::$output in Manager.php

Main content of the page sent to the client.

outputData

UNL_UCBCN_Manager_setup_postinstall::outputData() in Manager_setup.php

takes in a string and sends it to the client.

$password_field

UNL_UCBCN_Manager_Login::$password_field in Login.php

Name of the form field for the password

$plugins

UNL_UCBCN_Manager::$plugins in Manager.php

Registered and running plugins.

$post_url

UNL_UCBCN_Manager_Login::$post_url in Login.php

URL to post the form to.

pagerWrapper

UNL_UCBCN_Manager::pagerWrapper() in Manager.php

This function handles pagination of a database query.

PHPUnit_MAIN_METHOD

PHPUnit_MAIN_METHOD in AllTests.php

postProcessPrompts

UNL_UCBCN_Manager_setup_postinstall::postProcessPrompts() in Manager_setup.php

Optionally used to alter responses from the prompted questions.

processPostedEvents

UNL_UCBCN_Manager::processPostedEvents() in Manager.php

Runs actions on the posted events.

processPostStatusChange

UNL_UCBCN_Manager::processPostStatusChange() in Manager.php

Handles the posting of an updated event. This will alter the event's status based on what the user chose within the manager interface.

Plugin.php

Plugin.php in Plugin.php

$recommendable

UNL_UCBCN_Manager_Recommend::$recommendable in Recommend.php

Calendars which this user can recommend events to.

registerPlugin

UNL_UCBCN_Manager::registerPlugin() in Manager.php

Registers a plugin for use within the manager.

run

UNL_UCBCN_Manager_setup_postinstall::run() in Manager_setup.php

Hub for the post-install task.

run

UNL_UCBCN_Manager::run() in Manager.php

This function is the hub for the manager frontend.

Recommend.php

Recommend.php in Recommend.php

$sectitle

UNL_UCBCN_Manager::$sectitle in Manager.php

Section Title

showAccountForm

UNL_UCBCN_Manager::showAccountForm() in Manager.php

Returns a form to edit the current acccount.

showAddUserForm

UNL_UCBCN_Manager::showAddUserForm() in Manager.php

Displays a form to add a user to the system.

showCalendarForm

UNL_UCBCN_Manager::showCalendarForm() in Manager.php

This function returns a form for editing the calendar details.

showCalendars

UNL_UCBCN_Manager::showCalendars() in Manager.php

This function returns a list of calendars for the current account.

showCalendarUsers

UNL_UCBCN_Manager::showCalendarUsers() in Manager.php

This function returns a list of users that have 'some' permission to the current calendar.

showChooseCalendar

UNL_UCBCN_Manager::showChooseCalendar() in Manager.php

This function returns all the calendars this user has access to.

showEventDateTimeForm

UNL_UCBCN_Manager::showEventDateTimeForm() in Manager.php

Returns a form for editing an event date & time instance.

showEventListing

UNL_UCBCN_Manager::showEventListing() in Manager.php

Shows the list of events for the current user.

showEventSubmitForm

UNL_UCBCN_Manager::showEventSubmitForm() in Manager.php

Returns a form for entering/editing an event.

showImportForm

UNL_UCBCN_Manager::showImportForm() in Manager.php

Returns a html form for importing xml/.ics files.

showLoginForm

UNL_UCBCN_Manager::showLoginForm() in Manager.php

Returns login object which will be used for the user to authenticate with.

showPermissionsForm

UNL_UCBCN_Manager::showPermissionsForm() in Manager.php

This function generates and returns a permissions form for the given user and calendar.

showRecommendForm

UNL_UCBCN_Manager::showRecommendForm() in Manager.php

This form allows the user to recommend an event for other calendars.

showSearchResults

UNL_UCBCN_Manager::showSearchResults() in Manager.php

Returns an event listing of search results.

showSubscribeForm

UNL_UCBCN_Manager::showSubscribeForm() in Manager.php

Returns a form for subscribing to a calendar within the system.

showSubscriptions

UNL_UCBCN_Manager::showSubscriptions() in Manager.php

Returns a listing of the subscriptions for the current calendar.

startSession

UNL_UCBCN_Manager::startSession() in Manager.php

Begins a calendar management session for this user.

startup

UNL_UCBCN_Manager_Plugin::startup() in Plugin.php

This will be called when the plugin is initialized on load of a page.

startupPlugins

UNL_UCBCN_Manager::startupPlugins() in Manager.php

This function initializes all plugins.

suite

UNL_UCBCN_Manager_AllTests::suite() in AllTests.php

Adds the UNL_UCBCN_ManagerTest suite.

SubForm.php

SubForm.php in SubForm.php

toHtml

UNL_UCBCN_Manager_SubForm::toHtml() in SubForm.php

renders the element

toHtml

UNL_UCBCN_Manager_EventForm::toHtml() in EventForm.php

Returns an HTML form for an event.

$uniquebody

UNL_UCBCN_Manager::$uniquebody in Manager.php

Unique body ID

$uri

UNL_UCBCN_Manager_Plugin::$uri in Plugin.php

The URI to this plugin.

$uri

UNL_UCBCN_Manager::$uri in Manager.php

URI to the management frontend

$user

UNL_UCBCN_Manager::$user in Manager.php

UNL_UCBCN_User object for the user who is logged in and managing a calendar.

$user_field

UNL_UCBCN_Manager_Login::$user_field in Login.php

Name of the form field for the user.

UNL_UCBCN_Manager

UNL_UCBCN_Manager in Manager.php

Class which handles all event creation and authentication. This class acts as the basis for the management portion of a university event publisher, through which users will log in and create and manage their calendars.

UNL_UCBCN_Manager_AllTests

UNL_UCBCN_Manager_AllTests in AllTests.php

UNL_UCBCN_Manager_EventForm

UNL_UCBCN_Manager_EventForm in EventForm.php

This class generates a form for an Event.

UNL_UCBCN_Manager_Login

UNL_UCBCN_Manager_Login in Login.php

Simple object which will be used to display a login.

UNL_UCBCN_Manager_Plugin

UNL_UCBCN_Manager_Plugin in Plugin.php

Abstract class plugins must extend and implement.

UNL_UCBCN_Manager_Recommend

UNL_UCBCN_Manager_Recommend in Recommend.php

This class handles recommending an event for other calendars.

UNL_UCBCN_Manager_setup_postinstall

UNL_UCBCN_Manager_setup_postinstall in Manager_setup.php

This class can handle all the post installation tasks for the manager.

UNL_UCBCN_Manager_SubForm

UNL_UCBCN_Manager_SubForm in SubForm.php

Makes subforms use the correct renderer and do some minor manupulations.

$version

UNL_UCBCN_Manager_Plugin::$version in Plugin.php

Version of the plugin.