class Ingredient in Recipe 8.2
Same name in this branch
- 8.2 modules/ingredient/src/Entity/Ingredient.php \Drupal\ingredient\Entity\Ingredient
- 8.2 modules/ingredient/src/Feeds/Target/Ingredient.php \Drupal\ingredient\Feeds\Target\Ingredient
- 8.2 modules/ingredient/src/Plugin/views/wizard/Ingredient.php \Drupal\ingredient\Plugin\views\wizard\Ingredient
- 8.2 modules/ingredient/src/Plugin/migrate/source/recipe1x/Ingredient.php \Drupal\ingredient\Plugin\migrate\source\recipe1x\Ingredient
Wizard plugin for creating Ingredient views.
Plugin annotation
@ViewsWizard(
id = "ingredient",
base_table = "ingredient_field_data",
title = @Translation("Ingredient")
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
- class \Drupal\views\Plugin\views\wizard\WizardPluginBase implements WizardInterface uses UrlGeneratorTrait
- class \Drupal\ingredient\Plugin\views\wizard\Ingredient
- class \Drupal\views\Plugin\views\wizard\WizardPluginBase implements WizardInterface uses UrlGeneratorTrait
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of Ingredient
1 string reference to 'Ingredient'
- ingredient.info.yml in modules/
ingredient/ ingredient.info.yml - modules/ingredient/ingredient.info.yml
File
- modules/
ingredient/ src/ Plugin/ views/ wizard/ Ingredient.php, line 17
Namespace
Drupal\ingredient\Plugin\views\wizardView source
class Ingredient extends WizardPluginBase {
/**
* @var string
*
* Set the created column.
*/
protected $createdColumn = 'ingredient_field_data-created';
/**
* Overrides Drupal\views\Plugin\views\wizard\WizardPluginBase::getAvailableSorts().
*
* @return array
* An array whose keys are the available sort options and whose
* corresponding values are human readable labels.
*/
public function getAvailableSorts() {
// You can't execute functions in properties, so override the method.
return [
'ingredient_field_data-name:ASC' => $this
->t('Name'),
];
}
/**
* {@inheritdoc}
*/
protected function rowStyleOptions() {
$options = [];
$options['full_posts'] = $this
->t('full posts');
$options['names'] = $this
->t('names');
$options['names_linked'] = $this
->t('names (linked)');
$options['fields'] = $this
->t('fields');
return $options;
}
/**
* {@inheritdoc}
*/
protected function defaultDisplayOptions() {
$display_options = parent::defaultDisplayOptions();
// Add permission-based access control.
$display_options['access']['type'] = 'perm';
$display_options['access']['options']['perm'] = 'view ingredient';
// Remove the default fields, since we are customizing them here.
unset($display_options['fields']);
/* Field: Ingredient: Name */
$display_options['fields']['name']['id'] = 'name';
$display_options['fields']['name']['table'] = 'ingredient_field_data';
$display_options['fields']['name']['field'] = 'name';
$display_options['fields']['name']['entity_type'] = 'ingredient';
$display_options['fields']['name']['entity_field'] = 'name';
$display_options['fields']['name']['label'] = '';
$display_options['fields']['name']['alter']['alter_text'] = 0;
$display_options['fields']['name']['alter']['make_link'] = 0;
$display_options['fields']['name']['alter']['absolute'] = 0;
$display_options['fields']['name']['alter']['trim'] = 0;
$display_options['fields']['name']['alter']['word_boundary'] = 0;
$display_options['fields']['name']['alter']['ellipsis'] = 0;
$display_options['fields']['name']['alter']['strip_tags'] = 0;
$display_options['fields']['name']['alter']['html'] = 0;
$display_options['fields']['name']['hide_empty'] = 0;
$display_options['fields']['name']['empty_zero'] = 0;
$display_options['fields']['name']['type'] = 'string';
$display_options['fields']['name']['settings']['link_to_entity'] = 1;
$display_options['fields']['name']['plugin_id'] = 'field';
return $display_options;
}
/**
* {@inheritdoc}
*/
protected function pageDisplayOptions(array $form, FormStateInterface $form_state) {
$display_options = parent::pageDisplayOptions($form, $form_state);
$row_plugin = $form_state
->getValue([
'page',
'style',
'row_plugin',
]);
$row_options = $form_state
->getValue([
'page',
'style',
'row_options',
], []);
$this
->display_options_row($display_options, $row_plugin, $row_options);
return $display_options;
}
/**
* {@inheritdoc}
*/
protected function blockDisplayOptions(array $form, FormStateInterface $form_state) {
$display_options = parent::blockDisplayOptions($form, $form_state);
$row_plugin = $form_state
->getValue([
'block',
'style',
'row_plugin',
]);
$row_options = $form_state
->getValue([
'block',
'style',
'row_options',
], []);
$this
->display_options_row($display_options, $row_plugin, $row_options);
return $display_options;
}
/**
* Set the row style and row style plugins to the display_options.
*/
protected function display_options_row(&$display_options, $row_plugin, $row_options) {
switch ($row_plugin) {
case 'full_posts':
$display_options['row']['type'] = 'entity:ingredient';
$display_options['row']['options']['view_mode'] = 'full';
break;
case 'names_linked':
case 'names':
$display_options['row']['type'] = 'fields';
$display_options['fields']['name']['id'] = 'name';
$display_options['fields']['name']['table'] = 'ingredient_field_data';
$display_options['fields']['name']['field'] = 'name';
$display_options['fields']['name']['settings']['link_to_entity'] = $row_plugin === 'names_linked';
$display_options['fields']['name']['plugin_id'] = 'field';
break;
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
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 | |
Ingredient:: |
protected | property |
Set the created column. Overrides WizardPluginBase:: |
|
Ingredient:: |
protected | function |
Retrieves the block display options. Overrides WizardPluginBase:: |
|
Ingredient:: |
protected | function |
Assembles the default display options for the view. Overrides WizardPluginBase:: |
|
Ingredient:: |
protected | function | Set the row style and row style plugins to the display_options. | |
Ingredient:: |
public | function |
Overrides Drupal\views\Plugin\views\wizard\WizardPluginBase::getAvailableSorts(). Overrides WizardPluginBase:: |
|
Ingredient:: |
protected | function |
Retrieves the page display options. Overrides WizardPluginBase:: |
|
Ingredient:: |
protected | function |
Retrieves row style plugin names. Overrides WizardPluginBase:: |
|
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:: |
public | property | Plugins's definition | |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
public | property | Options for this plugin will be held here. | |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | Stores the render API renderer. | 3 |
PluginBase:: |
protected | property | Denotes whether the plugin has an additional options form. | 8 |
PluginBase:: |
public | property | The top object of a view. | 1 |
PluginBase:: |
public | function |
Provide a form to edit options for this plugin. Overrides ViewsPluginInterface:: |
16 |
PluginBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
14 |
PluginBase:: |
protected | function | Information about options for all kinds of purposes will be held here. | 18 |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Clears a plugin. Overrides ViewsPluginInterface:: |
2 |
PluginBase:: |
protected | function | Do the work to filter out stored options depending on the defined options. | |
PluginBase:: |
public | function |
Filter out stored options depending on the defined options. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns an array of available token replacements. Overrides ViewsPluginInterface:: |
|
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 |
Returns the plugin provider. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
protected | function | Returns the render API renderer. | 1 |
PluginBase:: |
public | function |
Adds elements for available core tokens to a form. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns a string with any core tokens replaced. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
constant | Include entity row languages when listing languages. | ||
PluginBase:: |
constant | Include negotiated languages when listing languages. | ||
PluginBase:: |
public | function |
Initialize the plugin. Overrides ViewsPluginInterface:: |
8 |
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
protected | function | Makes an array of languages, optionally including special languages. | |
PluginBase:: |
public | function |
Return the human readable name of the display. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function |
Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function |
Flattens the structure of form elements. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Add anything to the query that we might need to. Overrides ViewsPluginInterface:: |
8 |
PluginBase:: |
public static | function | Returns substitutions for Views queries for languages. | |
PluginBase:: |
protected | function | Fills up the options of the plugin with defaults. | |
PluginBase:: |
public | function |
Handle any special handling on the validate form. Overrides ViewsPluginInterface:: |
16 |
PluginBase:: |
public | function |
Returns the summary of the settings in the display. Overrides ViewsPluginInterface:: |
6 |
PluginBase:: |
public | function |
Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface:: |
1 |
PluginBase:: |
public static | function |
Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface:: |
6 |
PluginBase:: |
public | function |
Unpack options over our existing defaults, drilling down into arrays
so that defaults don't get totally blown away. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns the usesOptions property. Overrides ViewsPluginInterface:: |
8 |
PluginBase:: |
public | function |
Validate that the plugin is correct and can be saved. Overrides ViewsPluginInterface:: |
6 |
PluginBase:: |
public | function |
Validate the options form. Overrides ViewsPluginInterface:: |
15 |
PluginBase:: |
protected | function | Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin. | 1 |
PluginBase:: |
constant | Query string to indicate the site default language. | ||
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. | |
TrustedCallbackInterface:: |
constant | Untrusted callbacks throw exceptions. | ||
TrustedCallbackInterface:: |
constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. | ||
TrustedCallbackInterface:: |
constant | Untrusted callbacks trigger E_USER_WARNING errors. | ||
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Returns a redirect response object for the specified route. | 3 |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. | |
WizardPluginBase:: |
protected | property | The available store criteria. | |
WizardPluginBase:: |
protected | property | The base table connected with the wizard. | |
WizardPluginBase:: |
protected | property | The bundle info service. | |
WizardPluginBase:: |
protected | property | Contains the information from entity_get_info of the $entity_type. | |
WizardPluginBase:: |
protected | property | The entity type connected with the wizard. | |
WizardPluginBase:: |
protected | property | Views items configuration arrays for filters added by the wizard. | 2 |
WizardPluginBase:: |
protected | property | Default values for filters. | |
WizardPluginBase:: |
protected | property | Views items configuration arrays for sorts added by the wizard. | |
WizardPluginBase:: |
protected | property | An array of validated view objects, keyed by a hash. | |
WizardPluginBase:: |
protected | function | Adds the array of display options to the view, with appropriate overrides. | |
WizardPluginBase:: |
protected | function | Alters the full array of display options before they are added to the view. | |
WizardPluginBase:: |
protected | function | Builds an array of display options for the view. | 1 |
WizardPluginBase:: |
protected | function | Builds the form structure for selecting the view's filters. | 1 |
WizardPluginBase:: |
public | function |
Form callback to build other elements in the "show" form. Overrides WizardInterface:: |
|
WizardPluginBase:: |
protected | function | Adds the style options to the wizard form. | |
WizardPluginBase:: |
protected | function | Builds the form structure for selecting the view's sort order. | |
WizardPluginBase:: |
public static | function |
Creates an instance of the plugin. Overrides PluginBase:: |
1 |
WizardPluginBase:: |
public | function |
Creates a view from values that have already been validated. Overrides WizardInterface:: |
|
WizardPluginBase:: |
protected | function | Retrieves all filter information used by the default display. | |
WizardPluginBase:: |
protected | function | Retrieves filter information based on user input for the default display. | 2 |
WizardPluginBase:: |
protected | function | Retrieves all sort information used by the default display. | |
WizardPluginBase:: |
protected | function | Retrieves sort information based on user input for the default display. | |
WizardPluginBase:: |
public | function | Gets the createdColumn property. | |
WizardPluginBase:: |
public | function | Gets the filters property. | 1 |
WizardPluginBase:: |
public static | function | Gets the current value of a #select element, from within a form constructor function. | |
WizardPluginBase:: |
public | function | Gets the sorts property. | |
WizardPluginBase:: |
protected | function | Instantiates a view object from form values. | |
WizardPluginBase:: |
protected | function | Retrieves the feed display options. | |
WizardPluginBase:: |
protected | function | Retrieves the REST export display options from the submitted form values. | |
WizardPluginBase:: |
protected | function | Retrieves a validated view for a form submission. | |
WizardPluginBase:: |
protected | function | Sets options for a display and makes them the default options if possible. | |
WizardPluginBase:: |
protected | function | Sets options for a display, inheriting from the defaults when possible. | |
WizardPluginBase:: |
protected | function | Stores a validated view from a form submission. | |
WizardPluginBase:: |
public | function |
Implements Drupal\views\Plugin\views\wizard\WizardInterface::validate(). Overrides WizardInterface:: |
|
WizardPluginBase:: |
public | function |
Constructs a WizardPluginBase object. Overrides PluginBase:: |
1 |