Refactoring filter_manager and adapting old tests. manager_tests fail…

…ing...

block_xp.php

@@ -91,8 +91,7 @@ public function instance_create() {
 
  // Copy default filters to course
  // TODO: only do this the first time the block is added.
- $filtermanager = new block_xp_filter_manager($manager);
- $filtermanager->copy_default_filters_to_course();
+ $manager->get_filter_manager()->copy_default_filters();
 
  return true;
  }

classes/filter.php

@@ -56,7 +56,7 @@ class block_xp_filter implements renderable {
  *
  * @var int
  */
- protected $id;
+ public $id;
 
  /**
  * Points for this filter.
@@ -185,6 +185,31 @@ public static function load_from_data($record) {
  return $filter;
  }
 
+ // TODO: testing if we can replace static load_from_data
+ public function load_from_data2($object) {
+ //$record = (array) $record;
+ $object = (is_array($object)) ? (object)$object : $object;
+ //print_object($record);
+ foreach ($object as $key => $value) {
+ if ($key == 'rule' and !empty($value)) {
+ $this->set_rule($value);
+ continue;
+ }
+
+ if ($key == 'points') {
+ // Prevent negatives.
+ $value = abs(intval($value));
+ } else if ($key == 'sortorder') {
+ $value = intval($value);
+ }
+
+ $this->$key = $value;
+ }
+ if (is_null($this->rule) and is_null($this->ruledata)) {
+ throw new coding_exception("filter must have rule or ruledata property");
+ }
+ }
+
  /**
  * Load the rule from {@link self::$ruledata}.
  *
@@ -229,20 +254,9 @@ public function save() {
  $this->insert_or_update('block_xp_filters', $record);
  }
 
- /**
- * Save the record as a default filter
- *
- * @return void
- */
-
- public function save_default() {
- $record = (object) array(
- 'ruledata' => $this->ruledata,
- 'points' => $this->points,
- 'sortorder' => $this->sortorder,
- );
-
- $this->insert_or_update('block_xp_default_filters', $record);
+ public function cmp($a, $b)
+ {
+ return strcmp($a->sortorder, $b->sortorder);
  }
 
  protected function insert_or_update($table, $record) {

classes/filter_course.php

@@ -39,18 +39,33 @@ public function __construct($courseid) {
  }
 
  /**
- * Loads object properties from array, stdClass or block_xp_filter
+ * Loads object properties from array, stdClass or block_xp_filter.
+ *
  *
  * @param block_xp_filter|array $filter
  */
  public function load($object) {
- $object = (is_array($object)) ? (object)$object : $object;
+ //$object = (is_array($object)) ? (object)$object : $object;
+ $tempcourseid = $this->courseid;
+ $this->load_from_data2($object);
+ $this->courseid = $tempcourseid;
+// foreach ($this as $key => $value) {
+// if ($key != "courseid") {
+// if (isset($object->$key)) {
+// $this->$key = $object->$key;
+// }
+// }
+// }
+ }
 
- foreach ($this as $key => $value) {
- if (isset($object->$key)) {
- $this->$key = $object->$key;
- }
- }
+ /**
+ * As load but always create a new object in DB.
+ *
+ * @param block_xp_filter|array $filter
+ */
+ public function load_as_new($object) {
+ $this->load($object);
+ $this->id = null;
  }
 
  public function save() {

classes/filter_manager.php

@@ -33,20 +33,17 @@
  */
 class block_xp_filter_manager {
 
- /**
- * The block XP manager.
- *
- * @var block_xp_manager.
- */
- protected $manager;
+ protected $courseid;
 
+ protected $filterset;
  /**
  * Constructor.
  *
  * @param block_xp_manager $manager The XP manager.
  */
- public function __construct(block_xp_manager $manager) {
- $this->manager = $manager;
+ public function __construct($courseid) {
+ $this->courseid = $courseid;
+ $this->filterset = new block_xp_filterset_course($courseid);
  }
 
  /**
@@ -58,7 +55,7 @@ public function __construct(block_xp_manager $manager) {
  */
  public function get_all_filters() {
  $cache = cache::make('block_xp', 'filters');
- $key = 'filters_' . $this->manager->get_courseid();
+ $key = 'filters_' . $this->get_courseid();
  if (false === ($filters = $cache->get($key))) {
  $filters = $this->get_course_filters();
  $cache->set($key, $filters);
@@ -72,7 +69,7 @@ public function get_all_filters() {
  * @return course id
  */
  public function get_courseid() {
- return $this->manager->get_courseid();
+ return $this->courseid;
  }
 
 
@@ -97,10 +94,7 @@ public function get_points_for_event(\core\event\base $event) {
  * @return array Of filter objects.
  */
  public static function get_static_filters() {
- $staticfilters = new block_xp_filterset_static();
- $staticfilters->load();
-
- return $staticfilters->get();
+ return (new block_xp_filterset_static())->get();
  }
 
  /**
@@ -109,15 +103,7 @@ public static function get_static_filters() {
  * @return array of filter data from the DB, though properties is already json_decoded.
  */
  public function get_course_filters() {
- global $DB;
- $results = $DB->get_recordset('block_xp_filters', array('courseid' => $this->get_courseid()),
- 'sortorder ASC, id ASC');
- $filters = array();
- foreach ($results as $key => $filter) {
- $filters[$filter->id] = block_xp_filter::load_from_data($filter);
- }
- $results->close();
- return $filters;
+ return $this->filterset->get();
  }
 
  /**
@@ -137,21 +123,33 @@ public function get_user_filters() {
  public static function save_default_filters() {
  $staticfilters = new block_xp_filterset_static();
  $defaultfilters = new block_xp_filterset_default();
-
  $defaultfilters->import($staticfilters);
  }
 
  /**
  * Used when adding block to course
  *
  * @return void */
- public function copy_default_filters_to_course() {
+ public function copy_default_filters() {
  $defaultfilters = new block_xp_filterset_default();
- $coursefilters = new block_xp_filterset_course($this->get_courseid());
+ print_object("--REGLAS DEFECTO DENTRO ANTES APPEND --");
+ print_object($defaultfilters->get());
+ $this->filterset->append($defaultfilters);
+ print_object("--REGLAS DEFECTO DENTRO DESPUES APPEND --");
+ print_object($defaultfilters->get());
 
- if ($coursefilters->empty()) {
- $coursefilters->import($defaultfilters);
- }
+
+ }
+
+ public static function copy_default_filters_to_course($courseid) {
+ $defaultfilters = new block_xp_filterset_default();
+ $coursefilters = new block_xp_filterset_course($courseid);
+ print_object("--REGLAS DEFECTO DENTRO ANTES APPEND --");
+ print_object($defaultfilters->get());
+
+ $coursefilters->append($defaultfilters);
+ print_object("--REGLAS DEFECTO DENTRO DESPUES APPEND --");
+ print_object($defaultfilters->get());
  }
 
  /**
@@ -164,4 +162,8 @@ public function invalidate_filters_cache() {
  $cache->delete('filters_' . $this->get_courseid());
  }
 
+ public function get_filterset() {
+ return $this->filterset;
+ }
+
 }

classes/filterset.php

@@ -66,20 +66,16 @@ public function save() {
  }
  }
 
- public function merge(block_xp_filterset $filters) {
+ public function append(block_xp_filterset $filters) {
  foreach ($filters->get() as $filter) {
- $clonedfilter = $this->create_filter();
- $clonedfilter->load($filter);
- $this->add_last($clonedfilter);
+ $this->add_last($filter);
  }
-
- $this->reset_sortorder();
  $this->save();
  }
 
  public function import(block_xp_filterset $filters) {
  $this->delete_all();
- $this->merge($filters);
+ $this->append($filters);
  }
 
  /*
@@ -96,20 +92,23 @@ public function delete_all() {
  }
 
  public function add_last(block_xp_filter $filter) {
- $this->filters[] = $filter;
+ $clonedfilter = $this->create_filter();
+ $clonedfilter->load($filter);
+ $this->filters[] = $clonedfilter;
  $this->reset_sortorder();
  }
 
  public function add_first(block_xp_filter $filter) {
- $this->add($filter, 0);
+ $clonedfilter = $this->create_filter();
+ $clonedfilter->load_as_new($filter);
+ $this->add($clonedfilter, 0);
  }
 
- /*
- * Insert filter in specific position
- */
  public function add($filter, $position) {
+ $clonedfilter = $this->create_filter();
+ $clonedfilter->load_as_new($filter);
  $position = min($position, $this->count()+1);
- array_splice( $this->filters, $position, 0, [$filter] );
+ array_splice( $this->filters, $position, 0, [$clonedfilter] );
  $this->reset_sortorder();
  }
 

classes/filterset_course.php

@@ -42,19 +42,24 @@ public function __construct($id) {
  parent::__construct();
  }
 
+ // TODO: refactor
  public function load() {
  global $DB;
 
- $records = $DB->get_recordset('block_xp_filters',
- array('courseid' => $this->courseid));
+ $recordset = $DB->get_recordset('block_xp_filters',
+ array('courseid' => $this->courseid),
+ 'sortorder ASC, id ASC');
 
  $this->clean();
 
- foreach ($records as $key => $filterdata) {
- $filter = $this->create_filter();
- $filter->load($filterdata);
- $this->filters[] = $filter;
+ if ($recordset->valid()) {
+ foreach ($recordset as $key => $filterdata) {
+ $filter = $this->create_filter();
+ $filter->load($filterdata);
+ $this->filters[] = $filter;
+ }
  }
+ $recordset->close();
  }
 
  public function create_filter() {

classes/filterset_default.php

@@ -37,16 +37,26 @@ class block_xp_filterset_default extends block_xp_filterset {
  public function load() {
  global $DB;
 
- $records = $DB->get_recordset('block_xp_filters',
- array('courseid' => 0));
+ $recordset = $DB->get_recordset('block_xp_filters',
+ array('courseid' => 0),
+ 'sortorder ASC, id ASC');
 
- unset($this->filters);
+ print_object("--RECORDS DEFAULT--");
+ print_object($recordset);
 
- foreach ($records as $key => $filterdata) {
- $filter = $this->create_filter();
- $filter->load($filterdata);
- $this->filters[] = $filter;
+
+ if ($recordset->valid()) {
+ $this->clean();
+ foreach ($recordset as $key => $filterdata) {
+ $filter = $this->create_filter();
+ $filter->load($filterdata);
+ $this->filters[] = $filter;
+ }
+ }
+ else {
+ throw new coding_exception("Default filters can't be retrieved");
  }
+ $recordset->close();
  }
 
  public function create_filter() {

classes/manager.php

@@ -395,7 +395,7 @@ public static function get_default_config() {
  */
  public function get_filter_manager() {
  if (!$this->filtermanager) {
- $this->filtermanager = new block_xp_filter_manager($this);
+ $this->filtermanager = new block_xp_filter_manager($this->get_courseid());
  }
  return $this->filtermanager;
  }