Comment
class Comment extends WizardPluginBase (View source)
Tests creating comment views with the wizard.
Traits
Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.
Provides dependency injection friendly methods for serialization.
Provides a trait for the messenger service.
Constants
| DERIVATIVE_SEPARATOR |
A string which is used to separate base plugin IDs from the derivative ID. |
| INCLUDE_NEGOTIATED |
Include negotiated languages when listing languages. |
| INCLUDE_ENTITY |
Include entity row languages when listing languages. |
| VIEWS_QUERY_LANGUAGE_SITE_DEFAULT |
Query string to indicate the site default language. |
Properties
| protected string | $pluginId | The plugin_id. |
from PluginBase |
| protected array | $pluginDefinition | The plugin implementation definition. |
from PluginBase |
| protected array | $configuration | Configuration information passed into the plugin. |
from PluginBase |
| protected TranslationInterface | $stringTranslation | The string translation service. |
from StringTranslationTrait |
| protected array | $_serviceIds | An array of service IDs keyed by property name used for serialization. |
from DependencySerializationTrait |
| protected array | $_entityStorages | An array of entity type IDs keyed by the property name of their storages. |
from DependencySerializationTrait |
| protected MessengerInterface | $messenger | The messenger. |
from MessengerTrait |
| array | $options | Options for this plugin will be held here. |
from PluginBase |
| ViewExecutable | $view | The top object of a view. |
from PluginBase |
| DisplayPluginBase | $displayHandler | The display object this plugin is for. |
from PluginBase |
| array | $definition | Plugins's definition. |
from PluginBase |
| protected bool | $usesOptions | Denotes whether the plugin has an additional options form. |
from PluginBase |
| protected RendererInterface | $renderer | Stores the render API renderer. |
from PluginBase |
| protected string | $base_table | The base table connected with the wizard. |
from WizardPluginBase |
| protected string | $entityTypeId | The entity type connected with the wizard. |
from WizardPluginBase |
| protected EntityTypeInterface | $entityType | Contains the information from entity_get_info of the $entity_type. |
from WizardPluginBase |
| protected array | $validated_views | An array of validated view objects, keyed by a hash. |
from WizardPluginBase |
| protected string | $createdColumn | Set the created column. |
|
| protected | $filters | Set default values for the filters. |
|
| protected array | $sorts | Views items configuration arrays for sorts added by the wizard. |
from WizardPluginBase |
| protected array | $availableSorts | The available store criteria. |
from WizardPluginBase |
| protected array | $filter_defaults | Default values for filters. |
from WizardPluginBase |
| protected EntityTypeBundleInfoInterface | $bundleInfoService | The bundle info service. |
from WizardPluginBase |
| protected MenuParentFormSelectorInterface | $parentFormSelector | The parent form selector service. |
from WizardPluginBase |
Methods
Constructs a WizardPluginBase object.
Translates a string to the current language or to a given language.
Formats a string containing a count of items.
Returns the number of plurals supported by a given language.
Gets the string translation service.
Creates an instance of the plugin.
Initialize the plugin.
Information about options for all kinds of purposes will be held here.
Fills up the options of the plugin with defaults.
Filter out stored options depending on the defined options.
Do the work to filter out stored options depending on the defined options.
Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
Provide a form to edit options for this plugin.
Lists the trusted callbacks provided by the implementing class.
Handle any special handling on the validate form.
Provide a full list of possible theme templates used by this style.
Returns a string with any core tokens replaced.
Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin.
Returns an array of available token replacements.
Adds elements for available core tokens to a form.
Moves form elements into fieldsets for presentation purposes.
Flattens the structure of form elements.
Makes an array of languages, optionally including special languages.
Returns substitutions for Views queries for languages.
Form callback to build other elements in the "show" form.
Gets the current value of a #select element, from within a form constructor function.
Adds the style options to the wizard form.
Retrieves row style plugin names.
Builds the form structure for selecting the view's filters.
Builds the form structure for selecting the view's sort order.
Builds an array of display options for the view.
Alters the full array of display options before they are added to the view.
Adds the array of display options to the view, with appropriate overrides.
Assembles the default display options for the view.
Retrieves all filter information used by the default display.
Retrieves filter information based on user input for the default display.
Retrieves all sort information used by the default display.
Retrieves sort information based on user input for the default display.
Retrieves the block display options.
Retrieves the REST export display options from the submitted form values.
Retrieves the feed display options.
Sets options for a display and makes them the default options if possible.
Sets options for a display, inheriting from the defaults when possible.
Retrieves a validated view for a form submission.
Stores a validated view from a form submission.
Implements Drupal\views\Plugin\views\wizard\WizardInterface::validate().
Creates a view from values that have already been validated.
Details
__construct(array $configuration, string $plugin_id, mixed $plugin_definition, EntityTypeBundleInfoInterface $bundle_info_service, MenuParentFormSelectorInterface $parent_form_selector = NULL)
Constructs a WizardPluginBase object.
string
getPluginId()
Gets the plugin_id of the plugin instance.
string
getBaseId()
Gets the base_plugin_id of the plugin instance.
string|null
getDerivativeId()
Gets the derivative_id of the plugin instance.
array
getPluginDefinition()
Gets the definition of the plugin implementation.
bool
isConfigurable()
Determines if the plugin is configurable.
protected TranslatableMarkup
t(string $string, array $args = [], array $options = [])
Translates a string to the current language or to a given language.
See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.
In order for strings to be localized, make them available in one of the ways supported by the
protected
formatPlural($count, $singular, $plural, array $args = [], array $options = [])
Formats a string containing a count of items.
protected
getNumberOfPlurals($langcode = NULL)
Returns the number of plurals supported by a given language.
protected TranslationInterface
getStringTranslation()
Gets the string translation service.
$this
setStringTranslation(TranslationInterface $translation)
Sets the string translation service to use.
__sleep()
{@inheritdoc}
__wakeup()
{@inheritdoc}
setMessenger(MessengerInterface $messenger)
Sets the messenger.
MessengerInterface
messenger()
Gets the messenger.
static ContainerFactoryPluginInterface
create(ContainerInterface $container, array $configuration, string $plugin_id, mixed $plugin_definition)
Creates an instance of the plugin.
init(ViewExecutable $view, DisplayPluginBase $display, array $options = NULL)
Initialize the plugin.
protected array
defineOptions()
Information about options for all kinds of purposes will be held here.
protected
setOptionDefaults(array $storage, array $options)
Fills up the options of the plugin with defaults.
filterByDefinedOptions(array $storage)
Filter out stored options depending on the defined options.
protected
doFilterByDefinedOptions(array $storage, array $options)
Do the work to filter out stored options depending on the defined options.
unpackOptions($storage, $options, $definition = NULL, $all = TRUE, $check = TRUE)
Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
destroy()
Clears a plugin.
buildOptionsForm($form, FormStateInterface $form_state)
Provide a form to edit options for this plugin.
static string[]
trustedCallbacks()
Lists the trusted callbacks provided by the implementing class.
Trusted callbacks are public methods on the implementing class and can be invoked via \Drupal\Core\Security\DoTrustedCallbackTrait::doTrustedCallback().
validateOptionsForm($form, FormStateInterface $form_state)
Validate the options form.
submitOptionsForm($form, FormStateInterface $form_state)
Handle any special handling on the validate form.
query()
Add anything to the query that we might need to.
themeFunctions()
Provide a full list of possible theme templates used by this style.
An
validate()
Validate that the plugin is correct and can be saved.
summaryTitle()
Returns the summary of the settings in the display.
pluginTitle()
Return the human readable name of the display.
This appears on the ui beside each plugin and beside the settings link.
usesOptions()
Returns the usesOptions property.
string
globalTokenReplace(string $string = '', array $options = [])
Returns a string with any core tokens replaced.
protected string
viewsTokenReplace($text, $tokens)
Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin.
array
getAvailableGlobalTokens(bool $prepared = FALSE, array $types = [])
Returns an array of available token replacements.
globalTokenForm(array $form, FormStateInterface $form_state)
Adds elements for available core tokens to a form.
static array
preRenderAddFieldsetMarkup(array $form)
Moves form elements into fieldsets for presentation purposes.
Many views forms use #tree = TRUE to keep their values in a hierarchy for easier storage. Moving the form elements into fieldsets during form building would break up that hierarchy. Therefore, we wait until the pre_render stage, where any changes we make affect presentation only and aren't reflected in $form_state->getValues().
static array
preRenderFlattenData(array $form)
Flattens the structure of form elements.
If a form element has #flatten = TRUE, then all of its children get moved to the same level as the element itself. So $form['to_be_flattened'][$key] becomes $form[$key], and $form['to_be_flattened'] gets unset.
array
calculateDependencies()
Calculates dependencies for the configured plugin.
Dependencies are saved in the plugin's configuration entity and are used to determine configuration synchronization order. For example, if the plugin integrates with specific user roles, this method should return an array of dependencies listing the specified roles.
string
getProvider()
Returns the plugin provider.
protected array
listLanguages(int $flags = LanguageInterface::STATE_ALL, array $current_values = NULL)
Makes an array of languages, optionally including special languages.
static array
queryLanguageSubstitutions()
Returns substitutions for Views queries for languages.
This is needed so that the language options returned by PluginBase::listLanguages() are able to be used in queries. It is called by the Views module implementation of hook_views_query_substitutions() to get the language-related substitutions.
protected RendererInterface
getRenderer()
Returns the render API renderer.
string
getCreatedColumn()
Gets the createdColumn property.
array
getFilters()
Gets the filters property.
array
getAvailableSorts()
Gets the availableSorts property.
array
getSorts()
Gets the sorts property.
array
buildForm(array $form, FormStateInterface $form_state)
Form callback to build other elements in the "show" form.
This method builds all form elements beside of the selection of the base table.
static The
getSelected(FormStateInterface $form_state, $parents, $default_value, $element)
Gets the current value of a #select element, from within a form constructor function.
This function is intended for use in highly dynamic forms (in particular the add view wizard) which are rebuilt in different ways depending on which triggering element (AJAX or otherwise) was most recently fired. For example, sometimes it is necessary to decide how to build one dynamic form element based on the value of a different dynamic form element that may not have even been present on the form the last time it was submitted. This function takes care of resolving those conflicts and gives you the proper current value of the requested #select element.
By necessity, this function sometimes uses non-validated user input from FormState::$input in making its determination. Although it performs some minor validation of its own, it is not complete. The intention is that the return value of this function should only be used to help decide how to build the current form the next time it is reloaded, not to be saved as if it had gone through the normal, final form validation process. Do NOT use the results of this function for any other purpose besides deciding how to build the next version of the form.
protected
buildFormStyle(array $form, FormStateInterface $form_state, string $type)
Adds the style options to the wizard form.
protected array
rowStyleOptions()
Retrieves row style plugin names.
protected
buildFilters($form, FormStateInterface $form_state)
Builds the form structure for selecting the view's filters.
By default, this adds "of type" and "tagged with" filters (when they are available).
protected
buildSorts($form, FormStateInterface $form_state)
Builds the form structure for selecting the view's sort order.
By default, this adds a "sorted by [date]" filter (when it is available).
protected ViewUI
instantiateView($form, FormStateInterface $form_state)
Instantiates a view object from form values.
protected array
buildDisplayOptions($form, FormStateInterface $form_state)
Builds an array of display options for the view.
protected
alterDisplayOptions($display_options, $form, FormStateInterface $form_state)
Alters the full array of display options before they are added to the view.
protected
addDisplays(View $view, $display_options, $form, FormStateInterface $form_state)
Adds the array of display options to the view, with appropriate overrides.
protected array
defaultDisplayOptions()
Assembles the default display options for the view.
Most wizards will need to override this method to provide some fields or a different row plugin.
protected array
defaultDisplayFilters(array $form, FormStateInterface $form_state)
Retrieves all filter information used by the default display.
Additional to the one provided by the plugin this method takes care about adding additional filters based on user input.
protected array
defaultDisplayFiltersUser(array $form, FormStateInterface $form_state)
Retrieves filter information based on user input for the default display.
protected array
defaultDisplaySorts(array $form, FormStateInterface $form_state)
Retrieves all sort information used by the default display.
Additional to the one provided by the plugin this method takes care about adding additional sorts based on user input.
protected array
defaultDisplaySortsUser(array $form, FormStateInterface $form_state)
Retrieves sort information based on user input for the default display.
protected array
pageDisplayOptions(array $form, FormStateInterface $form_state)
Retrieves the page display options.
protected array
blockDisplayOptions(array $form, FormStateInterface $form_state)
Retrieves the block display options.
protected array
restExportDisplayOptions(array $form, FormStateInterface $form_state)
Retrieves the REST export display options from the submitted form values.
protected array
pageFeedDisplayOptions(array $form, FormStateInterface $form_state)
Retrieves the feed display options.
protected
setDefaultOptions(array $options, DisplayPluginBase $display, DisplayPluginBase $default_display)
Sets options for a display and makes them the default options if possible.
This function can be used to set options for a display when it is desired that the options also become the defaults for the view whenever possible. This should be done for the "primary" display created in the view wizard, so that new displays which the user adds later will be similar to this one.
protected
setOverrideOptions(array $options, DisplayPluginBase $display, DisplayPluginBase $default_display)
Sets options for a display, inheriting from the defaults when possible.
This function can be used to set options for a display when it is desired that the options inherit from the default display whenever possible. This avoids setting too many options as overrides, which will be harder for the user to modify later. For example, if $this->setDefaultOptions() was previously called on a page display and then this function is called on a block display, and if the user entered the same title for both displays in the views wizard, then the view will wind up with the title stored as the default (with the page and block both inheriting from it).
protected ViewUI
retrieveValidatedView(array $form, FormStateInterface $form_state, bool $unset = TRUE)
Retrieves a validated view for a form submission.
protected
setValidatedView(array $form, FormStateInterface $form_state, ViewUI $view)
Stores a validated view from a form submission.
array
validateView(array $form, FormStateInterface $form_state)
Implements Drupal\views\Plugin\views\wizard\WizardInterface::validate().
Instantiates the view from the form submission and validates its values.
ViewEntityInterface
createView(array $form, FormStateInterface $form_state)
Creates a view from values that have already been validated.