Moodle PHP Documentation 4.1
Moodle 4.1.11 (Build: 20240610) (c8c84b4af18)
Todo List
Member $defaultCharset

Make this a non-static property or pass as parameter to static methods in Horde 6.

Make this a non-static property or pass as parameter to static methods in Horde 6.

Member $mailbox
Make this a Horde_Imap_Client_Mailbox object.
Member _fix_course_cats ($children, &$sortorder, $parent, $depth, $path, &$fixcontexts)
Document the arguments of this function better
Member add_indented_names ($categories, $nochildrenof=-1)
Final deprecation on Moodle 4.4 MDL-72438
Member admin_setting_configmulticheckbox::output_html ($data, $query='')
Add vartype handling to ensure $data is an array
Member admin_setting_configmultiselect::output_html ($data, $query='')
Add vartype handling to ensure $data is an array
Member admin_setting_courselist_frontpage::output_html ($data, $query='')
Add vartype handling to make sure $data is an array
Member admin_setting_gradecat_combo::output_html ($data, $query='')
Add vartype handling to ensure $data is array
Member admin_setting_gradecat_combo::write_setting ($data)
Add vartype handling to ensure $data is array
Member admin_setting_ldap_rolemapping::output_html ($data, $query='')
Add vartype handling to ensure $data is an array
Member ADODB_mssql_n::_appendN ($inboundData)
This function should raise an ADOdb error if one of the transformations fail
Member advanced_testcase::createArrayDataSet (array $data)
This will be removed for Moodle 4.2 as part of MDL-69882.
Member advanced_testcase::createCsvDataSet ($files, $delimiter=',', $enclosure='"', $escape = '"')
This will be removed for Moodle 4.2 as part of MDL-69882.
Member advanced_testcase::createXMLDataSet ($xmlFile)
This will be removed for Moodle 4.2 as part of MDL-69882.
Member advanced_testcase::loadDataSet (phpunit_dataset $dataset)
This will be removed for Moodle 4.2 as part of MDL-69882.
Member assign_get_completion_state ($course, $cm, $userid, $type)
MDL-71196 Final deprecation in Moodle 4.3
Member auth_plugin_base::get_title ()
Document this function
Member base_controller::get_copy ()
MDL-75026 This method will be deleted in Moodle 4.5
Member base_controller::set_copy (\stdClass $data)
MDL-75025 This method will be deleted in Moodle 4.5
Class base_setting_ui

extend as required for restore

