MDL-37457 testing Mark current classes as deprecated
authorDavid Monllao <davidm@moodle.com>
Thu, 10 Jan 2013 07:44:57 +0000 (15:44 +0800)
committerDavid Monllao <davidm@moodle.com>
Tue, 15 Jan 2013 03:07:45 +0000 (11:07 +0800)
12 files changed:
blocks/online_users/tests/generator/lib.php
lib/phpunit/generatorlib.php [new file with mode: 0644]
lib/testing/generator/block_generator.php
lib/testing/generator/data_generator.php
lib/testing/generator/lib.php
lib/testing/generator/module_generator.php
mod/assign/tests/generator/lib.php
mod/assignment/tests/generator/lib.php
mod/data/tests/generator/lib.php
mod/forum/tests/generator/lib.php
mod/lti/tests/generator/lib.php
mod/page/tests/generator/lib.php

index bb0bb0a..dce490b 100644 (file)
@@ -18,7 +18,7 @@
  * block_online_users data generator
  *
  * @package    block_online_users
- * @category   testing
+ * @category   test
  * @copyright  2012 Petr Skoda {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -29,8 +29,8 @@ defined('MOODLE_INTERNAL') || die();
 /**
  * Online users block data generator class
  *
- * @package    mod_page
- * @category   testing
+ * @package    block_online_users
+ * @category   test
  * @copyright  2012 Petr Skoda {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
diff --git a/lib/phpunit/generatorlib.php b/lib/phpunit/generatorlib.php
new file mode 100644 (file)
index 0000000..6dfbdd4
--- /dev/null
@@ -0,0 +1,36 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Adds data generator support
+ *
+ * Deprecated file in favour of lib/testing/generator/lib.php, keeping
+ * file for backwards reference just in case 3rd party applications are
+ * using them.
+ *
+ * @deprecated
+ * @todo       MDL-37517 This will be deleted in Moodle 2.7
+ * @see        lib/testing/generator/lib.php
+ * @package    core
+ * @category   phpunit
+ * @copyright  2012 Petr Skoda {@link http://skodak.org}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+debugging('File lib/phpunit/generatorlib.php is deprecated, please use lib/testing/generator/lib.php instead', DEBUG_DEVELOPER);
+
+require_once(__DIR__ . '/../testing/generator/lib.php');
index dfcfdac..02a2288 100644 (file)
@@ -18,7 +18,7 @@
  * Block generator base class.
  *
  * @package    core
- * @category   testing
+ * @category   test
  * @copyright  2012 Petr Skoda {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -30,7 +30,7 @@
  * Extend in blocks/xxxx/tests/generator/lib.php as class block_xxxx_generator.
  *
  * @package    core
- * @category   testing
+ * @category   test
  * @copyright  2012 Petr Skoda {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -41,6 +41,10 @@ abstract class testing_block_generator {
     /** @var number of created instances */
     protected $instancecount = 0;
 
+    /**
+     * Dumb constructor to throw the deprecated notification
+     * @param testing_data_generator $datagenerator
+     */
     public function __construct(testing_data_generator $datagenerator) {
         $this->datagenerator = $datagenerator;
     }
@@ -110,3 +114,26 @@ abstract class testing_block_generator {
      */
     abstract public function create_instance($record = null, array $options = null);
 }
+
+/**
+ * Deprecated in favour of testing_block_generator
+ *
+ * @deprecated since Moodle 2.5 MDL-37457 - please do not use this function any more.
+ * @todo       MDL-37517 This will be deleted in Moodle 2.7
+ * @see        testing_block_generator
+ * @package    core
+ * @category   test
+ * @copyright  2012 David Monllaó
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+abstract class phpunit_block_generator extends testing_block_generator {
+
+    /**
+     * Dumb constructor to throw the deprecated notification
+     * @param testing_data_generator $datagenerator
+     */
+    public function __construct(testing_data_generator $datagenerator) {
+        debugging('Class phpunit_block_generator is deprecated, please use class testing_block_generator instead', DEBUG_DEVELOPER);
+        parent::__construct($datagenerator);
+    }
+}
index 4b182a2..7f99a93 100644 (file)
  * Data generator.
  *
  * @package    core
- * @category   testing
+ * @category   test
  * @copyright  2012 Petr Skoda {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 
 /**
- * Data generator class for unit tests and other tools
- * that need to create fake test sites.
+ * Data generator class for unit tests and other tools that need to create fake test sites.
  *
  * @package    core
- * @category   testing
+ * @category   test
  * @copyright  2012 Petr Skoda {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -437,8 +436,8 @@ EOD;
      * At the very least it needs to contain courseid.
      * Default values are added for name, description, and descriptionformat if they are not present.
      *
-     * This function calls {@see groups_create_group()} to create the group within the database.
-     *
+     * This function calls groups_create_group() to create the group within the database.
+     * @see groups_create_group
      * @param array|stdClass $record
      * @return stdClass group record
      */
@@ -480,8 +479,8 @@ EOD;
      * At the very least it needs to contain courseid.
      * Default values are added for name, description, and descriptionformat if they are not present.
      *
-     * This function calls {@see groups_create_grouping()} to create the grouping within the database.
-     *
+     * This function calls groups_create_grouping() to create the grouping within the database.
+     * @see groups_create_grouping
      * @param array|stdClass $record
      * @return stdClass grouping record
      */
@@ -602,3 +601,24 @@ EOD;
         return true;
     }
 }
