class Weight in Drupal 9

Same name and namespace in other branches

8 core/lib/Drupal/Core/Render/Element/Weight.php \Drupal\Core\Render\Element\Weight

Provides a form element for input of a weight.

Weights are integers used to indicate ordering, with larger numbers later in the order.

Properties:

#delta: The range of possible weight values used. A delta of 10 would indicate possible weight values between -10 and 10.

Usage example:

$form['weight'] = array(
  '#type' => 'weight',
  '#title' => $this
    ->t('Weight'),
  '#default_value' => $edit['weight'],
  '#delta' => 10,
);

Plugin annotation

@FormElement("weight");

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
    class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
    class \Drupal\Core\Render\Element\Weight

Expanded class hierarchy of Weight

1 file declares its use of Weight

WeightTest.php in core/tests/Drupal/KernelTests/Core/Render/Element/WeightTest.php

54 string references to 'Weight'

block.schema.yml in core/modules/block/config/schema/block.schema.yml: core/modules/block/config/schema/block.schema.yml
BlockListBuilder::buildBlocksForm in core/modules/block/src/BlockListBuilder.php: Builds the main "Blocks" portion of the form.
Book::fields in core/modules/book/src/Plugin/migrate/source/Book.php: Returns available fields on the source.
BookAdminEditForm::bookAdminTable in core/modules/book/src/Form/BookAdminEditForm.php: Builds the table portion of the form for the book administration page.
BookManager::addFormElements in core/modules/book/src/BookManager.php: Builds the common elements of the book form for the node and outline forms.

... See full list

24 #type uses of Weight

BlockListBuilder::buildBlocksForm in core/modules/block/src/BlockListBuilder.php: Builds the main "Blocks" portion of the form.
BookAdminEditForm::bookAdminTableTree in core/modules/book/src/Form/BookAdminEditForm.php: Helps build the main table in the book administration page form.
BookManager::addFormElements in core/modules/book/src/BookManager.php: Builds the common elements of the book form for the node and outline forms.
ConfigTestForm::form in core/modules/config/tests/config_test/src/ConfigTestForm.php: Gets the actual form array to be built.
ContactFormEditForm::form in core/modules/contact/src/ContactFormEditForm.php: Gets the actual form array to be built.

... See full list

File

core/lib/Drupal/Core/Render/Element/Weight.php, line 29

Namespace

Drupal\Core\Render\Element

View source

class Weight extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = static::class;
    return [
      '#input' => TRUE,
      '#delta' => 10,
      '#default_value' => 0,
      '#process' => [
        [
          $class,
          'processWeight',
        ],
        [
          $class,
          'processAjaxForm',
        ],
      ],
    ];
  }

  /**
   * Expands a weight element into a select/number element.
   */
  public static function processWeight(&$element, FormStateInterface $form_state, &$complete_form) {

    // If the number of options is small enough, use a select field. Otherwise,
    // use a number field.
    $type = $element['#delta'] <= \Drupal::config('system.site')
      ->get('weight_select_max') ? 'select' : 'number';
    $element = array_merge($element, \Drupal::service('element_info')
      ->getInfo($type));
    $element['#is_weight'] = TRUE;
    if ($type === 'select') {
      $weights = [];
      for ($n = -1 * $element['#delta']; $n <= $element['#delta']; $n++) {
        $weights[$n] = $n;
      }
      $default_value = (int) $element['#default_value'];
      if (!isset($weights[$default_value])) {
        $weights[$default_value] = $default_value;
        ksort($weights);
      }
      $element['#options'] = $weights;
    }
    else {

      // Use a field big enough to fit most weights.
      $element['#size'] = 10;
    }
    return $element;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
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.
FormElement::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback	15
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
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	2
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	98
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.	1
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.	4
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.
Weight::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
Weight::processWeight	public static	function	Expands a weight element into a select/number element.

You are here