Member behat_calendar_deprecated::i_click_day_of_this_month_in_calendar ($day)
MDL-73117 This will be deleted in Moodle 4.4.
Member behat_calendar_deprecated::i_hover_over_day_of_this_month_in_calendar ($day)
MDL-73117 This will be deleted in Moodle 4.4.
Member behat_context_helper::set_session (Environment $environment)
MDL-55365 This will be deleted in Moodle 3.6.
Member behat_enrol_deprecated::i_add_enrolment_method_with ($enrolmethod, TableNode $table)
MDL-71733 This will be deleted in Moodle 4.4.
Member block_html_pluginfile ($course, $birecord_or_cm, $context, $filearea, $args, $forcedownload, array $options=array())
MDL-36050 improve capability check on stick blocks, so we can check user capability before sending images.
Member block_manager::get_secondarynav (block_base $block)
MDL-74939 Remove support for old 'local::views::secondary' class location
Member block_recent_activity::get_recent_enrolments ()
MDL-36993 this function always return empty array
Member blocks_remove_inappropriate ($course)
Write/Fix this function. Currently returns immediately
Member build ($exts=array())
Change default of $exts to null.
Member cache_helper::invalidate_by_definition ($component, $area, array $identifiers=array(), $keys=array())
Invalidating by definition should also add to the event cache so that sessions can be invalidated (when required).
Class cache_session
we should support locking in the session as well. Should be pretty simple to set up.
Member camelize ($word, $firstLetter='upper')
Do we want locale-specific or locale-independent camel casing?
Member chat_portfolio_caller::prepare_package ()
Document this function
Member check_php_version ($version='5.2.4')
Check PHP version being required here is it too low?
Member choice_get_completion_state ($course, $cm, $userid, $type)
MDL-71196 Final deprecation in Moodle 4.3
Class core\encryption
MDL-71421 Remove the openssl part in Moodle 4.2.
Member core\hub\site_registration_form::add_select_with_email ($elementname, $stridentifier, $options=null, $highlight=false)
MDL-71472 - Will be deleted in 4.3
Class core\task\legacy_plugin_cron_task
MDL-61165 This will be deleted in Moodle 4.1
Member core\task\manager::ensure_adhoc_task_qos (array $records)
MDL-74843 This method will be deleted in Moodle 4.5
Member core_analytics\manager::add_builtin_models ()
Remove this method in Moodle 3.11 (MDL-65186).
Class core_backup\copy\copy
MDL-75022 This class will be deleted in Moodle 4.5
Member core_backup\copy\copy::create_copy ()
MDL-75023 This method will be deleted in Moodle 4.5
Member core_backup\copy\copy::get_copies (int $userid, int $courseid=0)
MDL-75024 This method will be deleted in Moodle 4.5
Member core_badges_renderer::print_badge_tabs ($badgeid, $context, $current='overview')
MDL-73426 Final deprecation.
Member core_cache\output\renderer::lock_summaries (array $locks)
Add some actions so that people can configure lock instances.
Member core_calendar\external\calendar_event_exporter::get_module_timestamp_max_limit (\DateTimeInterface $starttime, $max)
final deprecation. To be removed in Moodle 3.10
Member core_calendar\external\calendar_event_exporter::get_module_timestamp_min_limit (\DateTimeInterface $starttime, $min)
final deprecation. To be removed in Moodle 3.10
Member core_calendar_renderer::fake_block_threemonths (calendar_information $calendar)
MDL-73117 This will be deleted in Moodle 4.4.
Member core_course_category::preload_course_contacts (&$courses)
MDL-38596 minimize number of queries to preload contacts for the list of courses
Member core_course_management_renderer::course_search_form ($value='')
Final deprecation MDL-73975
Member core_course_management_renderer::management_heading ($heading, $viewmode=null, $categoryid=null)
Final deprecation MDL-73975
Member core_course_renderer::course_section_cm_completion ($course, &$completioninfo, cm_info $mod, $displayoptions=array())
MDL-71183 Final deprecation in Moodle 4.3.
Member core_courseformat\base::instance ($courseorid)
MDL-35727 use MUC for caching of instances, limit the number of cached instances
Member core_files_renderer::fm_js_template_listfilename ()
MDL-32736 remove onclick="return false;"
Member core_grades_external::create_gradecategory (int $courseid, string $fullname, array $options)
MDL-71325 This will be deleted in Moodle 4.3.
Member core_grades_external::create_gradecategory_parameters ()
MDL-71325 This will be deleted in Moodle 4.3.
Member core_grades_external::create_gradecategory_returns ()
MDL-71325 This will be deleted in Moodle 4.3.
Member core_h5p\file_storage::EDITOR_FILEAREA
MDL-69530 This will be deleted in Moodle 4.2.
Member core_message\output\preferences\notification_list_processor::export_for_template (\renderer_base $output)
Remove loggedin and loggedoff from context on MDL-73284.
Member core_message_external::get_preferences_structure ()
Remove loggedin and loggedoff from processors structure on MDL-73284.
Member core_question\local\bank\bulk_action_base::get_bulk_action_key ()
Final deprecation on Moodle 4.5 MDL-72438
Member core_question\local\bank\view::end_table ()
Final deprecation on Moodle 4.4 MDL-72438
Member core_question\local\bank\view::preview_question_url ($questiondata)
Final deprecation on Moodle 4.4 MDL-72438
Member core_question\local\bank\view::process_actions ()
Final deprecation on Moodle 4.4 MDL-72438
Member core_question\local\bank\view::process_actions_needing_ui ()
Final deprecation on Moodle 4.4 MDL-72438
Member core_question\local\bank\view::start_table ()
Final deprecation on Moodle 4.4 MDL-72438
Member core_question_bank_renderer::qbank_chooser ($real, $fake, $course, $hiddenparams)
Final deprecation on Moodle 4.4 MDL-72438
Member core_question_bank_renderer::qbank_chooser_qtype ($qtype, $classes=array())
Final deprecation on Moodle 4.4 MDL-72438
Member core_question_bank_renderer::qbank_chooser_title ($title, $identifier=null)
Final deprecation on Moodle 4.4 MDL-72438
Member core_question_bank_renderer::qbank_chooser_types ($types)
Final deprecation on Moodle 4.4 MDL-72438
Member core_question_bank_renderer::render_qbank_chooser (renderable $qbankchooser)
Final deprecation on Moodle 4.4 MDL-72438
Member core_question_external::submit_tags_form ($questionid, $contextid, $formdata)
Final deprecation on Moodle 4.4 MDL-72438
Member core_question_external::submit_tags_form_is_deprecated ()
Final deprecation on Moodle 4.4 MDL-72438
Member core_question_external::submit_tags_form_parameters ()
Final deprecation on Moodle 4.4 MDL-72438
Member core_question_external::submit_tags_form_returns ()
Final deprecation on Moodle 4.4 MDL-72438
Member core_question_output_fragment_tags_form ($args)
Final deprecation on Moodle 4.4 MDL-72438
Member core_question_renderer::question_preview_link ($questionid, context $context, $showlabel)
Final deprecation on Moodle 4.4 MDL-72438
Member core_rtlcss::processDeclaration ($node)
Remove the dir-rtl flipping when dir-rtl is fully deprecated.
Member core_text::reset_caches ()
To be removed in Moodle 4.4 - MDL-71748
Class core_user

move api's from user/lib.php and deprecate old ones.

