You are here

class Password in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/lib/Drupal/Core/Render/Element/Password.php \Drupal\Core\Render\Element\Password

Provides a form element for entering a password, with hidden text.

Usage example:


$form['pass'] = array(
  '#type' => 'password',
  '#title => t('Password'),
  '#size' => 25,
);

Plugin annotation

@FormElement("password");

Hierarchy

Expanded class hierarchy of Password

See also

\Drupal\Core\Render\Element\PasswordConfirm

\Drupal\Core\Render\Element\Textfield

1 file declares its use of Password
PasswordTest.php in core/tests/Drupal/Tests/Core/Render/Element/PasswordTest.php
Contains \Drupal\Tests\Core\Render\Element\PasswordTest.
13 string references to 'Password'
AccountForm::form in core/modules/user/src/AccountForm.php
Gets the actual form array to be built.
FileTransfer::getSettingsForm in core/lib/Drupal/Core/FileTransfer/FileTransfer.php
Returns a form to collect connection settings credentials.
FormTestDisabledElementsForm::buildForm in core/modules/system/tests/modules/form_test/src/Form/FormTestDisabledElementsForm.php
Form constructor.
FormTestPatternForm::buildForm in core/modules/system/tests/modules/form_test/src/Form/FormTestPatternForm.php
Form constructor.
PasswordConfirm::processPasswordConfirm in core/lib/Drupal/Core/Render/Element/PasswordConfirm.php
Expand a password_confirm field into two text boxes.

... See full list

10 #type uses of Password
AccountForm::form in core/modules/user/src/AccountForm.php
Gets the actual form array to be built.
FileTransfer::getSettingsForm in core/lib/Drupal/Core/FileTransfer/FileTransfer.php
Returns a form to collect connection settings credentials.
FormTest::testRequiredFields in core/modules/system/src/Tests/Form/FormTest.php
Check several empty values for required forms elements.
FormTestDisabledElementsForm::buildForm in core/modules/system/tests/modules/form_test/src/Form/FormTestDisabledElementsForm.php
Form constructor.
FormTestPatternForm::buildForm in core/modules/system/tests/modules/form_test/src/Form/FormTestPatternForm.php
Form constructor.

... See full list

File

core/lib/Drupal/Core/Render/Element/Password.php, line 30
Contains \Drupal\Core\Render\Element\Password.

Namespace

Drupal\Core\Render\Element
View source
class Password extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return array(
      '#input' => TRUE,
      '#size' => 60,
      '#maxlength' => 128,
      '#process' => array(
        array(
          $class,
          'processAjaxForm',
        ),
        array(
          $class,
          'processPattern',
        ),
      ),
      '#pre_render' => array(
        array(
          $class,
          'preRenderPassword',
        ),
      ),
      '#theme' => 'input__password',
      '#theme_wrappers' => array(
        'form_element',
      ),
    );
  }

  /**
   * Prepares a #type 'password' render element for input.html.twig.
   *
   * @param array $element
   *   An associative array containing the properties of the element.
   *   Properties used: #title, #value, #description, #size, #maxlength,
   *   #placeholder, #required, #attributes.
   *
   * @return array
   *   The $element with prepared variables ready for input.html.twig.
   */
  public static function preRenderPassword($element) {
    $element['#attributes']['type'] = 'password';
    Element::setAttributes($element, array(
      'id',
      'name',
      'size',
      'maxlength',
      'placeholder',
    ));
    static::setAttributes($element, array(
      'form-text',
    ));
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
    if ($input !== FALSE && $input !== NULL) {

      // This should be a string, but allow other scalars since they might be
      // valid input in programmatic form submissions.
      return is_scalar($input) ? (string) $input : '';
    }
    return NULL;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormElement::processAutocomplete public static function Adds autocomplete functionality to elements.
FormElement::processPattern public static function #process callback for #pattern form element property.
FormElement::validatePattern public static function #element_validate callback for #pattern form element property.
Password::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
Password::preRenderPassword public static function Prepares a #type 'password' render element for input.html.twig.
Password::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback
PluginBase::$configuration protected property Configuration information passed into the plugin. 2
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::__construct public function Constructs a Drupal\Component\Plugin\PluginBase object. 69
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property.
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes
StringTranslationTrait::$stringTranslation protected property The string translation service.
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.