[ Index ]

PHP Cross Reference of Moodle 1.9.3 [Build 15-Oct-2008]

title

Body

[close]

/calendar/ -> lib.php (summary)

(no description)

File Size: 1609 lines (71 kb)
Included or required:0 times
Referenced: 4 times
Includes or requires: 0 files

Defines 35 functions

  calendar_get_mini()
  calendar_get_popup()
  calendar_get_upcoming()
  calendar_add_event_metadata()
  calendar_print_event()
  calendar_get_events()
  calendar_top_controls()
  calendar_filter_controls()
  calendar_day_representation()
  calendar_time_representation()
  calendar_get_link_href()
  calendar_get_link_tag()
  calendar_get_link_previous()
  calendar_get_link_next()
  calendar_wday_name()
  calendar_days_in_month()
  calendar_get_sideblock_upcoming()
  calendar_add_month()
  calendar_sub_month()
  calendar_events_by_day()
  calendar_get_module_cached()
  calendar_get_course_cached()
  calendar_session_vars()
  calendar_overlib_html()
  calendar_set_referring_course()
  calendar_set_filters()
  calendar_edit_event_allowed()
  calendar_get_default_courses()
  calendar_preferences_button()
  calendar_format_event_time()
  calendar_print_month_selector()
  calendar_get_filters_status()
  calendar_set_filters_status()
  calendar_get_allowed_types()
  calendar_user_can_add_event()

Functions
Functions that are not part of a class:

calendar_get_mini($courses, $groups, $users, $cal_month = false, $cal_year = false)   X-Ref
No description

calendar_get_popup($is_today, $event_timestart, $popupcontent='')   X-Ref
calendar_get_popup, called at multiple points in from calendar_get_mini.
Copied and modified from calendar_get_mini.

param: $is_today bool, false except when called on the current day.
param: $event_timestart mixed, $events[$eventid]->timestart, OR false if there are no events.
param: $popupcontent string.
return: $popup string, contains onmousover and onmouseout events.

calendar_get_upcoming($courses, $groups, $users, $daysinfuture, $maxevents, $fromtime=0)   X-Ref
No description

calendar_add_event_metadata($event)   X-Ref
No description

calendar_print_event($event)   X-Ref
No description

calendar_get_events($tstart, $tend, $users, $groups, $courses, $withduration=true, $ignorehidden=true)   X-Ref
Get calendar events

param: int $tstart Start time of time range for events
param: int $tend   End time of time range for events
param: array/int/boolean $users array of users, user id or boolean for all/no user events
param: array/int/boolean $groups array of groups, group id or boolean for all/no group events
param: array/int/boolean $courses array of courses, course id or boolean for all/no course events
param: boolean $withduration whether only events starting within time range selected
param: boolean $ignorehidden whether to select only visible events or all events
return: array of selected events or an empty array if there aren't any (or there was an error)

calendar_top_controls($type, $data)   X-Ref
No description

calendar_filter_controls($type, $vars = NULL, $course = NULL, $courses = NULL)   X-Ref
No description

calendar_day_representation($tstamp, $now = false, $usecommonwords = true)   X-Ref
No description

calendar_time_representation($time)   X-Ref
No description

calendar_get_link_href($linkbase, $d, $m, $y)   X-Ref
TODO document


calendar_get_link_tag($text, $linkbase, $d, $m, $y)   X-Ref
TODO document


calendar_get_link_previous($text, $linkbase, $d, $m, $y, $accesshide=false)   X-Ref
Build and return a previous month HTML link, with an arrow.

param: string $text The text label.
param: string $linkbase The URL stub.
param: int $d $m $y Day of month, month and year numbers.
param: bool $accesshide Default visible, or hide from all except screenreaders.
return: string HTML string.

calendar_get_link_next($text, $linkbase, $d, $m, $y, $accesshide=false)   X-Ref
Build and return a next month HTML link, with an arrow.

param: string $text The text label.
param: string $linkbase The URL stub.
param: int $d $m $y Day of month, month and year numbers.
param: bool $accesshide Default visible, or hide from all except screenreaders.
return: string HTML string.

calendar_wday_name($englishname)   X-Ref
No description

calendar_days_in_month($month, $year)   X-Ref
No description

calendar_get_sideblock_upcoming($events, $linkhref = NULL)   X-Ref
No description

calendar_add_month($month, $year)   X-Ref
No description

calendar_sub_month($month, $year)   X-Ref
No description

calendar_events_by_day($events, $month, $year, &$eventsbyday, &$durationbyday, &$typesbyday, &$courses)   X-Ref
No description

calendar_get_module_cached(&$coursecache, $modulename, $instance)   X-Ref
No description

calendar_get_course_cached(&$coursecache, $courseid)   X-Ref
No description

calendar_session_vars($course=null)   X-Ref
No description

calendar_overlib_html()   X-Ref
No description

calendar_set_referring_course($courseid)   X-Ref
No description

calendar_set_filters(&$courses, &$group, &$user, $courseeventsfrom = NULL, $groupeventsfrom = NULL, $ignorefilters = false)   X-Ref
No description

calendar_edit_event_allowed($event)   X-Ref
No description

calendar_get_default_courses($ignoreref = false)   X-Ref
No description

calendar_preferences_button()   X-Ref
No description

calendar_format_event_time($event, $now, $morehref, $usecommonwords = true, $showtime=0)   X-Ref
No description

calendar_print_month_selector($name, $selected)   X-Ref
No description

calendar_get_filters_status()   X-Ref
No description

calendar_set_filters_status($packed_bitfield)   X-Ref
No description

calendar_get_allowed_types(&$allowed)   X-Ref
No description

calendar_user_can_add_event()   X-Ref
see if user can add calendar entries at all
used to print the "New Event" button

return: bool



Generated: Wed Jan 14 11:33:29 2009 Cross-referenced by PHPXref 0.7