MDL-58430 core_calendar: Keep interfaces with implementations

All interfaces have been moved from the interfaces folder such that they now live with their default implementations. Part of MDL-55611 epic.
NoelDeMartin · Apr 4, 2017 · 42e76c3 · 42e76c3
1 parent 4265458
commit 42e76c3
Show file tree

Hide file tree

Showing 43 changed files with 82 additions and 88 deletions.
diff --git a/calendar/classes/action_factory.php b/calendar/classes/action_factory.php
@@ -26,7 +26,7 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-use core_calendar\local\interfaces\action_factory_interface;
+use core_calendar\local\event\factories\action_factory_interface;
 use core_calendar\local\event\value_objects\action;
 
 /**

diff --git a/calendar/classes/external/event_action_exporter.php b/calendar/classes/external/event_action_exporter.php
@@ -27,8 +27,8 @@
 defined('MOODLE_INTERNAL') || die();
 
 use core\external\exporter;
+use core_calendar\local\event\entities\action_interface;
 use core_calendar\local\event\core_container;
-use core_calendar\local\interfaces\action_interface;
 use renderer_base;
 
 /**
@@ -113,7 +113,7 @@ protected function get_other_values(renderer_base $output) {
     protected static function define_related() {
         return [
             'context' => 'context',
-            'event' => '\\core_calendar\\local\\interfaces\\event_interface'
+            'event' => '\\core_calendar\\local\\event\\entities\\event_interface'
         ];
     }
 }
diff --git a/calendar/classes/external/event_exporter.php b/calendar/classes/external/event_exporter.php
@@ -27,8 +27,7 @@
 defined('MOODLE_INTERNAL') || die();
 
 use \core\external\exporter;
-use \core_calendar\local\interfaces\event_interface;
-use \core_calendar\local\interfaces\action_event_interface;
+use \core_calendar\local\event\entities\event_interface;
 use \core_course\external\course_summary_exporter;
 use \renderer_base;
 

diff --git a/calendar/classes/external/event_icon_exporter.php b/calendar/classes/external/event_icon_exporter.php
@@ -27,7 +27,7 @@
 defined('MOODLE_INTERNAL') || die();
 
 use \core\external\exporter;
-use \core_calendar\local\interfaces\event_interface;
+use \core_calendar\local\event\entities\event_interface;
 
 /**
  * Class for displaying a calendar event's icon.

diff --git a/calendar/classes/external/events_related_objects_cache.php b/calendar/classes/external/events_related_objects_cache.php
@@ -27,7 +27,7 @@
 defined('MOODLE_INTERNAL') || die();
 
 use context;
-use \core_calendar\local\interfaces\event_interface;
+use \core_calendar\local\event\entities\event_interface;
 use stdClass;
 
 /**

diff --git a/calendar/classes/local/api.php b/calendar/classes/local/api.php
@@ -55,7 +55,7 @@ class api {
      * @param bool          $withduration          If true return only events starting within specified
      *                                             timestart otherwise return in progress events as well.
      * @param bool          $ignorehidden          If true don't return hidden events.
-     * @return \core_calendar\local\interfaces\event_interface[] Array of event_interfaces.
+     * @return \core_calendar\local\event\entities\event_interface[] Array of event_interfaces.
      */
     public static function get_events(
         $timestartfrom = null,
@@ -117,7 +117,15 @@ public static function get_events(
      * @param boolean $ignorehidden whether to select only visible events or all events
      * @return array $events of selected events or an empty array if there aren't any (or there was an error)
      */
-    public static function get_legacy_events($tstart, $tend, $users, $groups, $courses, $withduration = true, $ignorehidden = true) {
+    public static function get_legacy_events(
+        $tstart,
+        $tend,
+        $users,
+        $groups,
+        $courses,
+        $withduration = true,
+        $ignorehidden = true
+    ) {
         $fixedparams = array_map(function($param) {
             if ($param === true) {
                 return null;

diff --git a/calendar/classes/local/event/core_container.php b/calendar/classes/local/event/core_container.php
@@ -32,12 +32,11 @@
 
 use core_calendar\action_factory;
 use core_calendar\local\event\data_access\event_vault;
+use core_calendar\local\event\entities\event_interface;
 use core_calendar\local\event\factories\action_event_factory;
 use core_calendar\local\event\factories\event_factory;
 use core_calendar\local\event\mappers\event_mapper;
 use core_calendar\local\event\strategies\raw_event_retrieval_strategy;
-use core_calendar\local\interfaces\action_event_interface;
-use core_calendar\local\interfaces\event_interface;
 
 /**
  * Core container.
@@ -57,7 +56,7 @@ class core_container {
     protected static $actioneventfactory;
 
     /**
-     * @var \core_calendar\local\interfaces\event_mapper_interface $eventmapper Event mapper.
+     * @var \core_calendar\local\event\mappers\event_mapper_interface $eventmapper Event mapper.
      */
     protected static $eventmapper;
 
@@ -67,12 +66,12 @@ class core_container {
     protected static $actionfactory;
 
     /**
-     * @var \core_calendar\local\event\data_access\event_vault $eventvault Event vault.
+     * @var event_vault $eventvault Event vault.
      */
     protected static $eventvault;
 
     /**
-     * @var \core_calendar\local\event\strategies\raw_event_retrieval_strategy $eventretrievalstrategy Event retrieval strategy.
+     * @var raw_event_retrieval_strategy $eventretrievalstrategy Event retrieval strategy.
      */
     protected static $eventretrievalstrategy;
 
@@ -175,7 +174,7 @@ public static function get_event_factory() {
     /**
      * Gets the event mapper.
      *
-     * @return \core_calendar\local\interfaces\event_mapper_interface
+     * @return event_mapper
      */
     public static function get_event_mapper() {
         self::init();
@@ -185,7 +184,7 @@ public static function get_event_mapper() {
     /**
      * Return an event vault.
      *
-     * @return \core_calendar\local\event\data_access\event_vault
+     * @return event_vault
      */
     public static function get_event_vault() {
         self::init();

diff --git a/calendar/classes/local/event/data_access/event_vault.php b/calendar/classes/local/event/data_access/event_vault.php
@@ -26,12 +26,12 @@
 
 defined('MOODLE_INTERNAL') || die();
 
+use core_calendar\local\event\entities\action_event_interface;
+use core_calendar\local\event\entities\event_interface;
 use core_calendar\local\event\exceptions\limit_invalid_parameter_exception;
-use core_calendar\local\interfaces\action_event_interface;
-use core_calendar\local\interfaces\event_factory_interface;
-use core_calendar\local\interfaces\event_interface;
-use core_calendar\local\interfaces\event_vault_interface;
-use core_calendar\local\interfaces\raw_event_retrieval_strategy_interface;
+use core_calendar\local\event\factories\action_factory_interface;
+use core_calendar\local\event\factories\event_factory_interface;
+use core_calendar\local\event\strategies\raw_event_retrieval_strategy_interface;
 
 /**
  * Event vault class.

diff --git a/...ocal/interfaces/event_vault_interface.php → ...ent/data_access/event_vault_interface.php b/...ocal/interfaces/event_vault_interface.php → ...ent/data_access/event_vault_interface.php
@@ -22,10 +22,12 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-namespace core_calendar\local\interfaces;
+namespace core_calendar\local\event\data_access;
 
 defined('MOODLE_INTERNAL') || die();
 
+use core_calendar\local\event\entities\event_interface;
+
 /**
  * Interface for an event vault class
  *

diff --git a/calendar/classes/local/event/entities/action_event.php b/calendar/classes/local/event/entities/action_event.php
@@ -26,9 +26,7 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-use core_calendar\local\interfaces\action_event_interface;
-use core_calendar\local\interfaces\action_interface;
-use core_calendar\local\interfaces\event_interface;
+use core_calendar\local\event\factories\action_factory_interface;
 
 /**
  * Class representing an actionable event.

diff --git a/...cal/interfaces/action_event_interface.php → ...event/entities/action_event_interface.php b/...cal/interfaces/action_event_interface.php → ...event/entities/action_event_interface.php
@@ -22,7 +22,7 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-namespace core_calendar\local\interfaces;
+namespace core_calendar\local\event\entities;
 
 defined('MOODLE_INTERNAL') || die();
 

diff --git a/...ses/local/interfaces/action_interface.php → ...local/event/entities/action_interface.php b/...ses/local/interfaces/action_interface.php → ...local/event/entities/action_interface.php
@@ -22,7 +22,7 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-namespace core_calendar\local\interfaces;
+namespace core_calendar\local\event\entities;
 
 defined('MOODLE_INTERNAL') || die();
 

diff --git a/calendar/classes/local/event/entities/event.php b/calendar/classes/local/event/entities/event.php
@@ -26,11 +26,9 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-use core_calendar\local\interfaces\event_collection_interface;
-use core_calendar\local\interfaces\event_interface;
-use core_calendar\local\interfaces\proxy_interface;
-use core_calendar\local\interfaces\description_interface;
-use core_calendar\local\interfaces\times_interface;
+use core_calendar\local\event\proxies\proxy_interface;
+use core_calendar\local\event\value_objects\description_interface;
+use core_calendar\local\event\value_objects\times_interface;
 
 /**
  * Class representing a calendar event.

diff --git a/...interfaces/event_collection_interface.php → ...t/entities/event_collection_interface.php b/...interfaces/event_collection_interface.php → ...t/entities/event_collection_interface.php
@@ -22,7 +22,7 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-namespace core_calendar\local\interfaces;
+namespace core_calendar\local\event\entities;
 
 defined('MOODLE_INTERNAL') || die();
 

diff --git a/...sses/local/interfaces/event_interface.php → .../local/event/entities/event_interface.php b/...sses/local/interfaces/event_interface.php → .../local/event/entities/event_interface.php
@@ -22,7 +22,7 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-namespace core_calendar\local\interfaces;
+namespace core_calendar\local\event\entities;
 
 defined('MOODLE_INTERNAL') || die();
 

diff --git a/calendar/classes/local/event/entities/repeat_event_collection.php b/calendar/classes/local/event/entities/repeat_event_collection.php
@@ -26,9 +26,7 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-use core_calendar\local\interfaces\event_collection_interface;
-use core_calendar\local\interfaces\event_factory_interface;
-use core_calendar\local\interfaces\event_interface;
+use core_calendar\local\event\factories\event_factory_interface;
 use core_calendar\local\event\exceptions\no_repeat_parent_exception;
 
 /**

diff --git a/calendar/classes/local/event/factories/action_event_factory.php b/calendar/classes/local/event/factories/action_event_factory.php
@@ -27,9 +27,8 @@
 defined('MOODLE_INTERNAL') || die();
 
 use core_calendar\local\event\entities\action_event;
-use core_calendar\local\interfaces\action_event_factory_interface;
-use core_calendar\local\interfaces\action_interface;
-use core_calendar\local\interfaces\event_interface;
+use core_calendar\local\event\entities\action_interface;
+use core_calendar\local\event\entities\event_interface;
 
 /**
  * Action event factory class.

diff --git a/...rfaces/action_event_factory_interface.php → ...tories/action_event_factory_interface.php b/...rfaces/action_event_factory_interface.php → ...tories/action_event_factory_interface.php
@@ -22,12 +22,12 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-namespace core_calendar\local\interfaces;
+namespace core_calendar\local\event\factories;
 
 defined('MOODLE_INTERNAL') || die();
 
-use core_calendar\local\interfaces\event_interface;
-use core_calendar\local\interfaces\action_interface;
+use core_calendar\local\event\entities\event_interface;
+use core_calendar\local\event\entities\action_interface;
 
 /**
  * Interface for an action event factory class.

diff --git a/...l/interfaces/action_factory_interface.php → ...nt/factories/action_factory_interface.php b/...l/interfaces/action_factory_interface.php → ...nt/factories/action_factory_interface.php
@@ -22,7 +22,7 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-namespace core_calendar\local\interfaces;
+namespace core_calendar\local\event\factories;
 
 defined('MOODLE_INTERNAL') || die();
 
@@ -34,7 +34,7 @@ interface action_factory_interface {
      * @param \moodle_url $url        The action's URL.
      * @param int         $itemcount  The number of items needing action.
      * @param bool        $actionable The action's actionability.
-     * @return \core_calendar\local\interfaces\action_interface The action.
+     * @return \core_calendar\local\event\entities\action_interface The action.
      */
     public function create_instance($name, \moodle_url $url, $itemcount, $actionable);
 }
diff --git a/calendar/classes/local/event/factories/event_abstract_factory.php b/calendar/classes/local/event/factories/event_abstract_factory.php
@@ -33,9 +33,7 @@
 use core_calendar\local\event\proxies\std_proxy;
 use core_calendar\local\event\value_objects\event_description;
 use core_calendar\local\event\value_objects\event_times;
-use core_calendar\local\interfaces\action_event_factory_interface;
-use core_calendar\local\interfaces\event_factory_interface;
-use core_calendar\local\interfaces\event_interface;
+use core_calendar\local\event\entities\event_interface;
 
 /**
  * Abstract factory for creating calendar events.

diff --git a/calendar/classes/local/event/factories/event_factory.php b/calendar/classes/local/event/factories/event_factory.php
@@ -27,8 +27,7 @@
 defined('MOODLE_INTERNAL') || die();
 
 use core_calendar\local\event\exceptions\invalid_callback_exception;
-use core_calendar\local\event\factories\event_abstract_factory;
-use core_calendar\local\interfaces\event_interface;
+use core_calendar\local\event\entities\event_interface;
 
 /**
  * Event factory class.

diff --git a/...al/interfaces/event_factory_interface.php → ...ent/factories/event_factory_interface.php b/...al/interfaces/event_factory_interface.php → ...ent/factories/event_factory_interface.php
@@ -22,7 +22,7 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-namespace core_calendar\local\interfaces;
+namespace core_calendar\local\event\factories;
 
 defined('MOODLE_INTERNAL') || die();
 
@@ -37,7 +37,7 @@ interface event_factory_interface {
      * Creates an instance of an event.
      *
      * @param \stdClass $dbrow The event row from the database.
-     * @return \core_calendar\local\interfaces\event_interface
+     * @return \core_calendar\local\event\entities\event_interface
      */
     public function create_instance(\stdClass $dbrow);
 }
diff --git a/calendar/classes/local/event/mappers/event_mapper.php b/calendar/classes/local/event/mappers/event_mapper.php
@@ -26,10 +26,10 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-use core_calendar\local\interfaces\event_factory_interface;
-use core_calendar\local\interfaces\event_interface;
-use core_calendar\local\interfaces\action_event_interface;
-use core_calendar\local\interfaces\event_mapper_interface;
+use core_calendar\event;
+use core_calendar\local\event\entities\action_event_interface;
+use core_calendar\local\event\entities\event_interface;
+use core_calendar\local\event\factories\event_factory_interface;
 
 /**
  * Event mapper class.

diff --git a/...cal/interfaces/event_mapper_interface.php → .../event/mappers/event_mapper_interface.php b/...cal/interfaces/event_mapper_interface.php → .../event/mappers/event_mapper_interface.php
@@ -22,10 +22,13 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-namespace core_calendar\local\interfaces;
+namespace core_calendar\local\event\mappers;
 
 defined('MOODLE_INTERNAL') || die();
 
+use core_calendar\event;
+use core_calendar\local\event\entities\event_interface;
+
 /**
  * Interface for an event mapper class
  *

diff --git a/calendar/classes/local/event/proxies/module_std_proxy.php b/calendar/classes/local/event/proxies/module_std_proxy.php
@@ -26,8 +26,6 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-use core_calendar\local\interfaces\proxy_interface;
-
 /**
  * Course module stdClass proxy.
  *

diff --git a/...sses/local/interfaces/proxy_interface.php → ...s/local/event/proxies/proxy_interface.php b/...sses/local/interfaces/proxy_interface.php → ...s/local/event/proxies/proxy_interface.php
@@ -22,7 +22,7 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-namespace core_calendar\local\interfaces;
+namespace core_calendar\local\event\proxies;
 
 defined('MOODLE_INTERNAL') || die();
 

diff --git a/calendar/classes/local/event/proxies/std_proxy.php b/calendar/classes/local/event/proxies/std_proxy.php
@@ -26,7 +26,6 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-use core_calendar\local\interfaces\proxy_interface;
 use core_calendar\local\event\exceptions\member_does_not_exist_exception;
 
 /**

diff --git a/calendar/classes/local/event/strategies/raw_event_retrieval_strategy.php b/calendar/classes/local/event/strategies/raw_event_retrieval_strategy.php
@@ -26,8 +26,6 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-use core_calendar\local\interfaces\raw_event_retrieval_strategy_interface;
-
 /**
  * Raw event retrieval strategy.
  *