class Weight
Same name and namespace in other branches
- 8.9.x core/lib/Drupal/Core/Render/Element/Weight.php \Drupal\Core\Render\Element\Weight
- 10 core/lib/Drupal/Core/Render/Element/Weight.php \Drupal\Core\Render\Element\Weight
- 11.x 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 extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Render\Element\RenderElement extends \Drupal\Core\Render\Element\ElementInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Render\Element\FormElement extends \Drupal\Core\Render\Element\FormElementInterface implements \Drupal\Core\Render\Element\RenderElement
- class \Drupal\Core\Render\Element\Weight implements \Drupal\Core\Render\Element\FormElement
- class \Drupal\Core\Render\Element\FormElement extends \Drupal\Core\Render\Element\FormElementInterface implements \Drupal\Core\Render\Element\RenderElement
- class \Drupal\Core\Render\Element\RenderElement extends \Drupal\Core\Render\Element\ElementInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of Weight
11 string references to 'Weight'
- ConfigDependencyManager::getDependentEntities in core/
lib/ Drupal/ Core/ Config/ Entity/ ConfigDependencyManager.php - Gets dependencies.
- ConfigDependencyManager::sortAll in core/
lib/ Drupal/ Core/ Config/ Entity/ ConfigDependencyManager.php - Sorts the dependencies in order of most dependent last.
- DraggableListBuilder::buildForm in core/
lib/ Drupal/ Core/ Config/ Entity/ DraggableListBuilder.php - Form constructor.
- DraggableListBuilder::buildHeader in core/
lib/ Drupal/ Core/ Config/ Entity/ DraggableListBuilder.php - Builds the header row for the entity listing.
- DraggableListBuilder::buildRow in core/
lib/ Drupal/ Core/ Config/ Entity/ DraggableListBuilder.php - Builds a row for an entity in the entity listing.
2 #type uses of Weight
- DraggableListBuilder::buildRow in core/
lib/ Drupal/ Core/ Config/ Entity/ DraggableListBuilder.php - Builds a row for an entity in the entity listing.
- WidgetBase::formMultipleElements in core/
lib/ Drupal/ Core/ Field/ WidgetBase.php - Special handling to create form elements for multiple values.
File
-
core/
lib/ Drupal/ Core/ Render/ Element/ Weight.php, line 29
Namespace
Drupal\Core\Render\ElementView 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
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | ||
DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | ||
DependencySerializationTrait::__sleep | public | function | 2 | ||
DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 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 | 16 |
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. | 85 | |
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. | 3 | |
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. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.