Moodle APIs 4.0
Moodle 4.0.11 (Build: 20231009)
Functions
deprecatedlib.php File Reference

deprecatedlib.php - Old functions retained only for backward compatibility More...

Functions

 add_event ()
 CALENDAR MANAGEMENT ////////////////////////////////////////////////////////////////.
 
 add_mod_to_section ()
 
 add_to_log ()
 
 ajaxenabled ()
 
 allow_assign ()
 
 allow_override ()
 
 allow_switch ()
 
 badges_get_issued_badge_info ()
 
 blog_get_context_url ()
 
 build_context_path ()
 
 build_logs_array ()
 
 build_navigation ()
 
 calculate_user_dst_table ()
 
 calendar_cron ()
 
 calendar_get_all_allowed_types ()
 
 calendar_get_block_upcoming ()
 
 calendar_get_mini ()
 
 calendar_get_upcoming ()
 
 calendar_import_icalendar_events ($ical, $unused=null, $subscriptionid=null)
 Import events from an iCalendar object into a course calendar.
 
 calendar_normalize_tz ()
 
 calendar_preferences_button ()
 
 calendar_print_month_selector ()
 
 calendar_process_subscription_row ($subscriptionid, $pollinterval, $action)
 Update a subscription from the form data in one of the rows in the existing subscriptions table.
 
 calendar_wday_name ()
 
 can_use_html_editor ()
 
 can_use_rotated_text ()
 
 category_delete_full ()
 
 category_delete_move ()
 
 check_browser_operating_system ()
 
 check_browser_version ()
 
 check_gd_version ()
 
 choose_from_menu ()
 
 clam_change_log ()
 
 clam_handle_infected_file ()
 
 clam_log_infected ()
 
 clam_log_upload ()
 
 clam_message_admins ()
 
 clam_replace_infected_file ()
 
 clam_scan_moodle_file ()
 
 cleanup_contexts ()
 
 cohort_get_visible_list ()
 
 completion_cron ()
 
 context_instance_preload ()
 
 context_instance_preload_sql ()
 
 context_moved ()
 
 convert_tabrows_to_tree ()
 
 convert_tree_to_html ()
 
 count_login_failures ()
 
 course_category_hide ()
 
 course_category_show ()
 
 course_get_cm_rename_action ()
 
 course_scale_used ()
 
 coursemodule_visible_for_user ()
 
 coursetag_delete_course_tags ()
 
 coursetag_delete_keyword ()
 
 coursetag_get_all_tags ()
 
 coursetag_get_jscript ()
 
 coursetag_get_jscript_links ()
 
 coursetag_get_records ()
 
 coursetag_get_tagged_courses ()
 
 coursetag_get_tags ()
 
 coursetag_store_keywords ()
 
 create_contexts ()
 
 create_course_category ()
 
 cron_bc_hack_plugin_functions ($plugintype, $plugins)
 Used to add in old-style cron functions within plugins that have not been converted to the new standard API.
 
 cron_execute_plugin_type ($plugintype, $description=null)
 Executes cron functions for a specific type of plugin.
 
 cron_run_single_task (\core\task\scheduled_task $task)
 Runs a single cron task.
 
 css_is_colour ()
 
 css_is_width ()
 
 css_minify_css ()
 
 css_sort_by_count ()
 
 current_theme ()
 
 dedupe_user_access ()
 
 delete_context ()
 
 delete_course_module ()
 
 delete_event ()
 
 detect_munged_arguments ()
 
 dst_changes_for_year ()
 
 enrol_cohort_can_view_cohort ()
 
 enrol_cohort_enrol_all_users ()
 
 enrol_cohort_get_cohorts ()
 
 enrol_cohort_search_cohorts ()
 
 error ()
 
 events_cleanup ()
 
 events_cron ()
 
 events_dequeue ()
 
 events_dispatch ()
 
 events_get_cached ()
 
 events_get_handlers ()
 
 events_is_registered ()
 
 events_load_def ()
 
 events_pending_count ()
 
 events_process_queued_handler ()
 
 events_queue_handler ()
 
 events_trigger ()
 
 events_trigger_legacy ()
 
 events_uninstall ()
 
 events_update_definition ()
 
 external_function_info ()
 
 fetch_context_capabilities ()
 
 filter_text ()
 
 format_weeks_get_section_dates ()
 
 formerr ()
 
 generate_email_supportuser ()
 
 get_all_mods ()
 
 get_all_sections ()
 
 get_all_subcategories ()
 
 get_all_user_name_fields ($returnsql=false, $tableprefix=null, $prefix=null, $fieldprefix=null, $order=false)
 A centralised location for the all name fields.
 
 get_array_of_activities (int $courseid, bool $usecache=false)
 For a given course, returns an array of course activity objects Each item in the array contains he following properties:
 
 get_browser_version_classes ()
 
 get_categories ()
 
 get_category_courses_array ()
 
 get_category_courses_array_recursively ()
 
 get_child_categories ()
 
 get_child_contexts ()
 
 get_clam_error_code ()
 