Member core_webservice_renderer::documentation_html ($functions, $printableformat, $activatedprotocol, $authparams, $parenturl='/webservice/wsdoc.php')
MDL-76078 - Incorrect inter-communication, core cannot have plugin dependencies like this.
Member core_webservice_renderer::rest_param_description_html ($paramdescription, $paramstring)
MDL-76078 - Incorrect inter-communication, core cannot have plugin dependencies like this.
Member core_webservice_renderer::xmlrpc_param_description_html ($paramdescription, $indentation="")
MDL-76078 - Incorrect inter-communication, core cannot have plugin dependencies like this.
Member create_new_question_button ($categoryid, $params, $caption, $tooltip='', $disabled=false)
Final deprecation of this class in moodle 4.4 MDL-72438
Member create_user_record ($username, $password, $auth='manual')
Outline auth types and provide code example
Member cron_bc_hack_plugin_functions ($plugintype, $plugins)
MDL-61165 This will be deleted in Moodle 4.1.
Member cron_execute_plugin_type ($plugintype, $description=null)
MDL-61165 This will be deleted in Moodle 4.1.
Member data_delete_site_preset ($name)
MDL-75189 This will be deleted in Moodle 4.5.
Member data_get_available_presets ($context)
MDL-75189 This will be deleted in Moodle 4.5.
Member data_get_available_site_presets ($context, array $presets=array())
MDL-75189 This will be deleted in Moodle 4.5.
Member data_get_completion_state ($course, $cm, $userid, $type)
MDL-71196 Final deprecation in Moodle 4.3
Class data_import_preset_zip_form
MDL-75189 This will be deleted in Moodle 4.5.
Class data_preset_existing_importer
MDL-75189 Final deprecation in Moodle 4.5.
Class data_preset_importer
MDL-75189 Final deprecation in Moodle 4.5.
Member data_preset_name ($shortname, $path)
MDL-75189 This will be deleted in Moodle 4.5.
Class data_preset_upload_importer
MDL-75189 Final deprecation in Moodle 4.5.
Member data_presets_export ($course, $cm, $data, $tostorage=false)
MDL-75189 This will be deleted in Moodle 4.5.
Member data_presets_generate_xml ($course, $cm, $data)
MDL-75189 This will be deleted in Moodle 4.5.
Member data_presets_save ($course, $cm, $data, $path)
MDL-75189 This will be deleted in Moodle 4.5.
Member data_print_template ($templatename, $records, $data, $search='', $page=0, $return=false, moodle_url $jumpurl=null)
MDL-75189 Final deprecation in Moodle 4.5.
Member data_user_can_delete_preset ($context, $preset)
MDL-75189 This will be deleted in Moodle 4.5.
Member data_view ($data, $course, $cm, $context)
MDL-75189 Final deprecation in Moodle 4.5.
Class dml_transaction_exception
MDL-20625 Use the info from $transaction for debugging purposes.
Member doSendEncode ($alist, array $opts=array())
Implement with traits.
Member draw_rand_array ($array, $draws)
Finish documenting this function
Member embed ($options='', $native=false)
If the dimensions for media:content are defined, use them when width/height are set to 'auto'.
Member endecrypt ($pwd, $data, $case)
Finish documenting this function
Member environment_results::strToReport ($string, $class)
Document this function
Member feedback_get_completion_state ($course, $cm, $userid, $type)
MDL-71196 Final deprecation in Moodle 4.3
Member file_correct_filepath ($str)
review this function
Member file_encode_url ($urlbase, $path, $forcedownload=false, $https=false)
MDL-31071 deprecate this function $CFG
Member file_extension_icon ($filename, $size=NULL)

MDL-31074 When an $OUTPUT->icon method is available this function should be altered to conform with that.

MDL-31074 Implement $size

Member file_get_drafarea_folders ($draftitemid, $filepath, &$data)
MDL-31073 use normal return value instead, this does not fit the rest of api here (skodak)
Member file_info::copy_to_pathname ($pathname)
MDL-31068 implement move() rename() unzip() zip()
Member file_info_context_user::get_area_user_backup ($itemid, $filepath, $filename)
MDL-31091 maybe we need new caability for access control
Member file_info_context_user::get_area_user_private ($itemid, $filepath, $filename)
MDL-31070 this method should respect $CFG->userquota
Member file_mimetype_icon ($mimetype, $size=NULL)
MDL-31074 When an $OUTPUT->icon method is available this function should be altered to conform with that.
Member file_pluginfile ($relativepath, $forcedownload, $preview=null, $offline=false, $embed=false)
MDL-31088 file serving improments
Member file_postupdate_standard_filemanager ($data, $field, array $options, $context, $component, $filearea, $itemid)

MDL-31073 review this function

Member flatten_category_tree (&$categories, $id, $depth=0, $nochildrenof=-1)
Final deprecation on Moodle 4.4 MDL-72438
Class form_filemanager
do not use this abstraction (skodak)
Member forum_get_completion_state ($course, $cm, $userid, $type)
MDL-71196 Final deprecation in Moodle 4.3
Member forum_get_recent_mod_activity (&$activities, &$index, $timestart, $courseid, $cmid, $userid=0, $groupid=0)
Document this functions args
Member forum_update_subscriptions_button ($courseid, $forumid)
MDL-73956 Final deprecation in Moodle 4.4
Member get_categories_for_contexts ($contexts, $sortorder='parent, sortorder, name ASC', $top=false)
Final deprecation on Moodle 4.4 MDL-72438
Member get_context_instance ($contextlevel, $instance=0, $strictness=IGNORE_MISSING)
This will be deleted in Moodle 2.8, refer MDL-34472
Member get_directory_list ($rootdir, $excludefiles='', $descend=true, $getdirs=false, $getfiles=true)
Finish documenting this function. Add examples of $excludefile usage.
Member get_enclosure ($key=0, $prefer=null)
Add ability to prefer one type of content over another (in a media group).
Member get_enclosures ()

