Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * Text profile field.
  19   *
  20   * @package    profilefield_text
  21   * @copyright  2007 onwards Shane Elliot {@link http://pukunui.com}
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  /**
  26   * Class profile_field_text
  27   *
  28   * @copyright  2007 onwards Shane Elliot {@link http://pukunui.com}
  29   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  30   */
  31  class profile_field_text extends profile_field_base {
  32  
  33      /**
  34       * Overwrite the base class to display the data for this field
  35       */
  36      public function display_data() {
  37          // Default formatting.
  38          $data = format_string($this->data);
  39  
  40          // Are we creating a link?
  41          if (!empty($this->field->param4) && !empty($data)) {
  42  
  43              // Define the target.
  44              if (! empty($this->field->param5)) {
  45                  $target = 'target="'.$this->field->param5.'"';
  46              } else {
  47                  $target = '';
  48              }
  49  
  50              // Create the link.
  51              $data = '<a href="'.str_replace('$$', urlencode($data),
  52                       $this->field->param4).'" '.$target.'>'.htmlspecialchars($data, ENT_COMPAT).'</a>';
  53          }
  54  
  55          return $data;
  56      }
  57  
  58      /**
  59       * Add fields for editing a text profile field.
  60       * @param moodleform $mform
  61       */
  62      public function edit_field_add($mform) {
  63          $size = $this->field->param1;
  64          $maxlength = $this->field->param2;
  65          $fieldtype = ($this->field->param3 == 1 ? 'password' : 'text');
  66  
  67          // Create the form field.
  68          $mform->addElement($fieldtype, $this->inputname, format_string($this->field->name),
  69                      'maxlength="'.$maxlength.'" size="'.$size.'" ');
  70          $mform->setType($this->inputname, PARAM_TEXT);
  71      }
  72  
  73      /**
  74       * Return the field type and null properties.
  75       * This will be used for validating the data submitted by a user.
  76       *
  77       * @return array the param type and null property
  78       * @since Moodle 3.2
  79       */
  80      public function get_field_properties() {
  81          return array(PARAM_TEXT, NULL_NOT_ALLOWED);
  82      }
  83  }
  84  
  85