static get_component_directory ($component)
 Return exact absolute path to a plugin directory.
 
 get_context_instance ($contextlevel, $instance=0, $strictness=IGNORE_MISSING)
 Get the context instance as an object.
 
 get_context_instance_by_id ()
 
 get_context_url ()
 
 get_contextlevel_name ()
 
 get_core_subsystems ($fullpaths=false)
 List all core subsystems and their location.
 
 get_course_category ()
 
 get_course_category_tree ()
 
 get_course_context ()
 
 get_course_participants ()
 
 get_course_section ()
 
 get_courseid_from_context ()
 
 get_courses_page ()
 
 get_courses_wmanagers ()
 
 get_current_group ()
 
 get_device_cfg_var_name ()
 
 get_device_type ()
 
 get_device_type_list ()
 
 get_extra_user_fields ($context, $already=array())
 Checks if current user is shown any extra fields when listing users.
 
 get_extra_user_fields_sql ($context, $alias='', $prefix='', $already=array())
 If the current user is to be shown extra user fields when listing or selecting users, returns a string suitable for including in an SQL select clause to retrieve those fields.
 
 get_file_url ()
 
 get_generic_section_name ()
 
 get_list_of_timezones ()
 
 get_logs ()
 
 get_logs_usercourse ()
 
 get_logs_userday ()
 
 get_module_metadata ($course, $modnames, $sectionreturn=null)
 Retrieve all metadata for the requested modules.
 
 get_parent_contextid ()
 
 get_parent_contexts ()
 
static get_plugin_directory ($plugintype, $pluginname)
 Returns the exact absolute path to plugin directory.
 
static get_plugin_list ($plugintype)
 Get list of plugins of given type.
 
static get_plugin_list_with_class ($plugintype, $class, $file=null)
 Get a list of all the plugins of a given type that define a certain class in a certain file.
 
 get_plugin_list_with_file ()
 
 get_plugin_types ($fullpaths=true)
 Lists all plugin types.
 
 get_print_section_cm_text ()
 
 get_recent_enrolments ()
 
 get_records_csv ()
 
 get_referer ()
 
 get_related_contexts_string ()
 
 get_role_context_caps ()
 
 get_roles_on_exact_context ()
 
 get_roles_with_assignment_on_context ()
 
 get_selected_theme_for_device_type ()
 
 get_system_context ($cache=true)
 Returns system context or null if can not be created yet.
 
 get_timezone_offset ()
 
 get_timezone_record ()
 
 get_user_access_sitewide ()
 
 get_user_courses_bycap ()
 
 get_user_device_type ()
 
 get_user_field_name ($field)
 Returns the display name of a field in the user table.
 
 get_user_timezone_offset ()
 
 grade_print_tabs ($active_type, $active_plugin, $plugin_info, $return=false)
 Print grading plugin selection tab-based navigation.
 
 groupmode ()
 This means that cm_info::$groupmode should be ignored and cm_info::$coursegroupmode be used instead.
 
 groups_course_module_visible ()
 
 groups_filter_users_by_course_module_visible ()
 
 groups_get_all_groups_for_courses ()
 
 hide_event ()
 
 httpsrequired ()
 
 is_course_participant ()
 
 is_web_crawler ()
 
 js_minify ()
 
 load_course_context ()
 
 load_role_access_by_context ()
 
 make_categories_list ()
 
 make_categories_options ()
 Returns the list of full course categories to be used in html_writer::select()
 
 make_editing_buttons ()
 
 mark_context_dirty ()
 
 message_add_contact ()
 
 message_block_contact ()
 
 message_can_delete_message ()
 
 message_can_post_message ()
 
 message_contact_link ()
 
 message_count_blocked_users ()
 
 message_count_messages ()
 
 message_current_user_is_involved ()
 
 message_delete_message ()
 
 message_get_blocked_users ()
 
 message_get_contact ()
 
 message_get_contact_add_remove_link ()
 
 message_get_contact_block_link ()
 
 message_get_contacts ()
 
 message_get_course_contexts ()
 
 message_get_fragment ()
 
 message_get_history ()
 
 message_get_recent_conversations ($userorid, $limitfrom=0, $limitto=100)
 
 message_get_recent_notifications ()
 
 message_history_link ()
 
 message_is_user_blocked ()
 
 message_is_user_non_contact_blocked ()
 
 message_mark_message_read ()
 
 message_mark_messages_read ()
 
 message_move_userfrom_unread2read ()
 
 message_remove_contact ()
 
 message_remove_url_params ()
 
 message_search ()
 
 message_shorten_message ()
 
 message_unblock_contact ()
 
 move_category ()
 
 mygroupid ()
 
 navmenu ()
 
static normalize_component ($component)
 Normalize the component name using the "frankenstyle" rules.
 
 notify ()
 
 password_compat_not_supported ()
 
 preload_course_contexts ()
 
 prevent_form_autofill_password ()
 
