MDL-64820 forum: fix cibot complaints
authorRyan Wyllie <ryan@moodle.com>
Fri, 22 Mar 2019 02:38:41 +0000 (10:38 +0800)
committerRyan Wyllie <ryan@moodle.com>
Fri, 22 Mar 2019 02:38:41 +0000 (10:38 +0800)
mod/forum/classes/local/builders/exported_discussion_summaries.php
mod/forum/classes/local/factories/renderer.php
mod/forum/classes/local/managers/capability.php
mod/forum/classes/local/renderers/discussion_list.php
mod/forum/tests/local_container_test.php

index 2bfb769..3064981 100644 (file)
@@ -28,7 +28,6 @@ defined('MOODLE_INTERNAL') || die();
 
 use mod_forum\local\entities\discussion as discussion_entity;
 use mod_forum\local\entities\forum as forum_entity;
-use mod_forum\local\entities\forum;
 use mod_forum\local\entities\post as post_entity;
 use mod_forum\local\factories\legacy_data_mapper as legacy_data_mapper_factory;
 use mod_forum\local\factories\exporter as exporter_factory;
@@ -38,6 +37,8 @@ use renderer_base;
 use stdClass;
 
 /**
+ * Exported discussion summaries builder class.
+ *
  * This class is an implementation of the builder pattern (loosely). It is responsible
  * for taking a set of related forums, discussions, and posts and generate the exported
  * version of the discussion summaries.
@@ -48,6 +49,10 @@ use stdClass;
  *
  * See this doc for more information on the builder pattern:
  * https://designpatternsphp.readthedocs.io/en/latest/Creational/Builder/README.html
+ *
+ * @package    mod_forum
+ * @copyright  2019 Mihail Geshoski <mihail@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class exported_discussion_summaries {
     /** @var renderer_base $renderer Core renderer */
@@ -100,7 +105,7 @@ class exported_discussion_summaries {
      */
     public function build(
         stdClass $user,
-        forum $forum,
+        forum_entity $forum,
         array $discussions
     ) : array {
 
index 20a1712..e21f9a0 100644 (file)
@@ -416,7 +416,7 @@ class renderer {
                 $exportedpostsbuilder = $this->builderfactory->get_exported_posts_builder();
                 $discussionentries = [];
                 $postentries = [];
-                foreach($discussions as $discussion) {
+                foreach ($discussions as $discussion) {
                     $discussionentries[] = $discussion->get_discussion();
                     $discussionentriesids[] = $discussion->get_discussion()->get_id();
                     $postentries[] = $discussion->get_first_post();
@@ -433,7 +433,7 @@ class renderer {
                 $discussionrepliescount = $postvault->get_reply_count_for_discussion_ids($discussionentriesids);
 
                 array_walk($exportedposts['posts'], function($post) use ($discussionrepliescount) {
-                    $post->discussionrepliescount =  $discussionrepliescount[$post->discussionid] ?? 0;
+                    $post->discussionrepliescount = $discussionrepliescount[$post->discussionid] ?? 0;
                     // TODO: Find a better solution due to language differences when defining the singular and plural form.
                     $post->isreplyplural = $post->discussionrepliescount != 1 ? true : false;
                 });
index 9719014..47d9b81 100644 (file)
@@ -91,7 +91,7 @@ class capability {
      */
     public function can_subscribe_to_forum(stdClass $user) : bool {
         if ($this->forum->get_type() == 'single') {
-           return false;
+            return false;
         }
 
         return !is_guest($this->get_context(), $user) &&
index fae87a9..319c452 100644 (file)
@@ -93,6 +93,7 @@ class discussion_list {
      * @param   capability_manager  $capabilitymanager The managed used to check capabilities on the forum
      * @param   url_factory         $urlfactory The factory used to create URLs in the forum
      * @param   notification[]      $notifications A list of any notifications to be displayed within the page
+     * @param   callable|null       $postprocessfortemplate Callback function to process discussion lists for templates
      */
     public function __construct(
         forum_entity $forum,
index 06e31d6..07e90a6 100644 (file)
@@ -47,7 +47,10 @@ class mod_forum_local_container_testcase extends advanced_testcase {
      * @covers ::get_legacy_data_mapper_factory
      */
     public function test_get_legacy_data_mapper_factory() {
-        $this->assertInstanceOf(\mod_forum\local\factories\legacy_data_mapper::class, \mod_forum\local\container::get_legacy_data_mapper_factory());
+        $this->assertInstanceOf(
+            \mod_forum\local\factories\legacy_data_mapper::class,
+            \mod_forum\local\container::get_legacy_data_mapper_factory()
+        );
     }
 
     /**