The parent class for displaying collections of events
Located in /include/CalendarSolution/List.php (line 20)
CalendarSolution | --CalendarSolution_List
Class | Description |
---|---|
CalendarSolution_List_MonthTitle | The means to output collections of events formatted as a table of the date and name of each event and is grouped by month |
CalendarSolution_List_Ul | The means to output collections of events formatted as an "unordered list" of the date and name of each event |
CalendarSolution_List_Calendar | The means to output collections of events formatted as a calendar grid with brief info about each event |
CalendarSolution_List_QuickTable | The means to output collections of events formatted as a table with basic info about each entry |
CalendarSolution_List_Title | The means to output collections of events formatted as a table of the date and name of each event |
CalendarSolution_List_Icalendar | The means to output collections of events formatted as a set of iCalendar VEVENT entries |
CalendarSolution_List_List | The means to output collections of events formatted as a table with significant info about each event |
CalendarSolution_List_DetailTable | The means to output collections of events formatted as a table with details about each entry |
The cache key identifying the number of rows found in a data set
The data cache key for the current view
Has set_prior_and_next_dates() been called?
Has set_request_properties() been called?
The category ids to show events for
The category ids to not show events for
The records to be displayed
The frequent event id to show events for
The frequent event id to not show events for
The start of the date range to show events for in the current request
The DateIntervalSolution specification for how many months to show at once
Only show events sponsored by you ("Y") or only those sponsored by another organization ("N")?
All events are shown if this is empty.
The number of items to show
The zero-based row index to start the limit on
The start of the date range to show events for if the user navigates
to later events
The end of the date range to show events for if the user navigates
to later events
The page id to show events for
The furthest date in the future users are allowed to see
The furthest date in the past users are allowed to see
The start of the date range to show events for if the user navigates
to earlier events
The end of the date range to show events for if the user navigates
to earlier events
Should cancelled events be shown or not?
Should the Location field be shown or not when viewing "Calendar" mode?
NOTE: needs to be in CalendarSolution_List class due to ability switch between Calendar and List views.
Show your own events before events produced by other organizations?
Should the Summary field be shown or not when viewing "List" mode?
NOTE: needs to be in CalendarSolution_List class due to ability switch between Calendar and List views.
Format for PHP's date() function, to be used by our format_date() method
The end of the date range to show events for in the current request
How many rows the entire result set has
The SQL WHERE clause for the current view
Inherited from CalendarSolution
CalendarSolution::$cache
CalendarSolution::$cache_available
CalendarSolution::$csrf_token_name
CalendarSolution::$http_host
CalendarSolution::$sql
CalendarSolution::$uri
CalendarSolution::$use_cache
Looks at $_REQUEST['view'] then $_COOKIE['CalendarSolution'] to determine whether to return a CalendarSolution_List_Calendar (the default) or CalendarSolution_List_List object
WARNING: this function sets a cookie, so MUST be called before ANY output is sent to the browser.
Calls the parent constructor and set_uri() then populates the "$interval_spec" property
Produces the HTML for changing between "List" and "Calendar" formats
Provides the path and name of the needed Cascading Style Sheet file
Produces the HTML for navigating to earlier and later events
Inteneded for use with the "Calendar," "List," and "MonthTitle" formats.
NOTE: will return an empty string if "$from" or "$to" are false.
Produces the HTML for the form people can use to pick date ranges and particular events
NOTE: "datelist" will not be displayed if "$from", "$to", "$permit_history_date", or "$permit_future_date" are false.
Produces the prior/next links for use in conjunction with set_limit()
For this navigation to work properly, set_limit()'s "$start" parameter must be set to NULL. For example: set_limit(10, null).
NOTE: This must be called after get_rendering(). An empty string will be returned if called before get_rendering().
Figures out what link should be shown for this item
Says which view class is being used
Creates a DateIntervalSolution object indicating how many months should be displayed at one time
Assembles the query string then executes it
Sets the "category_id" property to the appropriate value
Sets the "category_id_not" property to the appropriate value
Sets the date format to be used by our format_date() method
Sets the "frequent_event_id" property to the appropriate value
Sets the "frequent_event_id_not" property to the appropriate value
Sets the "from" property
CalendarSolution_List::set_from() defaults to today. CalendarSolution_List_Calendar::set_from() defaults to the first day of today's month.
NOTE: "from" is reset to "permit_history_date" if "from" is earlier than "permit_history_date"
Sets the "is_own_event" property to the appropriate value
"Y" means only show events sponsored by your organization. "N" means only show events sponsored by other organizations. All events are shown if this is empty/unset/false.
Sets the "limit_quantity" and "limit_start" properties
Intended for use with the "QuickTable" and "Title" formats.
To have lists show only the first ten events: set_limit(10)
To have lists show the first ten events and possibly show navigation to later events: set_limit(10, null). One must also call get_limit_navigation() to get the navigation to show up.
Sets the Featured Page "page_id" property to the appropriate value
Sets the furthest date in the future users are allowed to see
NOTE: if the "to" property is later than this, "to" is reset to this.
Sets the furthest date in the past users are allowed to see
NOTE: if the "from" property is earlier than this, "from" is reset to this.
Sets the properties used later when generating the navigation elements for getting to earlier and later events
NOTE: Does nothing if "$from" or "$to" are false.
Sets all properties that can be populated with $_REQUEST data, but does so only for properties that have not been set yet
Should cancelled events be shown or not?
Turns the Location field on or off when showing the "Calendar" format
Show your own events before events produced by other organizations?
Items are normally sorted by date then start time. Enabling this option still sorts items by date, but within each day your events are shown first, sorted by time, then events by organizations are shown sorted by time.
Turns the Summary field on or off when showing the "List" format
Sets the time format to be used by our format_date() method
Sets the "to" property (defaults to the last day of the month occurring $interval_spec months from today)
NOTE: "to" is reset to "permit_future_date" if "to" is later than "permit_future_date".
Generates the SQL WHERE clause and cache keys for data retrieval
This has been separated out from run_query() to facilitate cache lookups by the various get_rendering() methods.
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()
Inherited from CalendarSolution
CalendarSolution::DATE_FORMAT_FULL
CalendarSolution::DATE_FORMAT_ICALENDAR
CalendarSolution::DATE_FORMAT_LONG
CalendarSolution::DATE_FORMAT_MEDIUM
CalendarSolution::DATE_FORMAT_NAME_NUMBER
CalendarSolution::DATE_FORMAT_SHORT
CalendarSolution::DATE_FORMAT_TIME_12AP
CalendarSolution::DATE_FORMAT_TIME_24
CalendarSolution::DATE_FORMAT_TIME_ICALENDAR
CalendarSolution::LINK_TO_CALENDAR_URI
CalendarSolution::LINK_TO_DETAIL_PAGE
CalendarSolution::LINK_TO_FREQUENT_EVENT_URI
CalendarSolution::LINK_TO_NONE
CalendarSolution::STATUS_CANCELLED
CalendarSolution::STATUS_FULL
CalendarSolution::STATUS_OPEN
Documentation generated on Wed, 21 Mar 2012 14:16:43 -0400 by phpDocumentor 1.4.4