class BlockFieldItem in Block field 8
Plugin implementation of the 'block_field' field type.
Plugin annotation
@FieldType(
id = "block_field",
label = @Translation("Block (plugin)"),
description = @Translation("Stores an instance of a configurable or custom block."),
category = @Translation("Reference"),
default_widget = "block_field_default",
default_formatter = "block_field",
)
Hierarchy
- class \Drupal\Core\TypedData\TypedData implements PluginInspectionInterface, TypedDataInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
- class \Drupal\Core\TypedData\Plugin\DataType\Map implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, ComplexDataInterface
- class \Drupal\Core\Field\FieldItemBase implements FieldItemInterface
- class \Drupal\block_field\Plugin\Field\FieldType\BlockFieldItem implements BlockFieldItemInterface
- class \Drupal\Core\Field\FieldItemBase implements FieldItemInterface
- class \Drupal\Core\TypedData\Plugin\DataType\Map implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, ComplexDataInterface
Expanded class hierarchy of BlockFieldItem
File
- src/
Plugin/ Field/ FieldType/ BlockFieldItem.php, line 26
Namespace
Drupal\block_field\Plugin\Field\FieldTypeView source
class BlockFieldItem extends FieldItemBase implements BlockFieldItemInterface {
/**
* {@inheritdoc}
*/
public static function defaultFieldSettings() {
return [
'selection' => 'blocks',
'selection_settings' => [],
] + parent::defaultFieldSettings();
}
/**
* {@inheritdoc}
*/
public static function mainPropertyName() {
return 'plugin_id';
}
/**
* {@inheritdoc}
*/
public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
$properties['plugin_id'] = DataDefinition::create('string')
->setLabel(t('Plugin ID'))
->setRequired(TRUE);
$properties['settings'] = MapDataDefinition::create()
->setLabel(t('Settings'));
return $properties;
}
/**
* {@inheritdoc}
*/
public static function schema(FieldStorageDefinitionInterface $field_definition) {
return [
'columns' => [
'plugin_id' => [
'description' => 'The block plugin id',
'type' => 'varchar',
'length' => 255,
],
'settings' => [
'description' => 'Serialized array of settings for the block.',
'type' => 'blob',
'size' => 'big',
'serialize' => TRUE,
],
],
'indexes' => [
'plugin_id' => [
'plugin_id',
],
],
];
}
/**
* {@inheritdoc}
*/
public function fieldSettingsForm(array $form, FormStateInterface $form_state) {
$field = $form_state
->getFormObject()
->getEntity();
/** @var \Drupal\block_field\BlockFieldSelectionManager $block_field_selection_manager */
$block_field_selection_manager = \Drupal::service('plugin.manager.block_field_selection');
$options = $block_field_selection_manager
->getOptions();
$form = [
'#type' => 'container',
'#process' => [
[
get_class($this),
'fieldSettingsAjaxProcess',
],
],
'#element_validate' => [
[
get_class($this),
'fieldSettingsFormValidate',
],
],
];
$form['selection'] = [
'#type' => 'details',
'#title' => $this
->t('Available blocks'),
'#open' => TRUE,
'#tree' => TRUE,
'#process' => [
[
get_class($this),
'formProcessMergeParent',
],
],
];
$form['selection']['selection'] = [
'#type' => 'select',
'#title' => $this
->t('Selection method'),
'#options' => $options,
'#default_value' => $field
->getSetting('selection'),
'#required' => TRUE,
'#ajax' => TRUE,
'#limit_validation_errors' => [],
];
$form['selection']['selection_submit'] = [
'#type' => 'submit',
'#value' => $this
->t('Change selection'),
'#limit_validation_errors' => [],
'#attributes' => [
'class' => [
'js-hide',
],
],
'#submit' => [
[
get_class($this),
'settingsAjaxSubmit',
],
],
];
$form['selection']['selection_settings'] = [
'#type' => 'container',
'#attributes' => [
'class' => [
'block_field-settings',
],
],
];
$selection = $block_field_selection_manager
->getSelectionHandler($field);
$form['selection']['selection_settings'] += $selection
->buildConfigurationForm([], $form_state);
return $form;
}
/**
* {@inheritdoc}
*/
public function isEmpty() {
$value = $this
->get('plugin_id')
->getValue();
return $value === NULL || $value === '';
}
/**
* {@inheritdoc}
*/
public function setValue($values, $notify = TRUE) {
// Treat the values as property value of the main property, if no array is
// given.
if (isset($values) && !is_array($values)) {
$values = [
static::mainPropertyName() => $values,
];
}
if (isset($values)) {
$values += [
'settings' => [],
];
}
// Unserialize the values.
if (is_string($values['settings'])) {
$values['settings'] = unserialize($values['settings']);
}
parent::setValue($values, $notify);
}
/**
* {@inheritdoc}
*/
public function getBlock() {
if (empty($this->plugin_id)) {
return NULL;
}
/** @var \Drupal\Core\Block\BlockManagerInterface $block_manager */
$block_manager = \Drupal::service('plugin.manager.block');
/** @var \Drupal\Core\Block\BlockPluginInterface $block_instance */
$block_instance = $block_manager
->createInstance($this->plugin_id, $this->settings);
$plugin_definition = $block_instance
->getPluginDefinition();
// Don't return broken block plugin instances.
if ($plugin_definition['id'] == 'broken') {
return NULL;
}
// Don't return broken block content instances.
if ($plugin_definition['id'] == 'block_content') {
$uuid = $block_instance
->getDerivativeId();
if (!\Drupal::service('entity.repository')
->loadEntityByUuid('block_content', $uuid)) {
return NULL;
}
}
return $block_instance;
}
/**
* Render API callback.
*
* Processes the field settings form and allows access to
* the form state.
*
* @see \Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem
* @see static::fieldSettingsForm()
*/
public static function fieldSettingsAjaxProcess($form, FormStateInterface $form_state) {
static::fieldSettingsAjaxProcessElement($form, $form);
return $form;
}
/**
* Adds block_field specific properties to AJAX form elements from settings.
*
* @see \Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem
* @see static::fieldSettingsAjaxProcess()
*/
public static function fieldSettingsAjaxProcessElement(&$element, $main_form) {
if (!empty($element['#ajax'])) {
$element['#ajax'] = [
'callback' => [
get_called_class(),
'settingsAjax',
],
'wrapper' => $main_form['#id'],
'element' => $main_form['#array_parents'],
];
}
foreach (Element::children($element) as $key) {
static::fieldSettingsAjaxProcessElement($element[$key], $main_form);
}
}
/**
* Ajax callback for the selection settings form.
*
* @see \Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem
* @see static::fieldSettingsForm()
*/
public static function settingsAjax($form, FormStateInterface $form_state) {
return NestedArray::getValue($form, $form_state
->getTriggeringElement()['#ajax']['element']);
}
/**
* Submit selection for the non-JS case.
*
* @see \Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem
* @see static::fieldSettingsForm()
*/
public static function settingsAjaxSubmit($form, FormStateInterface $form_state) {
$form_state
->setRebuild();
}
/**
* Render API callback.
*
* Moves block_field specific Form API elements
* (i.e. 'selection_settings') up a level for easier processing by the
* validation and submission selections.
*/
public static function formProcessMergeParent($element) {
$parents = $element['#parents'];
array_pop($parents);
$element['#parents'] = $parents;
return $element;
}
/**
* Form element validation handler; Invokes selection plugin's validation.
*
* @param array $form
* The form where the settings form is being included in.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The form state of the (entire) configuration form.
*/
public static function fieldSettingsFormValidate(array $form, FormStateInterface $form_state) {
$field = $form_state
->getFormObject()
->getEntity();
$handler = \Drupal::service('plugin.manager.block_field_selection')
->getSelectionHandler($field);
$handler
->validateConfigurationForm($form, $form_state);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BlockFieldItem:: |
public static | function |
Defines the field-level settings for this plugin. Overrides FieldItemBase:: |
|
BlockFieldItem:: |
public static | function | Render API callback. | |
BlockFieldItem:: |
public static | function | Adds block_field specific properties to AJAX form elements from settings. | |
BlockFieldItem:: |
public | function |
Returns a form for the field-level settings. Overrides FieldItemBase:: |
|
BlockFieldItem:: |
public static | function | Form element validation handler; Invokes selection plugin's validation. | |
BlockFieldItem:: |
public static | function | Render API callback. | |
BlockFieldItem:: |
public | function |
Get block instance. Overrides BlockFieldItemInterface:: |
|
BlockFieldItem:: |
public | function |
Determines whether the data structure is empty. Overrides Map:: |
|
BlockFieldItem:: |
public static | function |
Returns the name of the main property, if any. Overrides FieldItemBase:: |
|
BlockFieldItem:: |
public static | function |
Defines field item properties. Overrides FieldItemInterface:: |
|
BlockFieldItem:: |
public static | function |
Returns the schema for the field. Overrides FieldItemInterface:: |
|
BlockFieldItem:: |
public static | function | Ajax callback for the selection settings form. | |
BlockFieldItem:: |
public static | function | Submit selection for the non-JS case. | |
BlockFieldItem:: |
public | function |
Sets the data value. Overrides FieldItemBase:: |
|
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 | |
FieldItemBase:: |
public static | function |
Calculates dependencies for field items. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public static | function |
Calculates dependencies for field items on the storage level. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public static | function |
Defines the storage-level settings for this plugin. Overrides FieldItemInterface:: |
10 |
FieldItemBase:: |
public | function |
Defines custom delete behavior for field values. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public | function |
Defines custom revision delete behavior for field values. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public static | function |
Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public static | function |
Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public static | function |
Generates placeholder field values. Overrides FieldItemInterface:: |
18 |
FieldItemBase:: |
public | function |
Gets the entity that field belongs to. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public | function |
Gets the field definition. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public | function |
Gets the langcode of the field values held in the object. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
protected | function | Returns the value of a field setting. | |
FieldItemBase:: |
protected | function | Returns the array of field settings. | |
FieldItemBase:: |
public static | function |
Informs the plugin that a dependency of the field will be deleted. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public | function |
Defines custom post-save behavior for field values. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public | function |
Defines custom presave behavior for field values. Overrides FieldItemInterface:: |
7 |
FieldItemBase:: |
public | function |
Returns a form for the storage-level settings. Overrides FieldItemInterface:: |
8 |
FieldItemBase:: |
public static | function |
Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public static | function |
Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public | function |
Returns a renderable array for a single field item. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
protected | function |
Different to the parent Map class, we avoid creating property objects as
far as possible in order to optimize performance. Thus we just update
$this->values if no property object has been created yet. Overrides Map:: |
|
FieldItemBase:: |
public | function |
Constructs a TypedData object given its definition and context. Overrides TypedData:: |
1 |
FieldItemBase:: |
public | function |
Magic method: Gets a property value. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public | function |
Magic method: Determines whether a property is set. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public | function |
Magic method: Sets a property value. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public | function |
Magic method: Unsets a property. Overrides FieldItemInterface:: |
|
Map:: |
protected | property |
The data definition. Overrides TypedData:: |
|
Map:: |
protected | property | The array of properties. | |
Map:: |
protected | property | An array of values for the contained properties. | |
Map:: |
public | function |
Applies the default value. Overrides TypedData:: |
4 |
Map:: |
public | function |
Gets a property object. Overrides ComplexDataInterface:: |
|
Map:: |
public | function | ||
Map:: |
public | function |
Gets an array of property objects. Overrides ComplexDataInterface:: |
|
Map:: |
public | function |
Returns a string representation of the data. Overrides TypedData:: |
|
Map:: |
public | function |
Gets the data value. Overrides TypedData:: |
1 |
Map:: |
public | function |
Overrides TraversableTypedDataInterface:: |
4 |
Map:: |
public | function |
Sets a property value. Overrides ComplexDataInterface:: |
|
Map:: |
public | function |
Returns an array of all property values. Overrides ComplexDataInterface:: |
1 |
Map:: |
public | function | Magic method: Implements a deep clone. | |
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. | |
TypedData:: |
protected | property | The property name. | |
TypedData:: |
protected | property | The parent typed data object. | |
TypedData:: |
public static | function |
Constructs a TypedData object given its definition and context. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Gets a list of validation constraints. Overrides TypedDataInterface:: |
9 |
TypedData:: |
public | function |
Gets the data definition. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Returns the name of a property or item. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Returns the parent data structure; i.e. either complex data or a list. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
TypedData:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
TypedData:: |
public | function |
Returns the property path of the data. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Returns the root of the typed data tree. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Validates the currently set data value. Overrides TypedDataInterface:: |
|
TypedDataTrait:: |
protected | property | The typed data manager used for creating the data types. | |
TypedDataTrait:: |
public | function | Gets the typed data manager. | 2 |
TypedDataTrait:: |
public | function | Sets the typed data manager. | 2 |