Moodle  2.2.1
http://www.collinsharper.com
restore_decode_processor Class Reference

Public Member Functions

 __construct ($restoreid, $sourcewwwroot, $targetwwwroot)
 add_content ($content)
 add_rule ($rule)
 execute ()
 decode_content ($content)

Static Public Member Functions

static register_link_decoders ($processor)

Protected Member Functions

 precheck_content ($content)

Protected Attributes

 $contents
 $rules
 $restoreid
 $sourcewwwroot
 $targetwwwroot

Detailed Description

Helper class that will perform all the necessary decoding tasks on restore

This class will register all the restore_decode_content and restore_decode_rule instances defined by the restore tasks in order to perform the complete decoding of links in the final task of the restore_plan execution.

By visiting each content provider will apply all the defined rules

TODO: Complete phpdocs

Definition at line 39 of file restore_decode_processor.class.php.


Constructor & Destructor Documentation

__construct ( restoreid,
sourcewwwroot,
targetwwwroot 
)

Definition at line 47 of file restore_decode_processor.class.php.


Member Function Documentation

add_content ( content)

Definition at line 56 of file restore_decode_processor.class.php.

add_rule ( rule)

Definition at line 64 of file restore_decode_processor.class.php.

decode_content ( content)

Receive content from restore_decode_content objects and apply all the restore_decode_rules to them

Definition at line 89 of file restore_decode_processor.class.php.

Here is the call graph for this function:

execute ( )

Visit all the restore_decode_content providers that will cause decode_content() to be called for each content

Definition at line 78 of file restore_decode_processor.class.php.

precheck_content ( content) [protected]

Perform some general checks in content. Returning false rules processing is skipped

Definition at line 171 of file restore_decode_processor.class.php.

Here is the caller graph for this function:

static register_link_decoders ( processor) [static]

Adds all the course/section/activity/block contents and rules

Definition at line 103 of file restore_decode_processor.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:


Field Documentation

$contents [protected]

Definition at line 41 of file restore_decode_processor.class.php.

$restoreid [protected]

Definition at line 43 of file restore_decode_processor.class.php.

$rules [protected]

Definition at line 42 of file restore_decode_processor.class.php.

$sourcewwwroot [protected]

Definition at line 44 of file restore_decode_processor.class.php.

$targetwwwroot [protected]

Definition at line 45 of file restore_decode_processor.class.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations