MDL-72725 courseformat: indentation pot-out

2021-10-18 10:18:37 +02:00
parent 385938b472
commit da0c19982d
8 changed files with 29 additions and 48 deletions
@@ -383,6 +383,23 @@ abstract class base {
        return false;
    }

+    /**
+     * Returns true if this course format uses activity indentation.
+     *
+     * Indentation is not supported by core formats anymore and may be deprecated in the future.
+     * This method will keep a default return "true" for legacy reasons but new formats should override
+     * it with a return false to prevent future deprecations.
+     *
+     * A message in a bottle: if indentation is finally deprecated, both behat steps i_indent_right_activity
+     * and i_indent_left_activity should be removed as well. Right now no core behat uses them but indentation
+     * is not officially deprecated so they are still available for the contrib formats.
+     *
+     * @return bool if the course format uses indentation.
+     */
+    public function uses_indentation(): bool {
+        return true;
+    }
+
    /**
     * Returns a list of sections used in the course
     *