Plugin: Add courseToolDefaultVisibility property to Plugin class to enable course plugins that are not visible by default (set it from the plugin with $this->setCourseToolDefaultVisibility(false); before install_course_fields_in_all_courses()). Enabled on positioning plugin - refs #5717

Author: ywarnier

main/inc/lib/plugin.class.php

@@ -27,6 +27,8 @@ class Plugin
     // Adds icon in the course home
     public $addCourseTool = true;
     public $hasPersonalEvents = false;
+    // Whether the tool created should be visible immediately or disabled first (defaults to visible)
+    public bool $courseToolDefaultVisibility = true;
 
     /**
      * When creating a new course, these settings are added to the course, in
@@ -986,16 +988,6 @@ public function getToolIconVisibilityPerUserStatus()
         return '';
     }
 
-    /**
-     * Default tool icon visibility.
-     *
-     * @return bool
-     */
-    public function isIconVisibleByDefault()
-    {
-        return true;
-    }
-
     /**
      * Get the admin URL for the plugin if Plugin::isAdminPlugin is true.
      *
@@ -1093,7 +1085,7 @@ protected function createLinkToCourseTool(
         }
 
         $visibilityPerStatus = $this->getToolIconVisibilityPerUserStatus();
-        $visibility = $this->isIconVisibleByDefault();
+        $visibility = $this->getCourseToolDefaultVisibility();
 
         $em = Database::getManager();
 
@@ -1136,4 +1128,21 @@ protected function createLinkToCourseTool(
 
         return $tool;
     }
+    /**
+     * Get whether the course tool should be visible by default or not
+     */
+    protected function getCourseToolDefaultVisibility(): bool
+    {
+        return $this->courseToolDefaultVisibility;
+    }
+
+    /**
+     * Set whether the tool created in the course must be visible or not
+     * @param bool $visibility
+     * @return void
+     */
+    protected function setCourseToolDefaultVisibility(bool $visibility)
+    {
+        $this->courseToolDefaultVisibility = $visibility;
+    }
 }

plugin/customcertificate/src/CustomCertificatePlugin.php

@@ -61,6 +61,7 @@ public static function create()
     public function install()
     {
         //Installing course settings
+        $this->setCourseToolDefaultVisibility(false);
         $this->install_course_fields_in_all_courses();
 
         $tablesToBeCompared = [self::TABLE_CUSTOMCERTIFICATE];
@@ -192,16 +193,6 @@ public function update()
         }
     }
 
-    /**
-     * By default new icon is invisible.
-     *
-     * @return bool
-     */
-    public function isIconVisibleByDefault()
-    {
-        return false;
-    }
-
     /**
      * Get certificate data.
      *

plugin/positioning/src/Positioning.php

@@ -47,6 +47,7 @@ public function install()
         Database::query($sql);
 
         // Installing course settings
+        $this->setCourseToolDefaultVisibility(false);
         $this->install_course_fields_in_all_courses(true, 'positioning.png');
     }
 

plugin/test2pdf/src/test2pdf_plugin.class.php

@@ -37,6 +37,7 @@ public static function create()
     public function install()
     {
         //Installing course settings
+        $this->setCourseToolDefaultVisibility(false);
         $this->install_course_fields_in_all_courses();
 
         $list = [
@@ -64,16 +65,6 @@ public function install()
         }
     }
 
-    /**
-     * By default new icon is invisible.
-     *
-     * @return bool
-     */
-    public function isIconVisibleByDefault()
-    {
-        return false;
-    }
-
     /**
      * This method drops the plugin tables.
      */