Add support for end-user defined sorting of enclosures by type/handler (so we can prefer the faster-loading FLV over MP4).

If an element exists at a level, but its value is empty, we should fall back to the value from the parent (if it exists).

Member get_max_upload_file_size ($sitebytes=0, $coursebytes=0, $modulebytes=0, $unused=false)
Finish documenting this function
Member getBytes ($approx=false)
Remove $approx parameter.
Member getSize ($approx=false)
Remove $approx parameter.
Member global_navigation::module_extends_navigation ($modname)
(MDL-25290) A shared caching solution should be used to save details on what extends navigation.
Member glossary_get_completion_state ($course, $cm, $userid, $type)
MDL-71196 Final deprecation in Moodle 4.3
Member HTMLPurifier_AttrDef_CSS_Composite::$defs
Make protected
Member HTMLPurifier_AttrDef_CSS_Multiple::$max
Make protected
Member HTMLPurifier_AttrDef_CSS_Multiple::$single
Make protected
Member HTMLPurifier_AttrDef_Enum::$valid_values
Make protected
Member HTMLPurifier_CSSDefinition::setupConfigStuff ($config)
Refactor duplicate elements into common class (probably using composition, not inheritance).
Member HTMLPurifier_DefinitionCache_Serializer::generateBaseDirectoryPath ($config)
Make protected
Member HTMLPurifier_DefinitionCache_Serializer::generateDirectoryPath ($config)
Make protected
Member HTMLPurifier_DefinitionCache_Serializer::generateFilePath ($config)
Make protected
Member HTMLPurifier_Filter_ExtractStyleBlocks::preFilter ($html, $config, $context)
Extend to indicate non-text/css style blocks
Member HTMLPurifier_Generator::escape ($string, $quote=null)
This really ought to be protected, but until we have a facility for properly generating HTML here w/o using tokens, it stays public.
Member HTMLPurifier_HTMLDefinition::parseTinyMCEAllowedList ($list)
Give this its own class, probably static interface
Member HTMLPurifier_HTMLModule_Tidy::setup ($config)
Wildcard matching and error reporting when an added or subtracted fix has no effect.
Member HTMLPurifier_Language::$_loaded
Make it private, fix usage in HTMLPurifier_LanguageTest
Member HTMLPurifier_Language::formatMessage ($key, $args=array())
Implement conditionals? Right now, some messages make reference to line numbers, but those aren't always available
Member HTMLPurifier_Lexer::extractBody ($html)
Consider making protected
Member HTMLPurifier_Lexer::normalize ($html, $config, $context)
Consider making protected
Member HTMLPurifier_Lexer_DOMLex::createStartNode ($node, &$tokens, $collect, $config)
data and tagName properties don't seem to exist in DOMNode?
Member HTMLPurifier_Printer_HTMLDefinition::listifyObjectList ($array)
Also add information about internal state
Member is_directory_a_preset ($directory)
MDL-75189 This will be deleted in Moodle 4.5.
Member is_in_popup ()
Use a central function to create the popup calls all over Moodle and In the moment only works with resources and probably questions.
Member lesson_add_header_buttons ($cm, $context, $extraeditbuttons=false, $lessonpageid=null)
MDL-73545 This will be deleted in Moodle 4.4
Member lesson_get_completion_state ($course, $cm, $userid, $type)
MDL-71196 Final deprecation in Moodle 4.3
Member logstore_legacy\log\store::__construct (\tool_log\log\manager $manager)
MDL-52805 This is to be removed in Moodle 3.10
Member logstore_legacy\log\store::dispose ()
MDL-52805 This will be removed in Moodle 3.10
Member logstore_legacy\log\store::get_events_select ($selectwhere, array $params, $sort, $limitfrom, $limitnum)
MDL-52805 This will be removed in Moodle 3.10
Member logstore_legacy\log\store::get_events_select_count ($selectwhere, array $params)
MDL-52805 This will be removed in Moodle 3.10
Member logstore_legacy\log\store::get_events_select_iterator ($selectwhere, array $params, $sort, $limitfrom, $limitnum)
MDL-52805 This will be removed in Moodle 3.10
Member logstore_legacy\log\store::get_log_event ($data)
MDL-52805 This will be removed in Moodle 3.10
Member logstore_legacy\log\store::is_logging ()
MDL-52805 This will be removed in Moodle 3.10
Member logstore_legacy\log\store::legacy_add_to_log ($courseid, $module, $action, $url, $info, $cm, $user, $ip=null, $time=null)
MDL-52805 This will be removed in Moodle 3.3
Member make_categories_options ()
This will be finally removed for Moodle 4.2 as part of MDL-69124.
Member make_grades_menu ($gradingtype)
Finish documenting this function or better deprecated this completely!
Member make_unique_id_code ($extra='')
Finish documenting this function
Member MESSAGE_DEFAULT_LOGGEDIN
Remove on MDL-73284.
Member MESSAGE_DEFAULT_LOGGEDOFF
Remove on MDL-73284.
Member MESSAGE_DEFAULT_PERMITTED
Remove on MDL-73284.
Member mnetservice_enrol::get_remote_publishers ()

once the MNet core is refactored this may be part of a parent class

the name of the service should be changed to the name of this plugin

Member mnetservice_enrol::get_remote_subscribers ()

once the MNet core is refactored this may be part of a parent class

the name of the service should be changed to the name of this plugin

Member mnetservice_enrol::is_available ()
move this to some parent class once we have such
Member mod_bigbluebuttonbn\meeting::create_meeting_data ()
moderatorPW and attendeePW will be removed from create after release of BBB v2.6.
Member mod_data_renderer::import_setting_mappings ($datamodule, data_preset_importer $importer)
MDL-75189 Final deprecation in Moodle 4.5.
Member mod_feedback\output\summary::__construct ($feedbackstructure, $mygroupid=false, $extradetails=null)
MDL-71494 Final deprecation of the $extradetails parameter in Moodle 4.3
Member mod_forum_external::update_discussion_post ($postid, $subject='', $message='', $messageformat=FORMAT_HTML, $options=[])
support more options: timed posts, groups change and tags.
Member mod_quiz\structure::get_slot_tags_for_slot_id ($slotid)
Final deprecation on Moodle 4.4 MDL-72438
Member mod_workshop_renderer::helper_grading_report_assessment ($assessment, $shownames, array $userinfo, $separator)
Highlight the nulls
Member MongoDB\ChangeStream::CURSOR_NOT_FOUND
Remove this in 2.0 (see: PHPLIB-360)
Member MongoDB\Exception\UnsupportedException::arrayFiltersNotSupported ()
Remove this in 2.0 (see: PHPLIB-797)
Member MongoDB\Exception\UnsupportedException::collationNotSupported ()
Remove this in 2.0 (see: PHPLIB-797)
Member moodle1_assignment_subplugin_handler::append_subplugin_data ($data)
sub paths containing subplugindata isn't handed through).
Class moodle1_files_handler
migrate site_files
Member moodle1_gradebook_handler::on_gradebook_grade_item_grades_start ()
Member moodle1_handlers_factory::get_plugin_handlers ($type, moodle1_converter $converter)
ask mod's subplugins
Member moodle_database::get_record ($table, array $conditions, $fields=' *', $strictness=IGNORE_MISSING)
MDL-30407 MUST_EXIST option should not throw a dml_exception, it should throw a different exception as it's a requested check.
Member moodle_database::sql_fullname ($first='firstname', $last='lastname')
MDL-31233 This may not be needed here.
Member moodle_page::magic_get_secondarynav ()
MDL-74939 Remove support for old 'local::views::secondary' class location
Member moodle_process_email ($modargs, $body)
Finish documenting this function
Member moodle_url::remove_all_params ($params=null)
remove the unused param.
Class moodleform
MDL-19380 rethink the file scanning
Member moodleform::save_files ($destination)
MDL-31294 remove this api
Class MoodleQuickForm_editor

MDL-29421 element Freezing

MDL-29426 ajax format conversion

Member mssql_sql_generator::getDropDefaultSQL ($xmldb_table, $xmldb_field)
MDL-31147 Moodle 2.1 - Drop getDropDefaultSQL()
Member mysql_sql_generator::getDropDefaultSQL ($xmldb_table, $xmldb_field)
MDL-31147 Moodle 2.1 - Drop getDropDefaultSQL()
Member oracle_sql_generator::getDropDefaultSQL ($xmldb_table, $xmldb_field)
MDL-31147 Moodle 2.1 - Drop getDropDefaultSQL()
Member phpunit_coverage_info::$whitelistfiles
MDL-71067 - remove in Moodle 4.3
Member phpunit_coverage_info::$whitelistfolders
MDL-71067 - remove in Moodle 4.3
Member PhpXmlRpc\Client::$method
: do these need to be public?
Member PhpXmlRpc\Client::send ($req, $timeout=0, $method='')

allow throwing exceptions instead of returning responses in case of failed calls and/or Fault responses

refactor: we now support many options besides connection timeout and http version to use. Why only privilege those?

Member PhpXmlRpc\Client::sendPayloadCURL ($req, $server, $port, $timeout=0, $username='', $password='', $authType=1, $cert='', $certPass='', $caCert='', $caCertDir='', $proxyHost='', $proxyPort=0, $proxyUsername='', $proxyPassword='', $proxyAuthType=1, $method='https', $keepAlive=false, $key='', $keyPass='', $sslVersion=0)
refactor: we get many options for the call passed in, but some we use from $this. We should clean that up
Member PhpXmlRpc\Client::sendPayloadSocket ($req, $server, $port, $timeout=0, $username='', $password='', $authType=1, $cert='', $certPass='', $caCert='', $caCertDir='', $proxyHost='', $proxyPort=0, $proxyUsername='', $proxyPassword='', $proxyAuthType=1, $method='http', $key='', $keyPass='', $sslVersion=0)

not implemented yet.

not implemented yet. See http://php.net/manual/en/migration56.openssl.php

refactor: we get many options for the call passed in, but some we use from $this. We should clean that up

Member PhpXmlRpc\Client::setCookie ($name, $value='', $path='', $domain='', $port=null)

check correctness of urlencoding cookie value (copied from php way of doing it, but php is generally sending response not requests. We do the opposite...)

strip invalid chars from cookie name? As per RFC6265, we should follow RFC2616, Section 2.2