object print_arrow ($direction='up', $strsort=null, $return=false)
 Returns an image of an up or down arrow, used for column sorting.
 
 print_category_info ()
 
 print_checkbox ()
 
 print_container ()
 
 print_container_end ()
 
 print_container_start ()
 
 print_context_name ()
 
 print_continue ()
 
 print_course ()
 
 print_course_search ()
 
 print_courses ()
 
 print_grade_plugin_selector ($plugin_info, $active_type, $active_plugin, $return=false)
 Print grading plugin selection popup form.
 
 print_header ()
 
 print_header_simple ()
 
 print_log ()
 
 print_log_csv ()
 
 print_log_ods ()
 
 print_log_xls ()
 
 print_mnet_log ()
 
 print_my_moodle ()
 
 print_navigation ()
 
 print_overview ()
 
 print_recent_activity ()
 
 print_remote_course ()
 
 print_remote_host ()
 
 print_scale_menu_helpbutton ()
 
 print_section ()
 
 print_section_add_menus ()
 
 print_side_block ()
 
 print_textarea ()
 
 print_whole_category_list ()
 
 profile_display_badges ()
 
 put_records_csv ()
 
 question_add_tops ()
 
 question_is_only_toplevel_category_in_context ()
 
 rebuild_contexts ()
 
 report_insights_context_insights (\context $context)
 
 reset_login_count ()
 
 session_get_instance ()
 
 session_get_realuser ()
 
 session_is_legacy ()
 
 session_is_loggedinas ()
 
 session_kill ()
 
 session_kill_all ()
 
 session_kill_user ()
 
 session_loginas ()
 
 session_set_user ()
 
 session_touch ()
 
 set_current_group ()
 
 set_user_device_type ()
 
 show_event ()
 
 site_scale_used ()
 
 skip_main_destination ()
 
 tag_add ()
 
 tag_assign ()
 
 tag_autocomplete ()
 
 tag_bulk_delete_instances ()
 
 tag_cleanup ()
 
 tag_cloud_sort ()
 
 tag_compute_correlations ()
 
 tag_cron ()
 
 tag_delete ()
 
 tag_delete_instance ()
 
 tag_delete_instances ()
 
 tag_description_set ()
 
 tag_display_name ()
 
 tag_find_records ()
 
 tag_find_tags ()
 
 tag_get ()
 
 tag_get_correlated ()
 
 tag_get_id ()
 
 tag_get_name ()
 
 tag_get_related_tags ()
 
 tag_get_related_tags_csv ()
 
 tag_get_tags ()
 
 tag_get_tags_array ()
 
 tag_get_tags_csv ()
 
 tag_get_tags_ids ()
 
 tag_normalize ()
 
 tag_print_cloud ()
 
 tag_print_description_box ()
 
 tag_print_management_box ()
 
 tag_print_search_box ()
 
 tag_print_search_results ()
 
 tag_print_tagged_users_table ()
 
 tag_print_user_box ()
 
 tag_print_user_list ()
 
 tag_process_computed_correlation ()
 
 tag_record_count ()
 
 tag_record_tagged_with ()
 
 tag_rename ()
 
 tag_set ()
 
 tag_set_add ()
 
 tag_set_delete ()
 
 tag_set_flag ()
 
 tag_type_set ()
 
 tag_unset_flag ()
 
 textlib_get_instance ()
 
object unzip_file ($zipfile, $destination='', $showstatus_ignored=true)
 Unzip one zip file to a destination dir Both parameters must be FULL paths If destination isn't specified, it will be the SAME directory where the zip file resides.
 
 update_category_button ()
 
 update_event ()
 
 update_log_display_entry ()
 
 update_login_count ()
 
 update_module_button ()
 
 update_timezone_records ()
 
 user_get_participants ($courseid, $groupid, $accesssince, $roleid, $enrolid, $statusid, $search, $additionalwhere='', $additionalparams=array(), $sort='', $limitfrom=0, $limitnum=0)
 Returns the participants for a given course.
 
 user_get_participants_sql ($courseid, $groupid=0, $accesssince=0, $roleid=0, $enrolid=0, $statusid=-1, $search='', $additionalwhere='', $additionalparams=array())
 Returns the SQL used by the participants table.
 
 user_get_total_participants ($courseid, $groupid=0, $accesssince=0, $roleid=0, $enrolid=0, $statusid=-1, $search='', $additionalwhere='', $additionalparams=array())
 Returns the total number of participants for a given course.
 
 useredit_shared_definition_preferences ()
 
object zip_files ($originalfiles, $destination)
 Zip an array of files/dirs to a destination zip file Both parameters must be FULL paths to the files/dirs.
 

Detailed Description

deprecatedlib.php - Old functions retained only for backward compatibility

Old functions retained only for backward compatibility. New code should not use any of these functions.

@subpackage deprecated

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
Deprecated: