WebSVN – Moodle – Diff – /backup/util/ui/backup_ui_setting.class.php

      * The label for the setting
      * @var string
      */
     protected $label;
     /**
+     * The optional accessible label for the setting.
+     * @var string
+     */
+    protected string $altlabel = '';
+    /**
      * An array of HTML attributes to apply to this setting
      * @var array
      */
     protected $attributes = array();
     /**
     public function get_label() {
         return $this->label;
+    }
+    /**
+     * Get the visually hidden label for the UI setting.
+     *
+     * @return string
+     */
+    public function get_visually_hidden_label(): ?string {
+        global $PAGE;
+        if ($this->altlabel === '') {
+            return null;
+        }
+        $renderer = $PAGE->get_renderer('core_backup');
+        return $renderer->visually_hidden_text($this->altlabel);
+    }
     /**
      * Gets the type of this element
      * @return int
      */
     public function get_type() {
         $this->label = $label;
+    }
+    /**
+     * Adds a visually hidden label to the UI setting.
+     *
+     * Some backup fields labels have unaccessible labels for screen readers. For example,
+     * all schema activity user data uses '-' as label. This method adds extra information
+     * for screen readers.
+     *
+     * @param string $label The accessible label to be added.
+     * @return void
+     */
+    public function set_visually_hidden_label(string $label): void {
+        $this->altlabel = clean_param($label, PARAM_CLEANHTML);
+    }
     /**
      * Disables the UI for this element
      */
     public function disable() {
      * @param backup_setting $setting
      * @param string $label The label to display with the setting ui
      * @param array $attributes Array of HTML attributes to apply to the element
      * @param array $options Array of options to apply to the setting ui object
      */
-    public function __construct(backup_setting $setting, $label = null, array $attributes = null, array $options = null) {
+    public function __construct(backup_setting $setting, $label = null, ?array $attributes = null, ?array $options = null) {
         parent::__construct($setting);
         // Improve the inputs name by appending the level to the name.
         switch ($setting->get_level()) {
             case backup_setting::ROOT_LEVEL :
                 $this->name = 'root_'.$setting->get_name();
                 break;
             case backup_setting::COURSE_LEVEL :
                 $this->name = 'course_'.$setting->get_name();
                 break;
             case backup_setting::SECTION_LEVEL :
+            case backup_setting::SUBSECTION_LEVEL:
                 $this->name = 'section_'.$setting->get_name();
                 break;
             case backup_setting::ACTIVITY_LEVEL :
+            case backup_setting::SUBACTIVITY_LEVEL:
                 $this->name = 'activity_'.$setting->get_name();
                 break;
+        }
         $this->label = $label;
         if (is_array($attributes)) {
      * @param string $label The label to display with the setting ui
      * @param array $attributes Array of HTML attributes to apply to the element
      * @param array $options Array of options to apply to the setting ui object
      * @return backup_setting_ui_text|backup_setting_ui_checkbox|backup_setting_ui_select|backup_setting_ui_radio
      */
-    final public static function make(backup_setting $setting, $type, $label, array $attributes = null, array $options = null) {
+    final public static function make(backup_setting $setting, $type, $label, ?array $attributes = null, ?array $options = null) {
         // Base the decision we make on the type that was sent.
         switch ($type) {
             case backup_setting::UI_HTML_CHECKBOX :
                 return new backup_setting_ui_checkbox($setting, $label, null, (array)$attributes, (array)$options);
             case backup_setting::UI_HTML_DROPDOWN :
+     *
      * @param base_task $task
      * @param renderer_base $output
      * @return array
      */
-    abstract public function get_element_properties(base_task $task = null, renderer_base $output = null);
+    abstract public function get_element_properties(?base_task $task = null, ?renderer_base $output = null);
     /**
      * Applies config options to a given properties array and then returns it
      * @param array $properties
      * Gets the label for this item
      * @param base_task $task Optional, if provided and the setting is an include
      *          $task is used to set the setting label
      * @return string
      */
-    public function get_label(base_task $task = null) {
+    public function get_label(?base_task $task = null) {
         // If a task has been provided and the label is not already set meaningfully
         // we will attempt to improve it.
         if (!is_null($task) && $this->label == $this->setting->get_name() && strpos($this->setting->get_name(), '_include') !== false) {
+            $level = $this->setting->get_level();
-            if ($this->setting->get_level() == backup_setting::SECTION_LEVEL) {
+            if ($level == backup_setting::SECTION_LEVEL || $level == backup_setting::SUBSECTION_LEVEL) {
                 $this->label = get_string('includesection', 'backup', $task->get_name());
-            } else if ($this->setting->get_level() == backup_setting::ACTIVITY_LEVEL) {
+            } else if ($level == backup_setting::ACTIVITY_LEVEL || $level == backup_setting::SUBACTIVITY_LEVEL) {
                 $this->label = $task->get_name();
+            }
+        }
         return $this->label;
+    }
      * Returns an array of properties suitable for generating a quickforms element
      * @param base_task $task
      * @param renderer_base $output
      * @return array (element, name, label, attributes)
      */
-    public function get_element_properties(base_task $task = null, renderer_base $output = null) {
+    public function get_element_properties(?base_task $task = null, ?renderer_base $output = null) {
         $icon = $this->get_icon();
         $context = context_course::instance($task->get_courseid());
         $label = format_string($this->get_label($task), true, array('context' => $context));
         if (!empty($icon)) {
             $label .= $output->render($icon);
      * Returns an array of properties suitable for generating a quickforms element
      * @param base_task $task
      * @param renderer_base $output
      * @return array (element, name, label, text, attributes);
      */
-    public function get_element_properties(base_task $task = null, renderer_base $output = null) {
+    public function get_element_properties(?base_task $task = null, ?renderer_base $output = null) {
         // Name, label, text, attributes.
         $icon = $this->get_icon();
         $context = context_course::instance($task->get_courseid());
         $label = format_string($this->get_label($task), true, array('context' => $context));
         if (!empty($icon)) {
             $label .= $output->render($icon);
+        }
+        $altlabel = $this->get_visually_hidden_label();
+        if (!empty($altlabel)) {
+            $label = $altlabel . $label;
+        }
         return $this->apply_options(array(
             'element' => 'checkbox',
             'name' => self::NAME_PREFIX.$this->name,
             'label' => $label,
             'text' => $this->text,
      * Returns an array of properties suitable for generating a quickforms element
      * @param base_task $task
      * @param renderer_base $output
      * @return array (element, name, label, text, value, attributes)
      */
-    public function get_element_properties(base_task $task = null, renderer_base $output = null) {
+    public function get_element_properties(?base_task $task = null, ?renderer_base $output = null) {
         $icon = $this->get_icon();
         $context = context_course::instance($task->get_courseid());
         $label = format_string($this->get_label($task), true, array('context' => $context));
         if (!empty($icon)) {
             $label .= $output->render($icon);
      * Returns an array of properties suitable for generating a quickforms element
      * @param base_task $task
      * @param renderer_base $output
      * @return array (element, name, label, options, attributes)
      */
-    public function get_element_properties(base_task $task = null, renderer_base $output = null) {
+    public function get_element_properties(?base_task $task = null, ?renderer_base $output = null) {
         $icon = $this->get_icon();
         $context = context_course::instance($task->get_courseid());
         $label = format_string($this->get_label($task), true, array('context' => $context));
         if (!empty($icon)) {
             $label .= $output->render($icon);
      * Returns an array of properties suitable for generating a quickforms element
      * @param base_task $task
      * @param renderer_base $output
      * @return array (element, name, label, options, attributes)
      */
-    public function get_element_properties(base_task $task = null, renderer_base $output = null) {
+    public function get_element_properties(?base_task $task = null, ?renderer_base $output = null) {
         if (!array_key_exists('optional', $this->attributes)) {
             $this->attributes['optional'] = false;
+        }
         $properties = parent::get_element_properties($task, $output);
         $properties['element'] = 'date_selector';
      * @param backup_setting $setting
      * @param string $label The label to display with the setting ui
      * @param array $attributes Array of HTML attributes to apply to the element
      * @param array $options Array of options to apply to the setting ui object
      */
-    public function __construct(backup_setting $setting, $label = null, array $attributes = null, array $options = null) {
+    public function __construct(backup_setting $setting, $label = null, ?array $attributes = null, ?array $options = null) {
         if (!is_array($attributes)) {
             $attributes = [];
+        }
         $attributes += ['customlabel' => get_string('overwrite', 'backup'),
             'type' => 'text'];
      * Returns an array of properties suitable for generating a quickforms element
      * @param base_task $task
      * @param renderer_base $output
      * @return array (element, name, label, options, attributes)
      */
-    public function get_element_properties(base_task $task = null, renderer_base $output = null) {
+    public function get_element_properties(?base_task $task = null, ?renderer_base $output = null) {
         return ['element' => 'defaultcustom'] + parent::get_element_properties($task, $output);
+    }
     /**

Proyectos de Subversion Moodle

(root)/backup/util/ui/backup_ui_setting.class.php – Rev 1 → 1441