moodle1_inforef_manager Class Reference

Public Member Functions
	__construct (moodle1_converter $converter, $name, $id=0)
	add_ref ($item, $id)
	add_refs ($item, array $ids)
	write_refs (xml_writer $xmlwriter)
Protected Member Functions
	validate_item ($item)
Protected Attributes
	$annotator = null
	$annotatorid = null

---

Detailed Description

Helper class that handles ids annotations for inforef.xml files

Definition at line 1436 of file lib.php.

---

Constructor & Destructor Documentation

__construct	(	moodle1_converter $	converter,
		$	name,
		$	id = 0
	)

Creates new instance of the manager for the given annotator

The identification of the annotator we serve to may be important in the future when we move the actual storage of the references from memory to a persistent storage.

Parameters:

moodle1_converter	$converter
string	$name	the name of the annotator (like course, section, activity, block)
int	$id	the id of the annotator if required

Definition at line 1457 of file lib.php.

---

Member Function Documentation

add_ref	(	$	item,
		$	id
	)

Adds a reference

Parameters:

string	$item	the name of referenced item (like user, file, scale, outcome or grade_item)
int	$id	the value of the reference

Definition at line 1468 of file lib.php.

Here is the call graph for this function:

add_refs	(	$	item,
		array $	ids
	)

Adds a bulk of references

Parameters:

string	$item	the name of referenced item (like user, file, scale, outcome or grade_item)
array	$ids	the list of referenced ids

Definition at line 1479 of file lib.php.

Here is the call graph for this function:

validate_item

(

$

item

)

[protected]

Makes sure that the given name is a valid citizen of inforef.xml file

See also:

backup_helper::get_inforef_itemnames()

Parameters:

string

$item

the name of reference (like user, file, scale, outcome or grade_item)

Exceptions:

coding_exception

Definition at line 1510 of file lib.php.

Here is the caller graph for this function:

write_refs

(

xml_writer $

xmlwriter

)

Writes the current references using a given opened xml writer

Parameters:

xml_writer

$xmlwriter

Definition at line 1491 of file lib.php.

Here is the call graph for this function:

---

Field Documentation

$annotator = null [protected]

Definition at line 1439 of file lib.php.

$annotatorid = null [protected]

Definition at line 1442 of file lib.php.

---

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

• C:/xampp/htdocs/moodle/backup/converter/moodle1/lib.php