[ Index ]

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

title

Body

[close]

/backup/ -> backuplib.php (summary)

[Source view] [Print] [Project Stats]

(no description)

File Size: 3483 lines (153 kb)
Included or required: 2 times
Referenced: 1 time
Includes or requires: 0 files

Defines 68 functions

  user_check_backup()
  backup_get_needed_users()
  backup_get_enrolled_users()
  backup_get_all_users()
  log_check_backup()
  user_files_check_backup()
  course_files_check_backup()
  site_files_check_backup()
  check_and_create_moddata_dir()
  check_and_create_user_files_dir()
  check_and_create_group_files_dir()
  check_and_create_course_files_dir()
  check_and_create_site_files_dir()
  backup_open_xml()
  backup_close_xml()
  start_tag()
  end_tag()
  full_tag()
  xml_tag_safe_content()
  backup_general_info()
  backup_course_start()
  backup_course_end()
  backup_course_metacourse()
  backup_messages()
  backup_blogs()
  backup_course_blocks()
  backup_course_sections()
  backup_format_data()
  backup_course_modules()
  backup_user_info()
  backup_log_info()
  backup_gradebook_info()
  backup_gradebook_category_info()
  backup_gradebook_item_info()
  backup_gradebook_grade_letters_info()
  backup_gradebook_outcomes_info()
  backup_gradebook_grades_info()
  backup_gradebook_categories_history_info()
  backup_gradebook_grades_history_info()
  backup_gradebook_items_history_info()
  backup_gradebook_outcomes_history()
  backup_scales_info()
  backup_events_info()
  backup_groups_info()
  backup_groups_members_info()
  backup_groupings_info()
  backup_groupings_groups_info()
  backup_modules_start()
  backup_modules_end()
  backup_module()
  backup_encode_absolute_links()
  backup_copy_user_files()
  backup_copy_group_files()
  backup_copy_course_files()
  backup_copy_site_files()
  backup_zip()
  copy_zip_to_course_dir()
  backup_userdata_selected()
  backup_mod_selected()
  backup_fetch_prefs_from_request()
  backup_fetch_roles()
  write_role_overrides_xml()
  write_role_assignments_xml()
  backup_execute()
  backup_get_backup_string()
  backup_get_zipfile_name()
  backup_get_keep_name()
  backup_add_static_preferences()

Functions
Functions that are not part of a class:

user_check_backup($courseid,$backup_unique_code,$backup_users,$backup_messages,$backup_blogs)   X-Ref
This function calculates the users to be added to backup based in the
settings defined at backup. All the resulting user ids are sent to
backup_ids for later usage.

param: int $courseid id of the course to backup
param: int $backup_unique_code unique code of the backup being executed
param: int $backup_unique_code setting specifying what users to export (0=all, 1=needed, 2=none)
param: int $backup_messages flag (true/false) defining if messages must be
param: int $backup_blogs flag (true/false) defining if blogs must be
return: array one array (key, value) sumarizing the result of the function (number of users)

backup_get_needed_users($courseid, $includemessages=false, $includeblogs=false)   X-Ref
No description

backup_get_enrolled_users($courseid)   X-Ref
No description

backup_get_all_users()   X-Ref
No description

log_check_backup($course)   X-Ref
No description

user_files_check_backup($course,$backup_unique_code)   X-Ref
No description

course_files_check_backup($course, $backup_unique_code)   X-Ref
Calculate the number of course files to backup
under $CFG->dataroot/$course, except $CFG->moddata, and backupdata
and put them (their path) in backup_ids
Return an array of info (name,value)


site_files_check_backup($course, $backup_unique_code)   X-Ref
Calculate the number of site files to backup
under $CFG->dataroot/SITEID
Their path is already in backup_ids, put there by modules check_backup functions.
Modules only put in paths of files that are used.

Return an array of info (name,value)

check_and_create_moddata_dir($backup_unique_code)   X-Ref
No description

check_and_create_user_files_dir($backup_unique_code)   X-Ref
No description

check_and_create_group_files_dir($backup_unique_code)   X-Ref
No description

check_and_create_course_files_dir($backup_unique_code)   X-Ref
No description

check_and_create_site_files_dir($backup_unique_code)   X-Ref
No description

backup_open_xml($backup_unique_code)   X-Ref
No description

