Moodle  2.2.1
http://www.collinsharper.com
backup_setting Class Reference
Inheritance diagram for backup_setting:
Collaboration diagram for backup_setting:

Public Member Functions

 __construct ($name, $vtype, $value=null, $visibility=self::VISIBLE, $status=self::NOT_LOCKED)
 get_level ()
 make_ui ($type, $label, array $attributes=null, array $options=null)
 add_dependency (backup_setting $dependentsetting, $type=setting_dependency::DISABLED_VALUE, $options=array())
 calculate_checksum ()
 is_checksum_correct ($checksum)

Data Fields

const ROOT_LEVEL = 1
const COURSE_LEVEL = 5
const SECTION_LEVEL = 9
const ACTIVITY_LEVEL = 13

Protected Attributes

 $level

Detailed Description

This abstract class defines one backup_setting

TODO: Finish phpdocs

Definition at line 30 of file backup_setting.class.php.


Constructor & Destructor Documentation

__construct ( name,
vtype,
value = null,
visibility = self::VISIBLE,
status = self::NOT_LOCKED 
)

Member Function Documentation

add_dependency ( backup_setting dependentsetting,
type = setting_dependency::DISABLED_VALUE,
options = array() 
)

Definition at line 93 of file backup_setting.class.php.

Here is the call graph for this function:

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.

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

Here is the caller graph for this function:

get_level ( )

Returns the level of the setting

Returns:
{int} One of the above constants

Definition at line 55 of file backup_setting.class.php.

Here is the caller graph for this function:

is_checksum_correct ( checksum)

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

Implements checksumable.

Definition at line 110 of file backup_setting.class.php.

Here is the call graph for this function:

make_ui ( type,
label,
array attributes = null,
array options = null 
)

Creates and sets a user interface for this setting given appropriate arguments

Parameters:
int$type
string$label
array$attributes
array$options

Definition at line 67 of file backup_setting.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:


Field Documentation

$level [protected]

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

const ACTIVITY_LEVEL = 13

Definition at line 36 of file backup_setting.class.php.

const COURSE_LEVEL = 5

Definition at line 34 of file backup_setting.class.php.

const ROOT_LEVEL = 1

Definition at line 33 of file backup_setting.class.php.

const SECTION_LEVEL = 9

Definition at line 35 of file backup_setting.class.php.


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