Member PhpXmlRpc\Encoder::decodeXml ($xmlVal, $options=array())
is this a good name/class for this method? It does something quite different from 'decode' after all (returning objects vs returns plain php values)... In fact it belongs rather to a Parser class
Member PhpXmlRpc\Helper\Charset::buildConversionTable ($tableName)

add support for cp1252 as well as latin-2 .. latin-10 Optimization creep: instead of building all those tables on load, keep them ready-made php files which are not even included until needed

should we add to the latin-1 table the characters from cp_1252 range, i.e. 128 to 159 ? Those will NOT be present in true ISO-8859-1, but will save the unwary windows user from sending junk (though no luck when receiving them...) Note also that, apparently, while 'ISO/IEC 8859-1' has no characters defined for bytes 128 to 159, IANA ISO-8859-1 does have well-defined 'C1' control codes for those - wikipedia's page on latin-1 says: "ISO-8859-1 is the IANA preferred name for this standard when supplemented with the C0 and C1 control codes from ISO/IEC 6429." Check what mbstring/iconv do by default with those?

Member PhpXmlRpc\Helper\Charset::encodeEntities ($data, $srcEncoding='', $destEncoding='')

do a bit of basic benchmarking (strtr vs. str_replace)

make usage of iconv() or mb_string() where available

support aliases for charset names, eg ASCII, LATIN1, ISO-88591 (see f.e. polyfill-iconv for a list), but then take those into account as well in other methods, ie.isValidCharset)

when converting to ASCII, allow to choose whether to escape the range 0-31,127 (non-print chars) or not

allow picking different strategies to deal w. invalid chars? eg. source in latin-1 and chars 128-159

add support for escaping using CDATA sections? (add cdata start and end tokens, replace only ']]>' with ']]]]>>')

Parameters
string$data
string$srcEncoding
string$destEncoding
Return values
string
Member PhpXmlRpc\Helper\Charset::instance ()
should we just make $xml_iso88591_Entities a static variable instead ?
Member PhpXmlRpc\Helper\XMLParser::guessEncoding ($httpHeader='', $xmlChunk='', $encodingPrefs=null)
explore usage of mb_http_input(): does it detect http headers + post data? if so, use it instead of hand-detection!!!
Member PhpXmlRpc\Request::$payload
: do these need to be public?
Member PhpXmlRpc\Request::parseResponse ($data='', $headersProcessed=false, $returnType=XMLParser::RETURN_XMLRPCVALS)
parsing Responses is not really the responsibility of the Request class. Maybe of the Client...
Member PhpXmlRpc\Response::$val
: do these need to be public?
Member PhpXmlRpc\Response::__construct ($val, $fCode=0, $fString='', $valType='', $httpResponse=null)
add check that $val / $fCode / $fString is of correct type??? NB: as of now we do not do it, since it might be either an xmlrpc value or a plain php val, or a complete xml chunk, depending on usage of Client::send() inside which creator is called...
Member PhpXmlRpc\Server::$functions_parameters_type
create class constants for these
Member PhpXmlRpc\Server::add_to_map ($methodName, $function, $sig=null, $doc=false, $sigDoc=false)

raise a warning if the user tries to register a 'system.' method

allow setting parameters_type

Member PhpXmlRpc\Value::$me
: do these need to be public?
Member PhpXmlRpc\Value::addArray ($values)
add some checking for $values to be an array of xmlrpc values?
Member PhpXmlRpc\Value::addStruct ($values)
add some checking for $values to be an array?
Class PhpXmlRpc\Wrapper

use some better templating system for code generation?

implement method wrapping with preservation of php objs in calls

when wrapping methods without obj rebuilding, use return_type = 'phpvals' (faster)

add support for 'epivals' mode

allow setting custom namespace for generated wrapping code

Member PhpXmlRpc\Wrapper::buildMethodSignatures ($funcDesc)
support better docs with multiple types separated by pipes by creating multiple signatures (this is questionable, as it might produce a big matrix of possible signatures with many such occurrences)
Member PhpXmlRpc\Wrapper::buildWrapFunctionClosure ($callable, $extraOptions, $plainFuncName, $funcDesc)

validate params? In theory all validation is left to the dispatch map...

add support for $catchWarnings

Member PhpXmlRpc\Wrapper::buildWrapFunctionSource ($callable, $newFuncName, $extraOptions, $plainFuncName, $funcDesc)
add a nice phpdoc block in the generated source
Member PhpXmlRpc\Wrapper::buildWrapMethodClosure ($client, $methodName, array $extraOptions, $mSig)
should we allow usage of parameter simple_client_copy to mean 'do not clone' in this case?
Member PhpXmlRpc\Wrapper::php2XmlrpcType ($phpType)
support notation something[] as 'array'
Member PhpXmlRpc\Wrapper::wrapPhpFunction ($callable, $newFuncName='', $extraOptions=array())

decide how to deal with params passed by ref in function definition: bomb out or allow?

finish using phpdoc info to build method sig if all params are named but out of order

add a check for params of 'resource' type

add some trigger_errors / error_log when returning false?

what to do when the PHP function returns NULL? We are currently returning an empty string value...

add an option to suppress php warnings in invocation of user function, similar to server debug level 3?

add a verbatim_object_copy parameter to allow avoiding usage the same obj instance?

add an option to allow generated function to skip validation of number of parameters, as that is done by the server anyway

