Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/backup/moodle2/ -> backup_course_task.class.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401]

Defines backup_course_task

Copyright: 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 209 lines (9 kb)
Included or required:0 times
Referenced: 1 time
Includes or requires: 0 files

Defines 1 class

backup_course_task:: (7 methods):
  __construct()
  get_contextid()
  get_taskbasepath()
  build()
  encode_content_links()
  encode_links_helper()
  define_settings()


Class: backup_course_task  - X-Ref

course task that provides all the properties and common steps to be performed
when one course is being backup

TODO: Finish phpdocs
__construct($name, $courseid, $plan = null)   X-Ref
Constructor - instantiates one object of this class


get_contextid()   X-Ref
No description

get_taskbasepath()   X-Ref
Course tasks have their own directory to write files


build()   X-Ref
Create all the steps that will be part of this task


encode_content_links($content)   X-Ref
Code the transformations to perform in the course in
order to get transportable (encoded) links

param: string $content content in which to encode links.
return: string content with links encoded.

encode_links_helper($content, $name, $path)   X-Ref
Helper method, used by encode_content_links.

param: string $content content in which to encode links.
param: string $name the name of this type of encoded link.
param: string $path the path that identifies this type of link, up
return: string content with one type of link encoded.

define_settings()   X-Ref
Define the common setting that any backup section will have