Class CalendarSolution_List_Icalendar

Description

The means to output collections of events formatted as a set of iCalendar VEVENT entries

Intended to show all events in a date range.

See CalendarSolution_List_Icalendar::get_rendering() for details.

Located in /include/CalendarSolution/List/Icalendar.php (line 28)

CalendarSolution
   |
   --CalendarSolution_List
      |
      --CalendarSolution_List_Icalendar
Variable Summary
string $view
Method Summary
string get_event_formatted (array $event)
string get_list_close ()
string get_list_open ()
string get_rendering ()
string get_row_close ()
string get_row_open ()
Variables
Methods
get_event_formatted (line 71)
string get_event_formatted (array $event)
  • array $event: an associative array of a given event
get_list_close (line 46)
  • return: the HTML for closing a list
  • access: protected
string get_list_close ()
get_list_open (line 39)
  • return: the HTML for opening a list
  • access: protected
string get_list_open ()
get_rendering (line 103)

Produces a list of events in iCalendar format

Intended to show all events in a date range.

Defaults to showing all events between today and the last day of the month two months from today. The date range can be adjusted using set_from() and set_to().

This method automatically checks web browsers' requests to determine what data each user is looking for. See CalendarSolution_List::set_request_properties() for specifics.

string get_rendering ()
get_row_close (line 60)
  • return: the HTML for closing a row
  • access: protected
string get_row_close ()
get_row_open (line 53)
  • return: the HTML for opening a row
  • access: protected
string get_row_open ()

Inherited Methods

Inherited From CalendarSolution_List

CalendarSolution_List::__construct()
CalendarSolution_List::factory_chosen_view()
CalendarSolution_List::get_change_view()
CalendarSolution_List::get_css_name()
CalendarSolution_List::get_date_navigation()
CalendarSolution_List::get_limit_form()
CalendarSolution_List::get_limit_navigation()
CalendarSolution_List::get_link()
CalendarSolution_List::get_view()
CalendarSolution_List::interval_singleton()
CalendarSolution_List::run_query()
CalendarSolution_List::set_category_id()
CalendarSolution_List::set_category_id_not()
CalendarSolution_List::set_date_format()
CalendarSolution_List::set_frequent_event_id()
CalendarSolution_List::set_frequent_event_id_not()
CalendarSolution_List::set_from()
CalendarSolution_List::set_is_own_event()
CalendarSolution_List::set_limit()
CalendarSolution_List::set_page_id()
CalendarSolution_List::set_permit_future_months()
CalendarSolution_List::set_permit_history_months()
CalendarSolution_List::set_prior_and_next_dates()
CalendarSolution_List::set_request_properties()
CalendarSolution_List::set_show_cancelled()
CalendarSolution_List::set_show_location()
CalendarSolution_List::set_show_own_events_first()
CalendarSolution_List::set_show_summary()
CalendarSolution_List::set_time_format()
CalendarSolution_List::set_to()
CalendarSolution_List::set_where_sql()

Inherited From CalendarSolution

CalendarSolution::__construct()
CalendarSolution::convert_windows_characters()
CalendarSolution::escape_data_for_html()
CalendarSolution::escape_for_icalendar()
CalendarSolution::flush_cache()
CalendarSolution::format_date()
CalendarSolution::get_admin_navigation()
CalendarSolution::get_credit()
CalendarSolution::get_css()
CalendarSolution::get_date_from_request()
CalendarSolution::get_errors()
CalendarSolution::get_event_formatted_icalendar()
CalendarSolution::get_int_array_from_request()
CalendarSolution::get_int_from_request()
CalendarSolution::get_string_from_request()
CalendarSolution::is_admin()
CalendarSolution::is_cache_available()
CalendarSolution::set_data_empty()
CalendarSolution::set_data_from_post()
CalendarSolution::set_uri()
CalendarSolution::validate_csrf_token()
Class Constants

Documentation generated on Wed, 21 Mar 2012 14:16:43 -0400 by phpDocumentor 1.4.4