class PanelizerWidget in Panelizer 8.5
Same name and namespace in other branches
- 8.3 src/Plugin/Field/FieldWidget/PanelizerWidget.php \Drupal\panelizer\Plugin\Field\FieldWidget\PanelizerWidget
- 8.4 src/Plugin/Field/FieldWidget/PanelizerWidget.php \Drupal\panelizer\Plugin\Field\FieldWidget\PanelizerWidget
Plugin implementation of the 'panelizer' widget.
Plugin annotation
@FieldWidget(
id = "panelizer",
label = @Translation("Panelizer"),
multiple_values = TRUE,
field_types = {
"panelizer"
}
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
- class \Drupal\panelizer\Plugin\Field\FieldWidget\PanelizerWidget
- class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of PanelizerWidget
File
- src/
Plugin/ Field/ FieldWidget/ PanelizerWidget.php, line 22
Namespace
Drupal\panelizer\Plugin\Field\FieldWidgetView source
class PanelizerWidget extends WidgetBase {
/**
* Returns the Panels display plugin manager.
*
* @return \Drupal\panels\PanelsDisplayManagerInterface
*/
public function getPanelsManager() {
// @todo: is it possible to inject this?
return \Drupal::service('panels.display_manager');
}
/**
* Returns the Panelizer entity plugin manager.
*
* @return \Drupal\panelizer\Plugin\PanelizerEntityManager
*/
public function getPanelizerManager() {
// @todo: is it possible to inject this?
return \Drupal::service('plugin.manager.panelizer_entity');
}
/**
* Returns the Panelizer service.
*
* @return \Drupal\panelizer\PanelizerInterface
*/
public function getPanelizer() {
// @todo: is it possible to inject this?
return \Drupal::service('panelizer');
}
/**
* @return \Drupal\Core\Entity\EntityDisplayRepositoryInterface
*/
public function getEntityDisplayRepository() {
// @todo: is it possible to inject this?
return \Drupal::service('entity_display.repository');
}
/**
* {@inheritdoc}
*/
public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
$entity = $items
->getEntity();
$entity_type_id = $entity
->getEntityTypeId();
$entity_view_modes = $this
->getEntityDisplayRepository()
->getViewModeOptionsByBundle($entity_type_id, $entity
->bundle());
// Get the current values from the entity.
$values = [];
/** @var \Drupal\Core\Field\FieldItemInterface $item */
foreach ($items as $item) {
$values[$item->view_mode] = [
'default' => $item->default,
'panels_display' => $item->panels_display,
];
}
// If any view modes are missing, then set the default.
$displays = [];
foreach ($entity_view_modes as $view_mode => $view_mode_info) {
$display = EntityViewDisplay::collectRenderDisplay($entity, $view_mode);
$displays[$view_mode] = $display
->getThirdPartySetting('panelizer', 'displays', []);
// If we don't have a value, or the default is __bundle_default__ and our
// panels_display is empty, set the default to __bundle_default__.
if (!isset($values[$view_mode]) || $values[$view_mode]['default'] == '__bundle_default__' && empty($values[$view_mode]['panels_display'])) {
if ($display
->getThirdPartySetting('panelizer', 'enable', FALSE)) {
$values[$view_mode] = [
'default' => '__bundle_default__',
'panels_display' => [],
];
}
}
}
// Add elements to the form for each view mode.
$delta = 0;
foreach ($values as $view_mode => $value) {
$element[$delta]['view_mode'] = [
'#type' => 'value',
'#value' => $view_mode,
];
$settings = $this
->getPanelizer()
->getPanelizerSettings($entity_type_id, $entity
->bundle(), $view_mode);
if (!empty($settings['allow'])) {
// We default to this option when the user hasn't previous interacted
// with the field.
$options = [
'__bundle_default__' => $this
->t('Current default display'),
];
foreach ($displays[$view_mode] as $machine_name => $panels_display) {
$options[$machine_name] = $panels_display['label'];
}
$element[$delta]['default'] = [
'#title' => $entity_view_modes[$view_mode],
'#type' => 'select',
'#options' => $options,
'#default_value' => $value['default'],
];
// If we have a value in panels_display, prevent the user from
// interacting with the widget for the view modes that are overridden.
if (!empty($value['panels_display'])) {
$element[$delta]['default']['#disabled'] = TRUE;
$element[$delta]['default']['#options'][$value['default']] = $this
->t('Custom Override');
}
}
else {
$element[$delta]['default'] = [
'#type' => 'value',
'#value' => $value['default'],
];
}
$element[$delta]['panels_display'] = [
'#type' => 'value',
'#value' => $value['panels_display'],
];
$delta++;
}
return $element;
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AllowedTagsXssTrait:: |
public | function | Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss(). | |
AllowedTagsXssTrait:: |
public | function | Returns a human-readable list of allowed tags for display in help texts. | |
AllowedTagsXssTrait:: |
public | function | Filters an HTML string to prevent XSS vulnerabilities. | |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PanelizerWidget:: |
public | function |
Returns the form for a single field widget. Overrides WidgetInterface:: |
|
PanelizerWidget:: |
public | function | ||
PanelizerWidget:: |
public | function | Returns the Panelizer service. | |
PanelizerWidget:: |
public | function | Returns the Panelizer entity plugin manager. | |
PanelizerWidget:: |
public | function | Returns the Panels display plugin manager. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginSettingsBase:: |
protected | property | Whether default settings have been merged into the current $settings. | |
PluginSettingsBase:: |
protected | property | The plugin settings injected by third party modules. | |
PluginSettingsBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
6 |
PluginSettingsBase:: |
public static | function |
Defines the default settings for this plugin. Overrides PluginSettingsInterface:: |
42 |
PluginSettingsBase:: |
public | function |
Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
protected | function | Merges default settings values into $settings. | |
PluginSettingsBase:: |
public | function |
Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface:: |
3 |
PluginSettingsBase:: |
public | function |
Sets the value of a setting for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the settings for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
WidgetBase:: |
protected | property | The field definition. | |
WidgetBase:: |
protected | property |
The widget settings. Overrides PluginSettingsBase:: |
|
WidgetBase:: |
public static | function | Ajax callback for the "Add another item" button. | |
WidgetBase:: |
public static | function | Submission handler for the "Add another item" button. | |
WidgetBase:: |
public static | function | After-build handler for field elements in a form. | |
WidgetBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
5 |
WidgetBase:: |
public | function |
Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface:: |
8 |
WidgetBase:: |
public | function |
Extracts field values from submitted form values. Overrides WidgetBaseInterface:: |
2 |
WidgetBase:: |
public | function |
Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface:: |
2 |
WidgetBase:: |
public | function |
Creates a form element for a field. Overrides WidgetBaseInterface:: |
3 |
WidgetBase:: |
protected | function | Special handling to create form elements for multiple values. | 1 |
WidgetBase:: |
protected | function | Generates the form element for a single copy of the widget. | |
WidgetBase:: |
protected | function | Returns the value of a field setting. | |
WidgetBase:: |
protected | function | Returns the array of field settings. | |
WidgetBase:: |
protected | function | Returns the filtered field description. | |
WidgetBase:: |
public static | function |
Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface:: |
|
WidgetBase:: |
protected static | function | Returns the location of processing information within $form_state. | |
WidgetBase:: |
protected | function | Returns whether the widget handles multiple values. | |
WidgetBase:: |
public static | function |
Returns if the widget can be used for the provided field. Overrides WidgetInterface:: |
4 |
WidgetBase:: |
protected | function | Returns whether the widget used for default value form. | |
WidgetBase:: |
public | function |
Massages the form values into the format expected for field values. Overrides WidgetInterface:: |
7 |
WidgetBase:: |
public | function |
Returns a form to configure settings for the widget. Overrides WidgetInterface:: |
16 |
WidgetBase:: |
public | function |
Returns a short summary for the current widget settings. Overrides WidgetInterface:: |
15 |
WidgetBase:: |
public static | function |
Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface:: |
|
WidgetBase:: |
public | function |
Constructs a WidgetBase object. Overrides PluginBase:: |
5 |