class RevisionLogWidget in Hide Revision Field 8.2
Plugin implementation of the 'hide_revision_field_log_widget' widget.
Plugin annotation
@FieldWidget(
id = "hide_revision_field_log_widget",
label = @Translation("Revision Log Widget"),
field_types = {
"string_long"
}
)
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\Core\Field\Plugin\Field\FieldWidget\StringTextareaWidget
- class \Drupal\hide_revision_field\Plugin\Field\FieldWidget\RevisionLogWidget implements ContainerFactoryPluginInterface
- class \Drupal\Core\Field\Plugin\Field\FieldWidget\StringTextareaWidget
- 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 RevisionLogWidget
File
- src/
Plugin/ Field/ FieldWidget/ RevisionLogWidget.php, line 25
Namespace
Drupal\hide_revision_field\Plugin\Field\FieldWidgetView source
class RevisionLogWidget extends StringTextareaWidget implements ContainerFactoryPluginInterface {
protected $user;
/**
* Create the widget instance.
*
* @param \Symfony\Component\DependencyInjection\ContainerInterface $container
* The symfony container.
* @param array $configuration
* The plugin configuration.
* @param string $plugin_id
* The the plugin id.
* @param mixed $plugin_definition
* The plugin definition.
*
* @return \Drupal\Core\Plugin\ContainerFactoryPluginInterface|\Drupal\hide_revision_field\Plugin\Field\FieldWidget\RevisionLogWidget
* The widget.
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['third_party_settings'], $container
->get('current_user'));
}
/**
* Constructs a RevisionLogWidget object.
*
* @param string $plugin_id
* The plugin_id for the widget.
* @param mixed $plugin_definition
* The plugin implementation definition.
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The definition of the field to which the widget is associated.
* @param array $settings
* The widget settings.
* @param array $third_party_settings
* Any third party settings.
* @param \Drupal\Core\Session\AccountProxyInterface $user
* The current user.
*/
public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, AccountProxyInterface $user) {
parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings);
$this->user = $user;
}
/**
* {@inheritdoc}
*/
public static function defaultSettings() {
return [
'show' => TRUE,
'default' => '',
'permission_based' => FALSE,
'allow_user_settings' => TRUE,
] + parent::defaultSettings();
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
$element = parent::settingsForm($form, $form_state);
$settings = $this
->getSettings();
$element['show'] = [
'#type' => 'checkbox',
'#title' => t('Show'),
'#default_value' => $settings['show'],
'#description' => $this
->t('Show field by default.'),
];
$element['allow_user_settings'] = [
'#type' => 'checkbox',
'#title' => t('Allow user specific configuration.'),
'#default_value' => $settings['allow_user_settings'],
'#description' => $this
->t('Allow users to configure their own default value/display of the revision log field on their profile pages.'),
];
$element['permission_based'] = [
'#type' => 'checkbox',
'#title' => t('Display Based on Permissions'),
'#default_value' => $settings['permission_based'],
'#description' => $this
->t('Show field if user has permission "%perm: Customize revision logs".', [
'%perm' => $this->fieldDefinition
->getTargetEntityTypeId(),
]),
];
$element['default'] = [
'#type' => 'textfield',
'#title' => t('Default'),
'#default_value' => $settings['default'],
'#description' => $this
->t('Default value for revision log.'),
];
return $element;
}
/**
* {@inheritdoc}
*/
public function settingsSummary() {
$summary = parent::settingsSummary();
$settings = $this
->getSettings();
if ($settings['show']) {
$summary[] = $this
->t('Shown by default');
}
else {
$summary[] = $this
->t('Hidden by default');
}
if ($settings['default']) {
$summary[] = $this
->t('Default value: %default', [
'%default' => $settings['default'],
]);
}
if ($settings['allow_user_settings']) {
$summary[] = $this
->t('Users allowed to customize their default');
}
if ($settings['permission_based']) {
$summary[] = $this
->t('Show if user has permission');
}
return $summary;
}
/**
* {@inheritdoc}
*/
public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
$element = parent::formElement($items, $delta, $element, $form, $form_state);
$settings = $this
->getSettings();
if ($settings['default']) {
$element['value']['#default_value'] = $settings['default'];
}
$show = $settings['show'];
if ($settings['permission_based']) {
if ($this->user
->hasPermission('access revision field')) {
$show = TRUE;
}
else {
$show = FALSE;
}
}
// Check for user level personalization.
if ($settings['allow_user_settings'] && $this->user
->hasPermission('administer revision field personalization')) {
$form_object = $form_state
->getFormObject();
/** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
// Get entity from an inline entity form or a standard ContentEntityForm.
if (!empty($form['#type']) && $form['#type'] == 'inline_entity_form' && !empty($form['#entity'])) {
$entity = $form['#entity'];
}
elseif (!empty($form['#type']) && $form['#type'] == 'container') {
$complete_form = $form_state
->getCompleteForm();
if (!empty($complete_form['widget']['inline_entity_form']['#entity'])) {
$entity = $complete_form['widget']['inline_entity_form']['#entity'];
}
}
elseif (method_exists($form_object, 'getEntity')) {
$entity = $form_object
->getEntity();
}
else {
$entity = $items
->getEntity();
}
if (!empty($entity)) {
if (empty($form_state
->get('langcode'))) {
$form_state
->set('langcode', $entity
->language()
->getId());
}
$user_settings = unserialize(User::load($this->user
->id())
->get('revision_log_settings')->value);
if (isset($user_settings[$entity
->getEntityType()
->id()][$entity
->bundle()])) {
$show = $user_settings[$entity
->getEntityType()
->id()][$entity
->bundle()];
}
}
}
if (!$show) {
$element['value']['#type'] = 'hidden';
}
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. | |
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 | 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:: |
|
RevisionLogWidget:: |
protected | property | ||
RevisionLogWidget:: |
public static | function |
Create the widget instance. Overrides WidgetBase:: |
|
RevisionLogWidget:: |
public static | function |
Defines the default settings for this plugin. Overrides StringTextareaWidget:: |
|
RevisionLogWidget:: |
public | function |
Returns the form for a single field widget. Overrides StringTextareaWidget:: |
|
RevisionLogWidget:: |
public | function |
Returns a form to configure settings for the widget. Overrides StringTextareaWidget:: |
|
RevisionLogWidget:: |
public | function |
Returns a short summary for the current widget settings. Overrides StringTextareaWidget:: |
|
RevisionLogWidget:: |
public | function |
Constructs a RevisionLogWidget object. Overrides WidgetBase:: |
|
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 | 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 static | function |
Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface:: |