Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
backup_book_activity_task Class Reference
Inheritance diagram for backup_book_activity_task:
backup_activity_task backup_task base_task checksumable executable loggable

Public Member Functions

 add_result ($result)
 Add the given info to the current plan's results.
 
 add_step ($step)
 
 build ()
 Create all the steps that will be part of this task.
 
 calculate_checksum ()
 This function will return one unique and stable checksum for one instance of the class implementing it.
 
 destroy ()
 Destroy all circular references.
 
 execute ()
 Exceptionally override the execute method, so, based in the activity_included setting, we are able to skip the execution of one task completely.
 
 get_activityid ()
 
 get_backupid ()
 
 get_basepath ()
 
 get_contextid ()
 
 get_courseid ()
 
 get_kept_roles ()
 Get the user roles that should be kept in the destination course for a course copy operation.
 
 get_logger ()
 
 get_moduleid ()
 
 get_modulename ()
 
 get_name ()
 
 get_progress ()
 Gets the progress reporter, which can be used to report progress within the backup or restore process.
 
 get_results ()
 Return the current plan's results.
 
 get_sectionid ()
 
 get_setting ($name)
 Tries to look for the instance specific setting value, task specific setting value or the common plan setting value - in that order.
 
 get_setting_value ($name)
 
 get_settings ()
 
 get_steps ()
 
 get_taskbasepath ()
 
 get_weight ()
 Returns the weight of this task, an approximation of the amount of time it will take.
 
 is_checksum_correct ($checksum)
 Given one checksum, returns if matches object's checksum (true) or no (false)
 
 is_excluding_activities ()
 
 log ($message, $level, $a=null, $depth=null, $display=false)
 This function will be responsible for handling the params, and to call to the corresponding logger->process() once all modifications in params have been performed.
 
 set_plan ($plan)
 
 setting_exists ($name)
 

Static Public Member Functions

static encode_content_links ($content)
 Code the transformations to perform in the activity in order to get transportable (encoded) links.
 

Protected Member Functions

 add_setting ($setting)
 
 define_my_settings ()
 Define (add) particular settings this activity can have.
 
 define_my_steps ()
 Define (add) particular steps this activity can have.
 
 define_settings ()
 Defines the common setting that any backup activity will have.
 

Protected Attributes

 $activityid
 
bool $built
 
 $contextid
 
bool $executed
 
 $moduleid
 
 $modulename
 
string $name
 
backup_plan restore_plan $plan
 
 $sectionid
 
base_setting[] $settings
 
base_step[] $steps
 

Member Function Documentation

◆ add_result()

base_task::add_result ( $result)
inherited

Add the given info to the current plan's results.

See also
base_plan\add_result()
Parameters
array$resultassociative array describing a result of a task/step

◆ build()

backup_activity_task::build ( )
inherited

Create all the steps that will be part of this task.

Reimplemented from base_task.

◆ calculate_checksum()

base_task::calculate_checksum ( )
inherited

This function will return one unique and stable checksum for one instance of the class implementing it.

It's each implementation responsibility to do it recursively if needed and use optional store (caching) of the checksum if necessary/possible

Implements checksumable.

◆ define_my_settings()

backup_book_activity_task::define_my_settings ( )
protected

Define (add) particular settings this activity can have.

Return values
void

Reimplemented from backup_activity_task.

◆ define_my_steps()

backup_book_activity_task::define_my_steps ( )
protected

Define (add) particular steps this activity can have.

Return values
void

Reimplemented from backup_activity_task.

◆ define_settings()

backup_activity_task::define_settings ( )
protectedinherited

Defines the common setting that any backup activity will have.

Reimplemented from base_task.

◆ destroy()

base_task::destroy ( )
inherited

Destroy all circular references.

It helps PHP 5.2 a lot!

◆ encode_content_links()

static backup_book_activity_task::encode_content_links ( $content)
static

Code the transformations to perform in the activity in order to get transportable (encoded) links.

Parameters
string$content
Return values
stringencoded content

Reimplemented from backup_activity_task.

◆ execute()

backup_activity_task::execute ( )
inherited

Exceptionally override the execute method, so, based in the activity_included setting, we are able to skip the execution of one task completely.

Reimplemented from base_task.

◆ get_activityid()

backup_activity_task::get_activityid ( )
inherited
Return values
intthe id of the activity instance (id in the activity's instances table)

◆ get_contextid()

backup_activity_task::get_contextid ( )
inherited
Return values
intthe id of the associated CONTEXT_MODULE instance

◆ get_kept_roles()

backup_task::get_kept_roles ( )
inherited

Get the user roles that should be kept in the destination course for a course copy operation.

Return values
array

◆ get_moduleid()

backup_activity_task::get_moduleid ( )
inherited
Return values
intthe course module id (id in the course_modules table)

◆ get_modulename()

backup_activity_task::get_modulename ( )
inherited
Return values
stringthe name of the module, eg 'workshop' (from the modules table)

◆ get_progress()

base_task::get_progress ( )
inherited

Gets the progress reporter, which can be used to report progress within the backup or restore process.

Return values
core\progress\baseProgress reporting object

◆ get_results()

base_task::get_results ( )
inherited

Return the current plan's results.

Return values
array|null

◆ get_sectionid()

backup_activity_task::get_sectionid ( )
inherited
Return values
intthe course section id (id in the course_sections table)

◆ get_setting()

backup_activity_task::get_setting ( $name)
inherited

Tries to look for the instance specific setting value, task specific setting value or the common plan setting value - in that order.

Parameters
string$namethe name of the setting
Return values
mixed|nullthe value of the setting or null if not found

Reimplemented from base_task.

◆ get_taskbasepath()

backup_activity_task::get_taskbasepath ( )
inherited
Return values
stringfull path to the directory where this task writes its files

Reimplemented from base_task.

◆ get_weight()

base_task::get_weight ( )
inherited

Returns the weight of this task, an approximation of the amount of time it will take.

By default this value is 1. It can be increased for longer tasks.

Return values
intWeight

Reimplemented in backup_final_task.

◆ is_checksum_correct()

base_task::is_checksum_correct ( $checksum)
inherited

Given one checksum, returns if matches object's checksum (true) or no (false)

Implements checksumable.

◆ log()

base_task::log ( $message,
$level,
$a = null,
$depth = null,
$display = false )
inherited

This function will be responsible for handling the params, and to call to the corresponding logger->process() once all modifications in params have been performed.

Implements loggable.


The documentation for this class was generated from the following file: