| [ Index ] |
PHP Cross Reference of Moodle 1.9.3 [Build 15-Oct-2008] |
[Source view] [Print] [Project Stats]
adminlib.php - Contains functions that only administrators will ever need to use
| Author: | Martin Dougiamas and many others |
| License: | http://www.gnu.org/copyleft/gpl.html GNU Public License |
| Version: | $Id: adminlib.php,v 1.153.2.54 2008/08/31 20:44:16 skodak Exp $ |
| File Size: | 4853 lines (174 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 2 files version.php lib/db/upgrade.php |
part_of_admin_tree:: (5 methods):
locate()
prune()
search()
check_access()
is_hidden()
parentable_part_of_admin_tree:: (1 method):
add()
admin_category:: (7 methods):
admin_category()
locate()
search()
prune()
add()
check_access()
is_hidden()
admin_root:: (1 method):
admin_root()
admin_externalpage:: (6 methods):
admin_externalpage()
locate()
prune()
search()
check_access()
is_hidden()
admin_settingpage:: (8 methods):
admin_settingpage()
locate()
search()
prune()
add()
check_access()
output_html()
is_hidden()
admin_setting:: (11 methods):
admin_setting()
get_full_name()
get_id()
config_read()
config_write()
get_setting()
get_defaultsetting()
write_setting()
output_html()
set_updatedcallback()
is_related()
admin_setting_heading:: (5 methods):
admin_setting_heading()
get_setting()
get_defaultsetting()
write_setting()
output_html()
admin_setting_configtext:: (5 methods):
admin_setting_configtext()
get_setting()
write_setting()
validate()
output_html()
admin_setting_configtextarea:: (2 methods):
admin_setting_configtextarea()
output_html()
admin_setting_configpasswordunmask:: (2 methods):
admin_setting_configpasswordunmask()
output_html()
admin_setting_configfile:: (2 methods):
admin_setting_configfile()
output_html()
admin_setting_configexecutable:: (1 method):
output_html()
admin_setting_configdirectory:: (1 method):
output_html()
admin_setting_configcheckbox:: (4 methods):
admin_setting_configcheckbox()
get_setting()
write_setting()
output_html()
admin_setting_configmulticheckbox:: (6 methods):
admin_setting_configmulticheckbox()
load_choices()
is_related()
get_setting()
write_setting()
output_html()
admin_setting_configmulticheckbox2:: (2 methods):
get_setting()
write_setting()
admin_setting_configselect:: (6 methods):
admin_setting_configselect()
load_choices()
is_related()
get_setting()
write_setting()
output_html()
admin_setting_configmultiselect:: (5 methods):
admin_setting_configmultiselect()
get_setting()
write_setting()
is_related()
output_html()
admin_setting_configtime:: (4 methods):
admin_setting_configtime()
get_setting()
write_setting()
output_html()
admin_setting_special_adminseesall:: (2 methods):
admin_setting_special_adminseesall()
write_setting()
admin_setting_special_selectsetup:: (2 methods):
get_setting()
write_setting()
admin_setting_sitesetselect:: (2 methods):
get_setting()
write_setting()
admin_setting_courselist_frontpage:: (5 methods):
admin_setting_courselist_frontpage()
load_choices()
get_setting()
write_setting()
output_html()
admin_setting_sitesetcheckbox:: (2 methods):
get_setting()
write_setting()
admin_setting_sitesettext:: (3 methods):
get_setting()
validate()
write_setting()
admin_setting_special_frontpagedesc:: (4 methods):
admin_setting_special_frontpagedesc()
get_setting()
write_setting()
output_html()
admin_setting_special_editorfontlist:: (4 methods):
admin_setting_special_editorfontlist()
get_setting()
write_setting()
output_html()
admin_setting_emoticons:: (4 methods):
admin_setting_emoticons()
get_setting()
write_setting()
output_html()
admin_setting_special_editordictionary:: (2 methods):
admin_setting_special_editordictionary()
load_choices()
admin_setting_special_editorhidebuttons:: (4 methods):
admin_setting_special_editorhidebuttons()
get_setting()
write_setting()
output_html()
admin_setting_langlist:: (2 methods):
admin_setting_langlist()
write_setting()
admin_settings_coursecat_select:: (2 methods):
admin_settings_coursecat_select()
load_choices()
admin_setting_special_backupdays:: (2 methods):
admin_setting_special_backupdays()
load_choices()
admin_setting_special_debug:: (2 methods):
admin_setting_special_debug()
load_choices()
admin_setting_special_calendar_weekend:: (4 methods):
admin_setting_special_calendar_weekend()
get_setting()
write_setting()
output_html()
admin_setting_special_gradebookroles:: (3 methods):
admin_setting_special_gradebookroles()
load_choices()
get_defaultsetting()
admin_setting_regradingcheckbox:: (1 method):
write_setting()
admin_setting_special_coursemanager:: (3 methods):
admin_setting_special_coursemanager()
load_choices()
get_defaultsetting()
admin_setting_special_gradeexport:: (2 methods):
admin_setting_special_gradeexport()
load_choices()
admin_setting_gradecat_combo:: (4 methods):
admin_setting_gradecat_combo()
get_setting()
write_setting()
output_html()
admin_setting_grade_profilereport:: (2 methods):
admin_setting_grade_profilereport()
load_choices()
admin_setting_special_registerauth:: (3 methods):
admin_setting_special_registerauth()
get_defaultsettings()
load_choices()
admin_page_managemods:: (2 methods):
admin_page_managemods()
search()
admin_enrolment_page:: (2 methods):
admin_enrolment_page()
search()
admin_page_manageblocks:: (2 methods):
admin_page_manageblocks()
search()
admin_setting_manageauths:: (6 methods):
admin_setting_manageauths()
get_setting()
get_defaultsetting()
write_setting()
is_related()
output_html()
admin_setting_managefilters:: (21 methods):
admin_setting_managefilters()
get_setting()
get_defaultsetting()
write_setting()
is_related()
output_html()
admin_externalpage_setup()
admin_externalpage_print_header()
admin_externalpage_print_footer()
admin_get_root()
admin_apply_default_settings()
admin_write_settings()
admin_find_write_settings()
admin_search_settings_html()
admin_output_new_settings_by_page()
apply_default_exception_settings()
format_admin_setting()
upgrade_language_pack()
any_new_admin_settings()
db_replace()
print_plugin_tables()
Class: part_of_admin_tree - X-Ref
Pseudointerface for anything appearing in the admin tree| locate($name) X-Ref |
| Finds a named part_of_admin_tree. Used to find a part_of_admin_tree. If a class only inherits part_of_admin_tree and not parentable_part_of_admin_tree, then this function should only check if $this->name matches $name. If it does, it should return a reference to $this, otherwise, it should return a reference to NULL. If a class inherits parentable_part_of_admin_tree, this method should be called recursively on all child objects (assuming, of course, the parent object's name doesn't match the search criterion). param: string $name The internal name of the part_of_admin_tree we're searching for. return: mixed An object reference or a NULL reference. |
| prune($name) X-Ref |
| Removes named part_of_admin_tree. param: string $name The internal name of the part_of_admin_tree we want to remove. return: bool success. |
| search($query) X-Ref |
| Search using query param: strin query return: mixed array-object structure of found settings and pages |
| check_access() X-Ref |
| Verifies current user's access to this part_of_admin_tree. Used to check if the current user has access to this part of the admin tree or not. If a class only inherits part_of_admin_tree and not parentable_part_of_admin_tree, then this method is usually just a call to has_capability() in the site context. If a class inherits parentable_part_of_admin_tree, this method should return the logical OR of the return of check_access() on all child objects. return: bool True if the user has access, false if she doesn't. |
| is_hidden() X-Ref |
| Mostly usefull for removing of some parts of the tree in admin tree block. return: True is hidden from normal list view |
Class: parentable_part_of_admin_tree - X-Ref
Pseudointerface implemented by any part_of_admin_tree that has children.| add($destinationname, $something) X-Ref |
| Adds a part_of_admin_tree object to the admin tree. Used to add a part_of_admin_tree object to this object or a child of this object. $something should only be added if $destinationname matches $this->name. If it doesn't, add should be called on child objects that are also parentable_part_of_admin_tree's. param: string $destinationname The internal name of the new parent for $something. param: part_of_admin_tree &$something The object to be added. return: bool True on success, false on failure. |
Class: admin_category - X-Ref
The object used to represent folders (a.k.a. categories) in the admin tree block.| admin_category($name, $visiblename, $hidden=false) X-Ref |
| Constructor for an empty admin category param: string $name The internal name for this category. Must be unique amongst ALL part_of_admin_tree objects param: string $visiblename The displayed named for this category. Usually obtained through get_string() param: bool $hidden hide category in admin tree block |
| locate($name, $findpath=false) X-Ref |
| Returns a reference to the part_of_admin_tree object with internal name $name. param: string $name The internal name of the object we want. param: bool $findpath initialize path and visiblepath arrays return: mixed A reference to the object with internal name $name if found, otherwise a reference to NULL. |
| search($query) X-Ref |
| Search using query param: strin query return: mixed array-object structure of found settings and pages |
| prune($name) X-Ref |
| Removes part_of_admin_tree object with internal name $name. param: string $name The internal name of the object we want to remove. return: bool success |
| add($parentname, $something) X-Ref |
| Adds a part_of_admin_tree to a child or grandchild (or great-grandchild, and so forth) of this object. param: string $destinationame The internal name of the immediate parent that we want for $something. param: mixed $something A part_of_admin_tree or setting instanceto be added. return: bool True if successfully added, false if $something can not be added. |
| check_access() X-Ref |
| Checks if the user has access to anything in this category. return: bool True if the user has access to atleast one child in this category, false otherwise. |
| is_hidden() X-Ref |
| Is this category hidden in admin tree block? return: bool True if hidden |
Class: admin_root - X-Ref
| admin_root() X-Ref |
| No description |
Class: admin_externalpage - X-Ref
Links external PHP pages into the admin tree.| admin_externalpage($name, $visiblename, $url, $req_capability='moodle/site:config', $hidden=false, $context=NULL) X-Ref |
| Constructor for adding an external page into the admin tree. param: string $name The internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects. param: string $visiblename The displayed name for this external page. Usually obtained through get_string(). param: string $url The external URL that we should link to when someone requests this external page. param: mixed $req_capability The role capability/permission a user must have to access this external page. Defaults to 'moodle/site:config'. |
| locate($name, $findpath=false) X-Ref |
| Returns a reference to the part_of_admin_tree object with internal name $name. param: string $name The internal name of the object we want. return: mixed A reference to the object with internal name $name if found, otherwise a reference to NULL. |
| prune($name) X-Ref |
| No description |
| search($query) X-Ref |
| Search using query param: strin query return: mixed array-object structure of found settings and pages |
| check_access() X-Ref |
| Determines if the current user has access to this external page based on $this->req_capability. return: bool True if user has access, false otherwise. |
| is_hidden() X-Ref |
| Is this external page hidden in admin tree block? return: bool True if hidden |
Class: admin_settingpage - X-Ref
Used to group a number of admin_setting objects into a page and add them to the admin tree.| admin_settingpage($name, $visiblename, $req_capability='moodle/site:config', $hidden=false, $context=NULL) X-Ref |
| No description |
| locate($name, $findpath=false) X-Ref |
| No description |
| search($query) X-Ref |
| No description |
| prune($name) X-Ref |
| No description |
| add($setting) X-Ref |
| not the same as add for admin_category. adds an admin_setting to this admin_settingpage. settings appear (on the settingpage) in the order in which they're added n.b. each admin_setting in an admin_settingpage must have a unique internal name param: object $setting is the admin_setting object you want to add return: true if successful, false if not |
| check_access() X-Ref |
| No description |
| output_html() X-Ref |
| outputs this page as html in a table (suitable for inclusion in an admin pagetype) returns a string of the html |
| is_hidden() X-Ref |
| Is this settigns page hidden in admin tree block? return: bool True if hidden |
Class: admin_setting - X-Ref
Admin settings class. Only exists on setting pages.| admin_setting($name, $visiblename, $description, $defaultsetting) X-Ref |
| Constructor param: $name string unique ascii name param: $visiblename string localised name param: strin $description localised long description param: mixed $defaultsetting string or array depending on implementation |
| get_full_name() X-Ref |
| No description |
| get_id() X-Ref |
| No description |
| config_read($name) X-Ref |
| No description |
| config_write($name, $value) X-Ref |
| No description |
| get_setting() X-Ref |
| Returns current value of this setting return: mixed array or string depending on instance, NULL means not set yet |
| get_defaultsetting() X-Ref |
| Returns default setting if exists return: mixed array or string depending on instance; NULL means no default, user must supply |
| write_setting($data) X-Ref |
| Store new setting param: mixed string or array, must not be NULL return: '' if ok, string error message otherwise |
| output_html($data, $query='') X-Ref |
| Return part of form with setting param: mixed data array or string depending on setting return: string |
| set_updatedcallback($functionname) X-Ref |
| function called if setting updated - cleanup, cache reset, etc. |
| is_related($query) X-Ref |
| Is setting related to query text - used when searching param: string $query return: bool |
Class: admin_setting_heading - X-Ref
No setting - just heading and text.| admin_setting_heading($name, $heading, $information) X-Ref |
| not a setting, just text param: string $name of setting param: string $heading heading param: string $information text in box |
| get_setting() X-Ref |
| No description |
| get_defaultsetting() X-Ref |
| No description |
| write_setting($data) X-Ref |
| No description |
| output_html($data, $query='') X-Ref |
| No description |
Class: admin_setting_configtext - X-Ref
The most flexibly setting, user is typing text| admin_setting_configtext($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW, $size=null) X-Ref |
| config text contructor param: string $name of setting param: string $visiblename localised param: string $description long localised info param: string $defaultsetting param: mixed $paramtype int means PARAM_XXX type, string is a allowed format in regex param: int $size default field size |
| get_setting() X-Ref |
| No description |
| write_setting($data) X-Ref |
| No description |
| validate($data) X-Ref |
| Validate data before storage param: string data return: mixed true if ok string if error found |
| output_html($data, $query='') X-Ref |
| No description |
Class: admin_setting_configtextarea - X-Ref
General text area without html editor.| admin_setting_configtextarea($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW, $cols='60', $rows='8') X-Ref |
| No description |
| output_html($data, $query='') X-Ref |
| No description |
Class: admin_setting_configpasswordunmask - X-Ref
Password field, allows unmasking of password| admin_setting_configpasswordunmask($name, $visiblename, $description, $defaultsetting) X-Ref |
| Constructor param: string $name of setting param: string $visiblename localised param: string $description long localised info param: string $defaultsetting default password |
| output_html($data, $query='') X-Ref |
| No description |
Class: admin_setting_configfile - X-Ref
Path to directory| admin_setting_configfile($name, $visiblename, $description, $defaultdirectory) X-Ref |
| Constructor param: string $name of setting param: string $visiblename localised param: string $description long localised info param: string $defaultdirectory default directory location |
| output_html($data, $query='') X-Ref |
| No description |
Class: admin_setting_configexecutable - X-Ref
Path to executable file| output_html($data, $query='') X-Ref |
| No description |
Class: admin_setting_configdirectory - X-Ref
Path to directory| output_html($data, $query='') X-Ref |
| No description |
Class: admin_setting_configcheckbox - X-Ref
Checkbox| admin_setting_configcheckbox($name, $visiblename, $description, $defaultsetting, $yes='1', $no='0') X-Ref |
| Constructor param: string $name of setting param: string $visiblename localised param: string $description long localised info param: string $defaultsetting param: string $yes value used when checked param: string $no value used when not checked |
| get_setting() X-Ref |
| No description |
| write_setting($data) X-Ref |
| No description |
| output_html($data, $query='') X-Ref |
| No description |
Class: admin_setting_configmulticheckbox - X-Ref
Multiple checkboxes, each represents different value, stored in csv format| admin_setting_configmulticheckbox($name, $visiblename, $description, $defaultsetting, $choices) X-Ref |
| Constructor param: string $name of setting param: string $visiblename localised param: string $description long localised info param: array $defaultsetting array of selected param: array $choices array of $value=>$label for each checkbox |
| load_choices() X-Ref |
| This function may be used in ancestors for lazy loading of choices return: true if loaded, false if error |
| is_related($query) X-Ref |
| Is setting related to query text - used when searching param: string $query return: bool |
| get_setting() X-Ref |
| No description |
| write_setting($data) X-Ref |
| No description |
| output_html($data, $query='') X-Ref |
| No description |
Class: admin_setting_configmulticheckbox2 - X-Ref
Multiple checkboxes 2, value stored as string 00101011Class: admin_setting_configselect - X-Ref
Select one value from list| admin_setting_configselect($name, $visiblename, $description, $defaultsetting, $choices) X-Ref |
| Constructor param: string $name of setting param: string $visiblename localised param: string $description long localised info param: string $defaultsetting param: array $choices array of $value=>$label for each selection |
| load_choices() X-Ref |
| This function may be used in ancestors for lazy loading of choices return: true if loaded, false if error |
| is_related($query) X-Ref |
| No description |
| get_setting() X-Ref |
| No description |
| write_setting($data) X-Ref |
| No description |
| output_html($data, $query='') X-Ref |
| No description |
Class: admin_setting_configmultiselect - X-Ref
Select multiple items from list| admin_setting_configmultiselect($name, $visiblename, $description, $defaultsetting, $choices) X-Ref |
| Constructor param: string $name of setting param: string $visiblename localised param: string $description long localised info param: array $defaultsetting array of selected items param: array $choices array of $value=>$label for each list item |
| get_setting() X-Ref |
| No description |
| write_setting($data) X-Ref |
| No description |
| is_related($query) X-Ref |
| Is setting related to query text - used when searching param: string $query return: bool |
| output_html($data, $query='') X-Ref |
| No description |
Class: admin_setting_configtime - X-Ref
Time selector| admin_setting_configtime($hoursname, $minutesname, $visiblename, $description, $defaultsetting) X-Ref |
| Constructor param: string $hoursname setting for hours param: string $minutesname setting for hours param: string $visiblename localised param: string $description long localised info param: array $defaultsetting array representing default time 'h'=>hours, 'm'=>minutes |
| get_setting() X-Ref |
| No description |
| write_setting($data) X-Ref |
| No description |
| output_html($data, $query='') X-Ref |
| No description |
Class: admin_setting_special_adminseesall - X-Ref
Special checkbox for calendar - resets SESSION vars.Class: admin_setting_special_selectsetup - X-Ref
Special select for settings that are altered in setup.php and can not be altered on the flyClass: admin_setting_sitesetselect - X-Ref
Special select for frontpage - stores data in course tableClass: admin_setting_courselist_frontpage - X-Ref
Special select - lists on the frontpage - hacky| admin_setting_courselist_frontpage($loggedin) X-Ref |
| No description |
| load_choices() X-Ref |
| No description |
| get_setting() X-Ref |
| No description |
| write_setting($data) X-Ref |
| No description |
| output_html($data, $query='') X-Ref |
| No description |
Class: admin_setting_sitesetcheckbox - X-Ref
Special checkbox for frontpage - stores data in course tableClass: admin_setting_sitesettext - X-Ref
Special text for frontpage - stores data in course table.| get_setting() X-Ref |
| No description |
| validate($data) X-Ref |
| No description |
| write_setting($data) X-Ref |
| No description |
Class: admin_setting_special_frontpagedesc - X-Ref
Special text editor for site description.| admin_setting_special_frontpagedesc() X-Ref |
| No description |
| get_setting() X-Ref |
| No description |
| write_setting($data) X-Ref |
| No description |
| output_html($data, $query='') X-Ref |
| No description |
Class: admin_setting_special_editorfontlist - X-Ref
| admin_setting_special_editorfontlist() X-Ref |
| No description |
| get_setting() X-Ref |
| No description |
| write_setting($data) X-Ref |
| No description |
| output_html($data, $query='') X-Ref |
| No description |
Class: admin_setting_emoticons - X-Ref
| admin_setting_emoticons() X-Ref |
| No description |
| get_setting() X-Ref |
| No description |
| write_setting($data) X-Ref |
| No description |
| output_html($data, $query='') X-Ref |
| No description |
Class: admin_setting_special_editorhidebuttons - X-Ref
| admin_setting_special_editorhidebuttons() X-Ref |
| No description |
| get_setting() X-Ref |
| No description |
| write_setting($data) X-Ref |
| No description |
| output_html($data, $query='') X-Ref |
| No description |
Class: admin_setting_langlist - X-Ref
Special setting for limiting of the list of available languages.Class: admin_settings_coursecat_select - X-Ref
Course category selection| admin_settings_coursecat_select($name, $visiblename, $description, $defaultsetting) X-Ref |
| No description |
| load_choices() X-Ref |
| No description |
Class: admin_setting_special_backupdays - X-Ref
Class: admin_setting_special_calendar_weekend - X-Ref
| admin_setting_special_calendar_weekend() X-Ref |
| No description |
| get_setting() X-Ref |
| No description |
| write_setting($data) X-Ref |
| No description |
| output_html($data, $query='') X-Ref |
| No description |
Class: admin_setting_special_gradebookroles - X-Ref
Graded roles in gradebook| admin_setting_special_gradebookroles() X-Ref |
| No description |
| load_choices() X-Ref |
| No description |
| get_defaultsetting() X-Ref |
| No description |
Class: admin_setting_regradingcheckbox - X-Ref
| write_setting($data) X-Ref |
| No description |
Class: admin_setting_special_coursemanager - X-Ref
Which roles to show on course decription page| admin_setting_special_coursemanager() X-Ref |
| No description |
| load_choices() X-Ref |
| No description |
| get_defaultsetting() X-Ref |
| No description |
Class: admin_setting_gradecat_combo - X-Ref
Grade category settings| admin_setting_gradecat_combo($name, $visiblename, $description, $defaultsetting, $choices) X-Ref |
| No description |
| get_setting() X-Ref |
| No description |
| write_setting($data) X-Ref |
| No description |
| output_html($data, $query='') X-Ref |
| No description |
Class: admin_setting_special_registerauth - X-Ref
Special class for register auth selection| admin_setting_special_registerauth() X-Ref |
| No description |
| get_defaultsettings() X-Ref |
| No description |
| load_choices() X-Ref |
| No description |
Class: admin_setting_manageauths - X-Ref
Special class for authentication administration.| admin_setting_manageauths() X-Ref |
| No description |
| get_setting() X-Ref |
| No description |
| get_defaultsetting() X-Ref |
| No description |
| write_setting($data) X-Ref |
| No description |
| is_related($query) X-Ref |
| No description |
| output_html($data, $query='') X-Ref |
| No description |
Class: admin_setting_managefilters - X-Ref
Special class for filter administration.| admin_setting_managefilters() X-Ref |
| No description |
| get_setting() X-Ref |
| No description |
| get_defaultsetting() X-Ref |
| No description |
| write_setting($data) X-Ref |
| No description |
| is_related($query) X-Ref |
| No description |
| output_html($data, $query='') X-Ref |
| No description |
| admin_externalpage_setup($section) X-Ref |
| Initialise admin page - this function does require login and permission checks specified in page definition. This function must be called on each admin page before other code. param: string $section name of page |
| admin_externalpage_print_header($focus='') X-Ref |
| Print header for admin page param: string $focus focus element |
| admin_externalpage_print_footer() X-Ref |
| Print footer on admin page - please use normal print_footer() instead |
| admin_get_root($reload=false, $requirefulltree=true) X-Ref |
| Returns the reference to admin tree root return: reference |
| admin_apply_default_settings($node=NULL, $unconditional=true) X-Ref |
| This function applies default settings. param: object $node, NULL means complete tree param: bool $uncoditional if true overrides all values with defaults return: void |
| admin_write_settings($formdata) X-Ref |
| Store changed settings, this function updates the errors variable in $ADMIN param: object $formdata from form (without magic quotes) return: int number of changed settings |
| admin_find_write_settings($node, $data) X-Ref |
| Internal recursive function - finds all settings from submitted form |
| admin_search_settings_html($query) X-Ref |
| Internal function - prints the search results |
| admin_output_new_settings_by_page($node) X-Ref |
| Internal function - returns arrays of html pages with uninitialised settings |
| apply_default_exception_settings($defaults) X-Ref |
| Unconditionally applies default admin settings in main config table param: array $defaults array of string values |
| format_admin_setting($setting, $title='', $form='', $description='', $label=true, $warning='', $defaultinfo=NULL, $query='') X-Ref |
| Format admin settings param: string $object setting param: string $title label element param: string $form form fragment, html code - not highlighed automaticaly param: string $description param: bool $label link label to id param: string $warning warning text param: sting $defaultinfo defaults info, null means nothing, '' is converted to "Empty" string param: string $query search query to be highlighted |
| upgrade_language_pack($lang='') X-Ref |
| Try to upgrade the given language pack (or current language) If it doesn't work, fail silently and return false |
| any_new_admin_settings($node) X-Ref |
| Based on find_new_settings{@link ()} in upgradesettings.php Looks to find any admin settings that have not been initialized. Returns 1 if it finds any. param: string $node The node at which to start searching. return: boolen true if any settings haven't been initialised, false if they all have |
| db_replace($search, $replace) X-Ref |
| Moved from admin/replace.php so that we can use this in cron param: string $search - string to look for (with magic quotes) param: string $replace - string to replace (with magic quotes) return: bool - success or fail |
| print_plugin_tables() X-Ref |
| Prints tables of detected plugins, one table per plugin type, and prints whether they are part of the standard Moodle distribution or not. |
| upgrade_main_savepoint($result, $version) X-Ref |
| No description |
| upgrade_mod_savepoint($result, $version, $type) X-Ref |
| No description |
| upgrade_plugin_savepoint($result, $version, $type, $dir) X-Ref |
| No description |
| upgrade_backup_savepoint($result, $version) X-Ref |
| No description |
| upgrade_blocks_savepoint($result, $version, $type) X-Ref |
| No description |
| upgrade_plugins($type, $dir, $return) X-Ref |
| Upgrade plugins param: string $type The type of plugins that should be updated (e.g. 'enrol', 'qtype') param: string $dir The directory where the plugins are located (e.g. 'question/questiontypes') param: string $return The url to prompt the user to continue to |
| upgrade_activity_modules($return) X-Ref |
| Find and check all modules and load them up or upgrade them if necessary param: string $return The url to prompt the user to continue to |
| set_cron_lock($name, $until, $ignorecurrent=false) X-Ref |
| Try to obtain or release the cron lock. param: string $name name of lock param: int $until timestamp when this lock considered stale, null means remove lock unconditionaly param: bool $ignorecurrent ignore current lock state, usually entend previous lock return: bool true if lock obtained |
| print_progress($done, $total, $updatetime=5, $sleeptime=1, $donetext='') X-Ref |
| No description |
| print_progress_redraw($thisbarid, $done, $total, $width, $donetext='') X-Ref |
| No description |
| upgrade_get_javascript() X-Ref |
| No description |
| create_admin_user() X-Ref |
| No description |
| upgrade_check_running($message, $timeout) X-Ref |
| Check if upgrade is already running. If anything goes wrong due to missing call to upgrade_log_finish() just restart the browser. param: string warning message indicating upgrade is already running param: int page reload timeout |
| upgrade_log_start() X-Ref |
| Start logging of output into file (if not disabled) and prevent aborting and concurrent execution of upgrade script. Please note that you can not write into session variables after calling this function! This function may be called repeatedly. |
| upgrade_log_finish() X-Ref |
| Terminate logging of output, flush all data, allow script aborting and reopen session for writing. Function error() does terminate the logging too. Please make sure that each upgrade_log_start() is properly terminated by this function or error(). This function may be called repeatedly. |
| upgrade_log_callback($string) X-Ref |
| Callback function for logging into files. Not more than one file is created per minute, upgrade session (terminated by upgrade_log_finish()) is always stored in one file. This function must not output any characters or throw warnigns and errors! |
| admin_critical_warnings_present() X-Ref |
| Test if and critical warnings are present return: bool |
| is_dataroot_insecure($fetchtest=false) X-Ref |
| Try to verify that dataroot is not accessible from web. It is not 100% correct but might help to reduce number of vulnerable sites. Protection from httpd.conf and .htaccess is not detected properly. param: bool $fetchtest try to test public access by fetching file return: mixed empty means secure, INSECURE_DATAROOT_ERROR found a critical problem, INSECURE_DATAROOT_WARNING migth be problematic |
| Generated: Wed Jan 14 11:33:29 2009 | Cross-referenced by PHPXref 0.7 |