. /** * url type form element * * Contains HTML class for a url type element * * @package core_form * @copyright 2009 Dongsheng Cai * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once("HTML/QuickForm/text.php"); require_once('templatable_form_element.php'); /** * url type form element * * HTML class for a url type element * @package core_form * @category form * @copyright 2009 Dongsheng Cai * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class MoodleQuickForm_url extends HTML_QuickForm_text implements templatable { use templatable_form_element { export_for_template as export_for_template_base; } /** @var string html for help button, if empty then no help */ var $_helpbutton=''; /** @var bool if true label will be hidden */ var $_hiddenLabel=false; /** @var string the unique id of the filepicker, if enabled.*/ protected $filepickeruniqueid; /** * Constructor * * @param string $elementName Element name * @param mixed $elementLabel Label(s) for an element * @param mixed $attributes Either a typical HTML attribute string or an associative array. * @param array $options data which need to be posted. */ public function __construct($elementName=null, $elementLabel=null, $attributes=null, $options=null) { global $CFG; require_once("$CFG->dirroot/repository/lib.php"); $options = (array)$options; foreach ($options as $name=>$value) { $this->_options[$name] = $value; } if (!isset($this->_options['usefilepicker'])) { $this->_options['usefilepicker'] = true; } parent::__construct($elementName, $elementLabel, $attributes); $this->_type = 'url'; } /** * Old syntax of class constructor. Deprecated in PHP7. * * @deprecated since Moodle 3.1 */ public function MoodleQuickForm_url($elementName=null, $elementLabel=null, $attributes=null, $options=null) { debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER); self::__construct($elementName, $elementLabel, $attributes, $options); } /** * Sets label to be hidden * * @param bool $hiddenLabel sets if label should be hidden */ function setHiddenLabel($hiddenLabel){ $this->_hiddenLabel = $hiddenLabel; } /** * Returns HTML for this form element. * * @return string */ function toHtml(){ $id = $this->_attributes['id']; $elname = $this->_attributes['name']; // Add the class at the last minute. if ($this->get_force_ltr()) { if (!isset($this->_attributes['class'])) { $this->_attributes['class'] = 'text-ltr'; } else { $this->_attributes['class'] .= ' text-ltr'; } } if ($this->_hiddenLabel) { $this->_generateId(); $str = ''.parent::toHtml(); } else { $str = parent::toHtml(); } if (empty($this->_options['usefilepicker'])) { return $str; } // Print out file picker. $str .= $this->getFilePickerHTML(); $str = '
' . $str . '
'; return $str; } public function getFilePickerHTML() { global $PAGE, $OUTPUT; $str = ''; $clientid = $this->get_filepicker_unique_id(); $args = new stdClass(); $args->accepted_types = '*'; $args->return_types = FILE_EXTERNAL; $args->context = $PAGE->context; $args->client_id = $clientid; $args->env = 'url'; $fp = new file_picker($args); $options = $fp->options; if (count($options->repositories) > 0) { $straddlink = get_string('choosealink', 'repository'); $str .= << $straddlink EOD; } // print out file picker $str .= $OUTPUT->render($fp); $module = array('name'=>'form_url', 'fullpath'=>'/lib/form/url.js', 'requires'=>array('core_filepicker')); $PAGE->requires->js_init_call('M.form_url.init', array($options), true, $module); return $str; } /** * get html for help button * * @return string html for help button */ function getHelpButton(){ return $this->_helpbutton; } /** * Slightly different container template when frozen. Don't want to use a label tag * with a for attribute in that case for the element label but instead use a div. * Templates are defined in renderer constructor. * * @return string */ function getElementTemplateType(){ if ($this->_flagFrozen){ return 'static'; } else { return 'default'; } } public function export_for_template(renderer_base $output) { $context = $this->export_for_template_base($output); $context['filepickerhtml'] = !empty($this->_options['usefilepicker']) ? $this->getFilePickerHTML() : ''; // This will conditionally wrap the element in a div which can be accessed in the DOM using the unique id, // and allows the filepicker callback to find its respective url field, if multiple URLs are used. if ($this->_options['usefilepicker']) { $context['filepickerclientid'] = $this->get_filepicker_unique_id(); } return $context; } /** * Get force LTR option. * * @return bool */ public function get_force_ltr() { return true; } /** * Returns the unique id of the file picker associated with this url element, setting it in the process if not set. * * @return string the unique id of the file picker. */ protected function get_filepicker_unique_id() : string { if (empty($this->filepickeruniqueid)) { $this->filepickeruniqueid = uniqid(); } return $this->filepickeruniqueid; } }