Adding the choosecoursefileorimsrepo form element to

show the "Browse Repository" button
for IMS-CP resources type. (MDL-10036)

Merged from MOODLE_18_STABLE

diff --git a/lib/form/choosecoursefileorimsrepo.php b/lib/form/choosecoursefileorimsrepo.php
new file mode 100644 (file)
index 0000000..2825c56
--- /dev/null
+++ b/lib/form/choosecoursefileorimsrepo.php
@@ -0,0 +1,155 @@
+<?php //$Id$
+global $CFG;
+require_once "$CFG->libdir/form/group.php";
+
+/**
+ * Class for an element used to choose a file from the course files folder or
+ * from the local repository used by the IMS CP resource type.
+ *
+ */
+class MoodleQuickForm_choosecoursefileorimsrepo extends MoodleQuickForm_group
+{
+    /**
+    * Options for element :
+    *
+    * $url must be relative to home page  eg /mod/survey/stuff.php
+    * courseid => int course id if null then uses $COURSE global
+    * width => int Height to assign to popup window
+    * title => string Text to be displayed as popup page title
+    * options => string List of additional options for popup window
+    */
+    var $_options = array('courseid'=>null,
+                         'height'=>500, 'width'=>750, 'options'=>'none');
+
+   /**
+    * These complement separators, they are appended to the resultant HTML
+    * @access   private
+    * @var      array
+    */
+    var $_wrap = array('', '');
+
+   /**
+    * Class constructor
+    *
+    * @access   public
+    * @param    string  Element's name
+    * @param    mixed   Label(s) for an element
+    * @param    array   Options to control the element's display
+    * @param    mixed   Either a typical HTML attribute string or an associative array
+    */
+    function MoodleQuickForm_choosecoursefileorimsrepo($elementName = null, $elementLabel = null, $options = array(), $attributes = null)
+    {
+        $this->HTML_QuickForm_element($elementName, $elementLabel, $attributes);
+        $this->_appendName = true;
+        $this->_type = 'choosecoursefileorimsrepo';
+        // set the options, do not bother setting bogus ones
+        if (is_array($options)) {
+            foreach ($options as $name => $value) {
+                if (isset($this->_options[$name])) {
+                    if (is_array($value) && is_array($this->_options[$name])) {
+                        $this->_options[$name] = @array_merge($this->_options[$name], $value);
+                    } else {
+                        $this->_options[$name] = $value;
+                    }
+                }
+            }
+        }
+    }
+
+    // }}}
+    // {{{ _createElements()
+
+    function _createElements() {
+        global $CFG, $COURSE;
+        $this->_elements = array();
+
+        $this->_elements[0] =& MoodleQuickForm::createElement('text', 'value', '', array('size'=>'48'));
+        $this->_elements[1] =& MoodleQuickForm::createElement('button', 'popup', get_string('chooseafile', 'resource') .' ...');
+
+        $button =& $this->_elements[1];
+
+        if ($this->_options['courseid']!==null){
+            $courseid=$this->_options['courseid'];
+        } else {
+            $courseid=$COURSE->id;
+        }
+        // first find out the text field id - this is a bit hacky, is there a better way?
+        $choose = 'id_'.str_replace(array('[', ']'), array('_', ''), $this->getElementName(0));
+        $url="/files/index.php?id=$courseid&choose=".$choose;
+
+        if ($this->_options['options'] == 'none') {
+            $options = 'menubar=0,location=0,scrollbars,resizable,width='. $this->_options['width'] .',height='. $this->_options['height'];
+        }else{
+            $options = $this->_options['options'];
+        }
+        $fullscreen = 0;
+
+        $buttonattributes = array('title'=>get_string("chooseafile", "resource"),
+                  'onclick'=>"return openpopup('$url', '".$button->getName()."', '$options', $fullscreen);");
+
+        $button->updateAttributes($buttonattributes);
+
+        /// With repository active, show the button to browse it
+        if ($CFG->repositoryactivate) {
+            $this->_elements[2] =& MoodleQuickForm::createElement('button', 'imsrepo', get_string('browserepository', 'resource'));
+            $imsbutton =& $this->_elements[2];
+            $url = "/mod/resource/type/ims/finder.php?directory=&choose=".$choose;
+            $buttonattributes = array('title'=>get_string("browserepository", "resource"),
+                  'onclick'=>"return openpopup('$url', '".$button->getName()."', '$options', $fullscreen);");
+            $imsbutton->updateAttributes($buttonattributes);
+        }
+    }
+    /**
+     * Output a timestamp. Give it the name of the group.
+     *
+     * @param array $submitValues
+     * @param bool $assoc
+     * @return array
+     */
+    function exportValue(&$submitValues, $assoc = false)
+    {
+        $value = null;
+        $valuearray = $this->_elements[0]->exportValue($submitValues[$this->getName()], true);
+        $value[$this->getName()]=$valuearray['value'];
+        return $value;
+    }
+    // }}}
+
+    /**
+     * Called by HTML_QuickForm whenever form event is made on this element
+     *
+     * @param     string    $event  Name of event
+     * @param     mixed     $arg    event arguments
+     * @param     object    $caller calling object
+     * @since     1.0
+     * @access    public
+     * @return    void
+     */
+    function onQuickFormEvent($event, $arg, &$caller)
+    {
+        switch ($event) {
+            case 'updateValue':
+                // constant values override both default and submitted ones
+                // default values are overriden by submitted
+                $value = $this->_findValue($caller->_constantValues);
+                if (null === $value) {
+                    $value = $this->_findValue($caller->_submitValues);
+                    if (null === $value) {
+                        $value = $this->_findValue($caller->_defaultValues);
+                    }
+                }
+                if (!is_array($value)) {
+                   $value = array('value' => $value);
+                }
+                if (null !== $value) {
+                    $this->setValue($value);
+                }
+                return true;
+                break;
+        }
+        return parent::onQuickFormEvent($event, $arg, $caller);
+
+    } // end func onQuickFormEvent
+
+}
+?>