Member PhpXmlRpc\Wrapper::wrapXmlrpcMethod ($client, $methodName, $extraOptions=array())

allow caller to give us the method signature instead of querying for it, or just say 'skip it'

if we can not retrieve method signature, create a php function with varargs

allow the created function to throw exceptions on method calls failures

if caller did not specify a specific sig, shall we support all of them? It might be hard (hence slow) to match based on type and number of arguments...

Member plagiarism_get_file_results ($cmid, $userid, $file)
MDL-71326 This is to be moved from here to deprecatedlib.php in Moodle 4.4
Member plagiarism_get_form_elements_module ($mform, $context, $modulename="")
MDL-67526 This is to be moved from here to deprecatedlib.php in Moodle 4.1
Member plagiarism_load_available_plugins ()
MDL-67872 the deprecated code in this function to be removed in Moodle 4.1
Member plagiarism_plugin::get_configs ()
MDL-71326 Remove this method.
Member plagiarism_plugin::get_file_results ($cmid, $userid, $file)
MDL-71326 Remove this method.
Member plagiarism_plugin::get_form_elements_module ($mform, $context, $modulename="")
MDL-67526 Remove this method.
Member plagiarism_plugin::save_form_elements ($data)
MDL-67526 Remove this method.
Member plagiarism_plugin::update_status ($course, $cm)
MDL-71326 Remove this method.
Member plagiarism_save_form_elements ($data)
MDL-67526 This is to be moved from here to deprecatedlib.php in Moodle 4.1
Member plagiarism_update_status ($course, $cm)
MDL-71326 Remove this method.
Member plugin_callback ($type, $name, $feature, $action, $params=null, $default=null)
Decide about to deprecate and drop plugin_callback() - MDL-30743
Member portfolio_caller_base::set_formats_from_button ($formats)
MDL-31298 - re-analyze set_formats_from_button comment
Member portfolio_format_leap2a_entry::validate ()
MDL-31303 - add category with a scheme 'selection_type'
Class portfolio_format_leap2a_writer

MDL-31287 - find a way to ensure that all referenced files are included

Member portfolio_format_leap2a_writer::__construct (stdclass $user)
MDL-31302 - add exporter and format
Member portfolio_format_richhtml::conflicts ($format)
MDL-31305 - revisit the conflict with file, since we zip here
Member portfolio_instances ($visibleonly=true, $useronly=true)
MDL-15768 - check capabilities here
Member postgres_sql_generator::getDropDefaultSQL ($xmldb_table, $xmldb_field)
MDL-31147 Moodle 2.1 - Drop getDropDefaultSQL()
Member prepare ($sql)
update this function to handle prepared statements correctly
Member print_arrow ($direction='up', $strsort=null, $return=false)
final deprecation of this function once MDL-45448 is resolved
Member print_choose_qtype_to_add_form ($hiddenparams, array $allowedqtypes=null, $enablejs=true)
Final deprecation of this class in moodle 4.4 MDL-72438
Member print_course_request_buttons ($context)
Final deprecation MDL-73976
Member print_error ($errorcode, $module='error', $link='', $a=null, $debuginfo=null)
MDL-74484 Final deprecation in Moodle 4.5.
Member print_grade_menu ($courseid, $name, $current, $includenograde=true, $return=false)

Finish documenting this function

Deprecate: this is only used in a few contrib modules

Member print_password_policy ()
this should be handled by a function/method in the language pack library once we have a support for it @uses $CFG
Member profile_edit_category ($id, $redirect)
MDL-71413 This will be deleted in Moodle 4.3.
Member profile_edit_field ($id, $datatype, $redirect)
MDL-71413 This will be deleted in Moodle 4.3.
Member question_add_context_in_key ($categories)
Final deprecation on Moodle 4.4 MDL-72438
Member question_can_delete_cat ($todelete)
Final deprecation on Moodle 4.4 MDL-72438
Member question_category_options ($contexts, $top=false, $currentcat=0, $popupform=false, $nochildrenof=-1, $escapecontextnames=true)
Final deprecation on Moodle 4.4 MDL-72438
Member question_category_select_menu ($contexts, $top=false, $currentcat=0, $selected="", $nochildrenof=-1)
Final deprecation on Moodle 4.4 MDL-72438
Member question_fix_top_names ($categories, $escape=true)
Final deprecation on Moodle 4.4 MDL-72438
Member question_get_export_single_question_url ($question)
Final deprecation on Moodle 4.4 MDL-72438
Member question_hash ($question)
Final deprecation on Moodle 4.4 MDL-72438
Member question_is_only_child_of_top_category_in_context ($categoryid)
Final deprecation on Moodle 4.4 MDL-72438
Member question_is_top_category ($categoryid)
Final deprecation on Moodle 4.4 MDL-72438
Member question_make_export_url ($contextid, $categoryid, $format, $withcategories, $withcontexts, $filename)
Final deprecation on Moodle 4.4 MDL-72438
Member question_preview_action_url ($questionid, $qubaid, question_preview_options $options, $context)
Final deprecation on Moodle 4.4 MDL-72438
Member question_preview_form_url ($questionid, $context, $previewid=null)
Final deprecation on Moodle 4.4 MDL-72438
Member question_preview_popup_params ()
Final deprecation on Moodle 4.4 MDL-72438
Member question_preview_question_pluginfile ($course, $context, $component, $filearea, $qubaid, $slot, $args, $forcedownload, $fileoptions)
Final deprecation on Moodle 4.4 MDL-72438
Member question_preview_url ($questionid, $preferredbehaviour=null, $maxmark=null, $displayoptions=null, $variant=null, $context=null)
Final deprecation on Moodle 4.4 MDL-72438
Member question_remove_stale_questions_from_category ($categoryid)
Final deprecation on Moodle 4.4 MDL-72438
Member quiz_completion_check_min_attempts ($userid, $quiz)
MDL-71196 Final deprecation in Moodle 4.3
Member quiz_completion_check_passing_grade_or_all_attempts ($course, $cm, $userid, $quiz)
MDL-71196 Final deprecation in Moodle 4.3
Member quiz_get_completion_state ($course, $cm, $userid, $type)
MDL-71196 Final deprecation in Moodle 4.3
Member quiz_retrieve_tags_for_slot_ids ($slotids)
Final deprecation on Moodle 4.4 MDL-72438
Member renderer_base::should_display_main_logo ($headinglevel=1)
final deprecation. To be removed in Moodle 4.4 MDL-73165.
Member report_log_renderable::get_actions ()
MDL-44528 Get list from log_store.
Member report_log_renderable::get_edulevel_options ()
MDL-44528 Get list from log_store.
Member repository::build_tree ($fileinfo, $search, $dynamicmode, &$list)
take $search into account, and respect a threshold for dynamic loading
Member repository::move_to_filepool ($thefile, $record)