+
+/**
+ * Deprecated in favour of testing_data_generator
+ *
+ * @deprecated since Moodle 2.5 MDL-37457 - please do not use this function any more.
+ * @todo       MDL-37517 This will be deleted in Moodle 2.7
+ * @see        testing_data_generator
+ * @package    core
+ * @category   test
+ * @copyright  2012 David Monllaó
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class phpunit_data_generator extends testing_data_generator {
+
+    /**
+     * Dumb constructor to throw the deprecated notification
+     */
+    public function __construct() {
+        debugging('Class phpunit_data_generator is deprecated, please use class testing_module_generator instead', DEBUG_DEVELOPER);
+    }
+}
index 238a9ca..3afbff2 100644 (file)
@@ -18,7 +18,7 @@
  * Adds data generator support
  *
  * @package    core
- * @category   testing
+ * @category   test
  * @copyright  2012 Petr Skoda {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index eed5d6e..c499f96 100644 (file)
@@ -18,7 +18,7 @@
  * Module generator base class.
  *
  * @package    core
- * @category   testing
+ * @category   test
  * @copyright  2012 Petr Skoda {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
  * Extend in mod/xxxx/tests/generator/lib.php as class mod_xxxx_generator.
  *
  * @package    core
- * @category   testing
+ * @category   test
  * @copyright  2012 Petr Skoda {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 abstract class testing_module_generator {
-    /** @var testing_data_generator@var  */
+
+    /**
+     * @var testing_data_generator
+     */
     protected $datagenerator;
 
-    /** @var number of created instances */
+    /**
+     * @var number of created instances
+     */
     protected $instancecount = 0;
 
+    /**
+     * Dumb constructor to throw the deprecated notification
+     * @param testing_data_generator $datagenerator
+     */
     public function __construct(testing_data_generator $datagenerator) {
         $this->datagenerator = $datagenerator;
     }
@@ -73,9 +82,9 @@ abstract class testing_module_generator {
 
     /**
      * Create course module and link it to course
-     * @param int $courseid
-     * @param array $options: section, visible
-     * @return int $cm instance id
+     * @param integer $courseid
+     * @param array $options section, visible
+     * @return integer $cm instance id
      */
     protected function precreate_course_module($courseid, array $options) {
         global $DB, $CFG;
@@ -140,3 +149,26 @@ abstract class testing_module_generator {
      */
     abstract public function create_instance($record = null, array $options = null);
 }
+
+/**
+ * Deprecated in favour of testing_module_generator
+ *
+ * @deprecated since Moodle 2.5 MDL-37457 - please do not use this function any more.
+ * @todo       MDL-37517 This will be deleted in Moodle 2.7
+ * @see        testing_module_generator
+ * @package    core
+ * @category   test
+ * @copyright  2012 David Monllaó
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+abstract class phpunit_module_generator extends testing_module_generator {
+
+    /**
+     * Dumb constructor to throw the deprecated notification
+     * @param testing_data_generator $datagenerator
+     */
+    public function __construct(testing_data_generator $datagenerator) {
+        debugging('Class phpunit_module_generator is deprecated, please use class testing_module_generator instead', DEBUG_DEVELOPER);
+        parent::__construct($datagenerator);
+    }
+}
index 6521d6f..d1d3384 100644 (file)
@@ -20,7 +20,7 @@ defined('MOODLE_INTERNAL') || die();
  * assign module data generator class
  *
  * @package mod_assign
- * @category testing
+ * @category test
  * @copyright 2012 Paul Charsley
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index bf8affb..9bd8b22 100644 (file)
@@ -18,7 +18,7 @@
  * mod_assignment data generator
  *
  * @package    mod_assignment
- * @category   testing
+ * @category   test
  * @copyright  2012 Petr Skoda {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -30,7 +30,7 @@ defined('MOODLE_INTERNAL') || die();
  * Assignment module data generator class
  *
  * @package    mod_assignment
- * @category   testing
+ * @category   test
  * @copyright  2012 Petr Skoda {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index 872bf66..389769d 100644 (file)
@@ -18,7 +18,7 @@
  * mod_data data generator
  *
  * @package    mod_data
- * @category   testing
+ * @category   test
  * @copyright  2012 Petr Skoda {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -30,7 +30,7 @@ defined('MOODLE_INTERNAL') || die();
  * Database module data generator class
  *
  * @package    mod_data
- * @category   testing
+ * @category   test
  * @copyright  2012 Petr Skoda {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index 926c0f4..7f98768 100644 (file)
@@ -18,7 +18,7 @@
  * mod_forum data generator
  *
  * @package    mod_forum
- * @category   testing
+ * @category   test
  * @copyright  2012 Petr Skoda {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -30,7 +30,7 @@ defined('MOODLE_INTERNAL') || die();
  * Forum module data generator class
  *
  * @package    mod_forum
- * @category   testing
+ * @category   test
  * @copyright  2012 Petr Skoda {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index 07aa214..5fc7a09 100644 (file)
@@ -18,7 +18,7 @@
  * mod_lti data generator
  *
  * @package    mod_lti
- * @category   testing
+ * @category   test
  * @copyright  Copyright (c) 2012 Moodlerooms Inc. (http://www.moodlerooms.com)
  * @author     Mark Nielsen
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
@@ -30,7 +30,7 @@ defined('MOODLE_INTERNAL') || die();
  * LTI module data generator class
  *
  * @package    mod_lti
- * @category   testing
+ * @category   test
  * @copyright  Copyright (c) 2012 Moodlerooms Inc. (http://www.moodlerooms.com)
  * @author     Mark Nielsen
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
index f1a2414..533c9ff 100644 (file)
@@ -18,7 +18,7 @@
  * mod_page data generator
  *
  * @package    mod_page
- * @category   testing
+ * @category   test
  * @copyright  2012 Petr Skoda {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -30,7 +30,7 @@ defined('MOODLE_INTERNAL') || die();
  * Page module data generator class
  *
  * @package    mod_page
- * @category   testing
+ * @category   test
  * @copyright  2012 Petr Skoda {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */