UNL_UCBCN_Frontend API Documentation

Developers, developers, developers, devel…

Class UNL_UCBCN_Frontend_Search

Description

Container for search results for the frontend.

PHP version 5

author: Brett Bieber <brett.bieber@gmail.com>
copyright: 2009 Regents of the University of Nebraska
link: http://code.google.com/p/unl-event-publisher/
license: BSD License

Located in /UNL/UCBCN/Frontend/Search.php (line 32)

UNL_UCBCN
   |
   --UNL_UCBCN_Frontend
      |
      --UNL_UCBCN_Frontend_Search

Variable Summary

object UNL_UCBCN_Calendar $calendar

mixed $endtime

UNL_UCBCN_EventListing $output

string $query

mixed $starttime

mixed $url

Method Summary

UNL_UCBCN_Frontend_Search __construct ([array $options = array()])

string getURL ()

void run ()

Variables

object UNL_UCBCN_Calendar $calendar (line 39)

Calendar we are searching

access: public

Redefinition of:

UNL_UCBCN_Frontend::$calendar: Calendar UNL_UCBCN_Calendar Object

mixed $endtime (line 63)

end time to search

access: public

UNL_UCBCN_EventListing $output (line 46)

Listing of matching events or error.

access: public

Redefinition of:

UNL_UCBCN_Frontend::$output: Main content of the page sent to the client.

string $query (line 53)

actual search string user entered

access: public

mixed $starttime (line 58)

Start time to search

access: public

mixed $url (line 66)

URL to this search results page.

access: public

Inherited Variables

Inherited from UNL_UCBCN_Frontend

UNL_UCBCN_Frontend::$day
UNL_UCBCN_Frontend::$eventdatetime_id
UNL_UCBCN_Frontend::$format
UNL_UCBCN_Frontend::$manageruri
UNL_UCBCN_Frontend::$month
UNL_UCBCN_Frontend::$right
UNL_UCBCN_Frontend::$sectitle
UNL_UCBCN_Frontend::$uniquebody
UNL_UCBCN_Frontend::$uri
UNL_UCBCN_Frontend::$uriformat
UNL_UCBCN_Frontend::$view
UNL_UCBCN_Frontend::$year

Methods

Constructor __construct (line 73)

Constructs this search output.

access: public

UNL_UCBCN_Frontend_Search __construct ([array $options = array()])

array $options: Associative array of options.

Redefinition of:

UNL_UCBCN_Frontend::__construct(): Constructor for the frontend.

getURL (line 142)

returns the url to this search page.

access: public

string getURL ()

run (line 90)

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.

Text searches: Title, Description, Location

access: public

void run ()

Redefinition of:

UNL_UCBCN_Frontend::run(): Runs/builds the frontend object with the display parameters set.

Inherited Methods

Inherited From UNL_UCBCN_Frontend

UNL_UCBCN_Frontend::__construct()
UNL_UCBCN_Frontend::dayHasEvents()
UNL_UCBCN_Frontend::dbStringToHtml()
UNL_UCBCN_Frontend::determineView()
UNL_UCBCN_Frontend::displayImage()
UNL_UCBCN_Frontend::formatURL()
UNL_UCBCN_Frontend::getCacheKey()
UNL_UCBCN_Frontend::getCalendarID()
UNL_UCBCN_Frontend::getCalendarsByStatus()
UNL_UCBCN_Frontend::getCalendarShortname()
UNL_UCBCN_Frontend::getEventInstance()
UNL_UCBCN_Frontend::getEventTypes()
UNL_UCBCN_Frontend::preRun()
UNL_UCBCN_Frontend::reformatURL()
UNL_UCBCN_Frontend::run()
UNL_UCBCN_Frontend::uriFormat()