Class CalendarSolution_List_Calendar

Description

The means to output collections of events formatted as a calendar grid with brief info about each event

Intended to show all events in a date range.

See CalendarSolution_List_Calendar::get_rendering() for details.

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

CalendarSolution
   |
   --CalendarSolution_List
      |
      --CalendarSolution_List_Calendar
Variable Summary
string $view
Method Summary
void calculate_months (DateTimeSolution $current, DateTimeSolution $to)
string get_event_formatted ( $event)
string get_month_close (DateTime $current_date_time)
string get_month_open (DateTime $current_date_time)
string get_month_pad_end (int $w)
string get_month_pad_start (int $w)
string get_pad (int $quantity)
string get_rendering ()
string get_row_close ()
string get_row_open ()
void set_from ([mixed $in = null])
Variables
Methods
calculate_months (line 70)

Determine how many months to display

  • access: protected
void calculate_months (DateTimeSolution $current, DateTimeSolution $to)
  • DateTimeSolution $current
  • DateTimeSolution $to
get_event_formatted (line 158)
  • return: the HTML for one event
  • access: protected
string get_event_formatted ( $event)
  • $event
get_month_close (line 107)
  • return: the HTML closing out a month
  • access: protected
string get_month_close (DateTime $current_date_time)
  • DateTime $current_date_time
get_month_open (line 83)
  • return: the HTML for the month header
  • access: protected
string get_month_open (DateTime $current_date_time)
  • DateTime $current_date_time
get_month_pad_end (line 129)
string get_month_pad_end (int $w)
  • int $w: the number in the week of the last day of the given month
get_month_pad_start (line 120)
string get_month_pad_start (int $w)
  • int $w: the number in the week of the first day of the given month
get_pad (line 137)
string get_pad (int $quantity)
  • int $quantity: the number of cells to create
get_rendering (line 237)

Produces a list of events laid out in a calendar grid format

Intended to show all events in a date range.

Defaults to showing all events between the first day of this month 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.

Cascading Style Sheet notes: the month is contained within "table.cs_list_calendar". Each event is wrapped by a "div.cs_item" which has additional multiple class attributes:

  • 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 ()
get_row_close (line 151)
  • return: the HTML for closing a row
  • access: protected
string get_row_close ()
get_row_open (line 144)
  • return: the HTML for opening a row
  • access: protected
string get_row_open ()
set_from (line 57)

Sets the "from" property to the first day of the given month

CalendarSolution_List_Calendar::set_from() defaults to the first day of today's month. CalendarSolution_List::set_from() defaults to today.

NOTE: "from" is reset to "permit_history_date" if "from" is earlier than "permit_history_date"

void set_from ([mixed $in = null])
  • mixed $in:
      • TRUE = use value of $_REQUEST['from'] if it is set,
      use the default if it is invalid, use FALSE if not set
      • FALSE = set the value to FALSE
      • string = a date in YYYY-MM-DD format though uses
      the default if it is invalid

    Redefinition of:
    CalendarSolution_List::set_from()
    Sets the "from" property

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