L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

The handler's process_xxx() method is not mandatory any more

Browse Source 
It was realized that it is pretty common to register a convert_path just
to be able to attach on-start or on-end listeners to it, without actual
processing data. So now, the handler must provide at least one of these
three methods and the process_xxx() does not need to be there if it is
not needed.
This commit is contained in:
David Mudrak
2011-05-19 03:17:18 +02:00
parent ae80f68f31
commit 46ff8b0ecf
1 changed files with 56 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
backup/converter/moodle1/lib.php
+56 -8
View File
@@ -266,7 +266,11 @@ class moodle1_converter extends base_converter {
if (is_null($this->pathlock)) {
$rawdatatags = $data['tags'];
$data['tags'] = $element->apply_recipes($data['tags']);
$returned = $object->$method($data['tags'], $rawdatatags);
// if the processing method exists, give it a chance to modify data
if (method_exists($object, $method)) {
$returned = $object->$method($data['tags'], $rawdatatags);
}
}
// if the dispatched method returned SKIP_ALL_CHILDREN, remember the current path
@@ -306,7 +310,7 @@ class moodle1_converter extends base_converter {
$element = $this->pathelements[$path];
$pobject = $element->get_processing_object();
$method = 'on_' . $element->get_name() . '_start';
$method = $element->get_start_method();
if (method_exists($pobject, $method)) {
$pobject->$method();
@@ -342,8 +346,8 @@ class moodle1_converter extends base_converter {
$element = $this->pathelements[$path];
$pobject = $element->get_processing_object();
$method = $element->get_end_method();
$data = $element->get_data();
$method = 'on_' . $element->get_name() . '_end';
if (method_exists($pobject, $method)) {
$pobject->$method($data['tags']);
@@ -644,6 +648,12 @@ class convert_path {
/** @var string the name of the processing method */
protected $pmethod = null;
/** @var string the name of the path start event handler */
protected $smethod = null;
/** @var string the name of the path end event handler */
protected $emethod = null;
/** @var mixed last data read for this element or returned data by processing method */
protected $data = null;
@@ -672,8 +682,10 @@ class convert_path {
$this->path = $path;
$this->grouped = $grouped;
// set the default processing method name
// set the default method names
$this->set_processing_method('process_' . $name);
$this->set_start_method('on_'.$name.'_start');
$this->set_end_method('on_'.$name.'_end');
if (isset($recipe['dropfields']) and is_array($recipe['dropfields'])) {
$this->set_dropped_fields($recipe['dropfields']);
@@ -705,6 +717,24 @@ class convert_path {
$this->pmethod = $pmethod;
}
/**
* Sets the name of the path start event listener
*
* @param string $smethod
*/
public function set_start_method($smethod) {
$this->smethod = $smethod;
}
/**
* Sets the name of the path end event listener
*
* @param string $emethod
*/
public function set_end_method($emethod) {
$this->emethod = $emethod;
}
/**
* Sets the element data
*
@@ -815,6 +845,20 @@ class convert_path {
return $this->pmethod;
}
/**
* @return string the name of the path start event listener
*/
public function get_start_method() {
return $this->smethod;
}
/**
* @return string the name of the path end event listener
*/
public function get_end_method() {
return $this->emethod;
}
/**
* @return mixed the element data
*/
@@ -852,7 +896,9 @@ class convert_path {
/**
* Makes sure that the given object is a valid processing object
*
* The processing object must be an object providing the element's processing method.
* The processing object must be an object providing at least element's processing method
* or path-reached-end event listener or path-reached-start listener method.
*
* Note it may look as if we used exceptions for code flow control here. That's not the case
* as we actually validate the code, not the user data. And the code is supposed to be
* correct.
@@ -863,10 +909,12 @@ class convert_path {
*/
protected function validate_pobject($pobject) {
if (!is_object($pobject)) {
throw new convert_path_exception('convert_path_no_object', $pobject);
throw new convert_path_exception('convert_path_no_object', get_class($pobject));
}
if (!method_exists($pobject, $this->get_processing_method())) {
throw new convert_path_exception('convert_path_missingmethod', $this->get_processing_method());
if (!method_exists($pobject, $this->get_processing_method()) and
!method_exists($pobject, $this->get_end_method()) and
!method_exists($pobject, $this->get_start_method())) {
throw new convert_path_exception('convert_path_missing_method', get_class($pobject));
}
}
}