lib/form/password.php

   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 /**
  19  * Password type form element
  20  *
  21  * Contains HTML class for a password type element
  22  *
  23  * @package   core_form
  24  * @copyright 2006 Jamie Pratt <me@jamiep.org>
  25  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  26  */
  27
  28 require_once('HTML/QuickForm/password.php');
  29 require_once('templatable_form_element.php');
  30
  31 /**
  32  * Password type form element
  33  *
  34  * HTML class for a password type element
  35  *
  36  * @package   core_form
  37  * @category  form
  38  * @copyright 2006 Jamie Pratt <me@jamiep.org>
  39  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  40  */
  41 class MoodleQuickForm_password extends HTML_QuickForm_password implements templatable {
  42     use templatable_form_element;
  43
  44     /** @var string, html for help button, if empty then no help */
  45     var $_helpbutton='';
  46
  47     /**
  48      * constructor
  49      *
  50      * @param string $elementName (optional) name of the password element
  51      * @param string $elementLabel (optional) label for password element
  52      * @param mixed $attributes (optional) Either a typical HTML attribute string
  53      *              or an associative array
  54      */
  55     public function __construct($elementName=null, $elementLabel=null, $attributes=null) {
  56         global $CFG;
  57         // no standard mform in moodle should allow autocomplete of passwords
  58         if (empty($attributes)) {
  59             $attributes = array('autocomplete'=>'off');
  60         } else if (is_array($attributes)) {
  61             $attributes['autocomplete'] = 'off';
  62         } else {
  63             if (strpos($attributes, 'autocomplete') === false) {
  64                 $attributes .= ' autocomplete="off" ';
  65             }
  66         }
  67
  68         parent::__construct($elementName, $elementLabel, $attributes);
  69     }
  70
  71     /**
  72      * Old syntax of class constructor. Deprecated in PHP7.
  73      *
  74      * @deprecated since Moodle 3.1
  75      */
  76     public function MoodleQuickForm_password($elementName=null, $elementLabel=null, $attributes=null) {
  77         debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
  78         self::__construct($elementName, $elementLabel, $attributes);
  79     }
  80
  81     /**
  82      * get html for help button
  83      *
  84      * @return string html for help button
  85      */
  86     function getHelpButton(){
  87         return $this->_helpbutton;
  88     }
  89 }