MDL-28637

Member repository_onedrive::can_import_skydrive_files ()
MDL-72620 This will be deleted in Moodle 4.4.
Member repository_onedrive::import_skydrive_files ()
MDL-72620 This will be deleted in Moodle 4.4.
Member repository_recent::file_is_accessible ($source)
MDL-33805 remove this function when recent files are managed correctly
Member repository_type::get_contextvisibility ($context)
check if the context visibility has been overwritten by the plugin creator (need to create special functions to be overvwritten in repository class)
Member restart_preview ($previewid, $questionid, $displayoptions, $context)
Final deprecation on Moodle 4.4 MDL-72438
Member restore_dbops::get_backup_ids_cached ($restoreid, $itemname, $itemid)
MDL-25290 replace static backupids* with MUC code
Member restore_dbops::reset_backup_ids_cached ()
MDL-25290 static should be replaced with MUC code.
Member restore_dbops::set_backup_ids_cached ($restoreid, $itemname, $itemid, $extrarecord)
MDL-25290 replace static BACKUP_IDS_* with MUC code
Member scorm_get_completion_state ($course, $cm, $userid, $type)
MDL-71196 Final deprecation in Moodle 4.3
Member search_generate_text_SQL ($parsetree, $datafield, $metafield, $mainidfield, $useridfield, $userfirstnamefield, $userlastnamefield, $timefield, $instancefield)
MDL-48940 This will be deleted in Moodle 3.2
Member serialise_tool_proxy (stdClass $proxy)
This will be finally removed for Moodle 4.2 as part of MDL-69976.
Member SimplePie::subscribe_url ($permanent=false)

Support <itunes:new-feed-url>

Also, |atom:link|@rel=self

Member SIMPLEPIE_BUILD
Hardcode for release (there's no need to have to call SimplePie_Misc::get_build() only every load of simplepie.inc)
Member size ($size, $larger=false, $not=false, array $opts=array())
: Remove $not for 3.0
Member sql_generator::getDropDefaultSQL ($xmldb_table, $xmldb_field)
MDL-31147 Moodle 2.1 - Drop getDropDefaultSQL()
Member sqlite_sql_generator::getDropDefaultSQL ($xmldb_table, $xmldb_field)
MDL-31147 Moodle 2.1 - Drop getDropDefaultSQL()
Member survey_get_completion_state ($course, $cm, $userid, $type)
MDL-71196 Final deprecation in Moodle 4.3
Member survey_print_multi ($question)
Check this function
Member TAG_MAX_LENGTH
define(TAG_MAX_LENGTH) this is not correct, varchar(255) are 255 unicode chars ;-)
Member toolbook_importhtml_parse_headings ($html)
implement this once the type 'typeonefile' is enabled
Member translate_message_default_setting ($plugindefault, $processorname)
Remove usage of MESSAGE_DEFAULT_LOGGEDOFF on MDL-73284.
Member underscore ($camelCasedWord)
Do we want locale-specific or locale-independent lowercasing?
Member user_delete_user ($user)
Decide if this transaction is really needed (look for internal TODO:)
Member webservice::get_user_capabilities ($userid)
MDL-70187 Please delete this method completely in Moodle 4.3, thank you.
Member workshop::delete_assessment ($id)
Give grading strategy plugins a chance to clean up their data, too.
Member zip_archive::open ($archivepathname, $mode=file_archive::CREATE, $encoding=null)
MDL-31048 return error message
Member zip_packer::extract_to_pathname ($archivefile, $pathname, array $onlyfiles=null, file_progress $progress=null, $returnbool=false)
MDL-31048 localise messages
Member zip_packer::extract_to_storage ($archivefile, $contextid, $component, $filearea, $itemid, $pathbase, $userid=NULL, file_progress $progress=null)
MDL-31048 localise messages