Class CalendarSolution_List_Title

Description

The means to output collections of events formatted as a table of the date and name of each event

Intended to show a limited number of occurrences of Featured Events on Home Pages or other Featured Pages.

See CalendarSolution_List_Title::get_rendering() for details.

Located in /include/CalendarSolution/List/Title.php (line 27)

CalendarSolution
   |
   --CalendarSolution_List
      |
      --CalendarSolution_List_Title
Variable Summary
string $date_format
string $view
Method Summary
string get_css_name ()
string get_event_formatted (array $event)
string get_list_close ()
string get_list_open ()
string get_rendering ([int $page_id = null])
string get_row_close ()
string get_row_open ( $class)
Variables
string $date_format = self::DATE_FORMAT_SHORT (line 35)

Format for PHP's date() function, to be used by our format_date() method

string $view = 'Title' (line 41)

The type of view this class represents

  • access: protected

Inherited Variables

Inherited from CalendarSolution_List

CalendarSolution_List::$cache_count_key
CalendarSolution_List::$cache_key
CalendarSolution_List::$called_set_prior_and_next_dates
CalendarSolution_List::$called_set_request_properties
CalendarSolution_List::$category_id
CalendarSolution_List::$category_id_not
CalendarSolution_List::$data
CalendarSolution_List::$frequent_event_id
CalendarSolution_List::$frequent_event_id_not
CalendarSolution_List::$from
CalendarSolution_List::$interval_spec
CalendarSolution_List::$is_own_event
CalendarSolution_List::$limit_quantity
CalendarSolution_List::$limit_start
CalendarSolution_List::$next_from
CalendarSolution_List::$next_to
CalendarSolution_List::$page_id
CalendarSolution_List::$permit_future_date
CalendarSolution_List::$permit_history_date
CalendarSolution_List::$prior_from
CalendarSolution_List::$prior_to
CalendarSolution_List::$show_cancelled
CalendarSolution_List::$show_location
CalendarSolution_List::$show_own_events_first
CalendarSolution_List::$show_summary
CalendarSolution_List::$time_format
CalendarSolution_List::$to
CalendarSolution_List::$total_rows
CalendarSolution_List::$where_sql

Inherited from CalendarSolution

CalendarSolution::$cache
CalendarSolution::$cache_available
CalendarSolution::$csrf_token_name
CalendarSolution::$http_host
CalendarSolution::$sql
CalendarSolution::$uri
CalendarSolution::$use_cache
Methods
get_css_name (line 49)

Provides the path and name of the needed Cascading Style Sheet file

  • return: the path and name of the CSS file
  • access: public
string get_css_name ()

Redefinition of:
CalendarSolution_List::get_css_name()
Provides the path and name of the needed Cascading Style Sheet file
get_event_formatted (line 86)
  • return: the HTML for one event
  • access: protected
string get_event_formatted (array $event)
  • array $event: an associative array of a given event
get_list_close (line 63)
  • return: the HTML for closing a list
  • access: protected
string get_list_close ()
get_list_open (line 56)
  • return: the HTML for opening a list
  • access: protected
string get_list_open ()
get_rendering (line 146)

Produces a table of events showing their dates and names

Intended to show a limited number of occurrences of Featured Events on Home Pages or other Featured Pages.

NOTE: This method does NOT automatically check web browsers' requests for what data each user is looking for. When using CalendarSolution_List::get_date_navigation() or CalendarSolution_List::get_limit_form() on the BOTTOM of the calendar output, it is necessary to manually execute CalendarSolution_List::set_request_properties() BEFORE calling this method.

Cascading Style Sheet notes: the list is contained within "table.cs_list_title". Each event is wrapped by a "tr" element, which has multiple class attributes:

  • Row: cs_row_0, cs_row_1
  • Status (Open, Full, Cancelled): cs_status_O, cs_status_F, cs_status_C
  • Changed: cs_changed_Y, cs_changed_N
  • Organizer: cs_is_own_event_Y, cs_is_own_event_N

string get_rendering ([int $page_id = null])
  • int $page_id: the feature_on_page_id to limit the list to, if any
get_row_close (line 77)
  • return: the HTML for closing a row
  • access: protected
string get_row_close ()
get_row_open (line 70)
  • return: the HTML for opening a row
  • access: protected
string get_row_open ( $class)
  • $class

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:44 -0400 by phpDocumentor 1.4.4