backup_close_xml($backup_file)   X-Ref
No description

start_tag($tag,$level=0,$endline=false,$attributes=null)   X-Ref
No description

end_tag($tag,$level=0,$endline=true)   X-Ref
No description

full_tag($tag,$level=0,$endline=true,$content,$attributes=null)   X-Ref
No description

xml_tag_safe_content($content)   X-Ref
No description

backup_general_info($bf,$preferences)   X-Ref
No description

backup_course_start($bf,$preferences)   X-Ref
No description

backup_course_end($bf,$preferences)   X-Ref
No description

backup_course_metacourse($bf,$preferences)   X-Ref
No description

backup_messages($bf,$preferences)   X-Ref
No description

backup_blogs($bf, $preferences)   X-Ref
No description

backup_course_blocks($bf,$preferences)   X-Ref
No description

backup_course_sections($bf,$preferences)   X-Ref
No description

backup_format_data($bf,$preferences)   X-Ref
No description

backup_course_modules($bf,$preferences,$section)   X-Ref
No description

backup_user_info($bf,$preferences)   X-Ref
No description

backup_log_info($bf,$preferences)   X-Ref
No description

backup_gradebook_info($bf, $preferences)   X-Ref
No description

backup_gradebook_category_info($bf, $preferences)   X-Ref
No description

backup_gradebook_item_info($bf, $preferences, $backupall)   X-Ref
No description

backup_gradebook_grade_letters_info($bf, $preferences)   X-Ref
No description

backup_gradebook_outcomes_info($bf, $preferences)   X-Ref
No description

backup_gradebook_grades_info($bf,$preferences, $itemid)   X-Ref
No description

backup_gradebook_categories_history_info($bf, $preferences)   X-Ref
No description

backup_gradebook_grades_history_info($bf, $preferences)   X-Ref
No description

backup_gradebook_items_history_info($bf, $preferences)   X-Ref
No description

backup_gradebook_outcomes_history($bf, $preferences)   X-Ref
No description

backup_scales_info($bf,$preferences)   X-Ref
No description

backup_events_info($bf,$preferences)   X-Ref
No description

backup_groups_info($bf,$preferences)   X-Ref
No description

backup_groups_members_info($bf,$preferences,$groupid)   X-Ref
No description

backup_groupings_info($bf,$preferences)   X-Ref
No description

backup_groupings_groups_info($bf,$preferences)   X-Ref
No description

backup_modules_start($bf,$preferences)   X-Ref
No description

backup_modules_end($bf,$preferences)   X-Ref
No description

backup_module($bf,$preferences,$module)   X-Ref
No description

backup_encode_absolute_links($content)   X-Ref
No description

backup_copy_user_files($preferences)   X-Ref
No description

backup_copy_group_files($preferences)   X-Ref
No description

backup_copy_course_files($preferences)   X-Ref
No description

backup_copy_site_files($preferences)   X-Ref
No description

backup_zip($preferences)   X-Ref
No description

copy_zip_to_course_dir($preferences)   X-Ref
No description

backup_userdata_selected($preferences,$modname,$modid)   X-Ref
compatibility function
with new granular backup
we need to know


backup_mod_selected($preferences,$modname,$modid)   X-Ref
No description

backup_fetch_prefs_from_request(&$preferences,&$count,$course)   X-Ref
No description

backup_fetch_roles($preferences)   X-Ref
No description

write_role_overrides_xml($bf, $context, $startlevel)   X-Ref
No description

write_role_assignments_xml($bf, $preferences, $context, $startlevel)   X-Ref
No description

backup_execute(&$preferences, &$errorstr)   X-Ref
No description

backup_get_backup_string($course)   X-Ref
This function calculates the "backup" part of the file name
from lang files. Used both in manual and scheduled backups

param: object $course course object
return: string "backup" part of the filename

backup_get_zipfile_name($course)   X-Ref
This function generates the default zipfile name for a backup
based on the course shortname

param: object $course course object
return: string filename (excluding path information)

backup_get_keep_name($course)   X-Ref
This function generates the common file substring for a course
used to keep n copies by the scheduled backup

param: object $course course object
return: string common part of filename in backups of this course

backup_add_static_preferences(&$preferences)   X-Ref
This function adds on the standard items to the preferences
Like moodle version and backup version

param: object $preferences existing preferences object.


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