class View
Same name in this branch
- 11.x core/modules/views/src/Element/View.php \Drupal\views\Element\View
- 11.x core/modules/views/src/Entity/View.php \Drupal\views\Entity\View
Same name in other branches
- 9 core/modules/views/src/Element/View.php \Drupal\views\Element\View
- 9 core/modules/views/src/Entity/View.php \Drupal\views\Entity\View
- 9 core/modules/views/src/Plugin/views/area/View.php \Drupal\views\Plugin\views\area\View
- 8.9.x core/modules/views/src/Element/View.php \Drupal\views\Element\View
- 8.9.x core/modules/views/src/Entity/View.php \Drupal\views\Entity\View
- 8.9.x core/modules/views/src/Plugin/views/area/View.php \Drupal\views\Plugin\views\area\View
- 10 core/modules/views/src/Element/View.php \Drupal\views\Element\View
- 10 core/modules/views/src/Entity/View.php \Drupal\views\Entity\View
- 10 core/modules/views/src/Plugin/views/area/View.php \Drupal\views\Plugin\views\area\View
Views area handlers. Insert a view inside of an area.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\views\Plugin\views\HandlerBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\ViewsHandlerInterface
- class \Drupal\views\Plugin\views\area\AreaPluginBase extends \Drupal\views\Plugin\views\HandlerBase
- class \Drupal\views\Plugin\views\area\View extends \Drupal\views\Plugin\views\area\AreaPluginBase
- class \Drupal\views\Plugin\views\area\AreaPluginBase extends \Drupal\views\Plugin\views\HandlerBase
- class \Drupal\views\Plugin\views\HandlerBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\ViewsHandlerInterface
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of View
Related topics
1 file declares its use of View
- ViewTest.php in core/
modules/ views/ tests/ src/ Unit/ Plugin/ area/ ViewTest.php
287 string references to 'View'
- Access::query in core/
modules/ node/ src/ Plugin/ views/ filter/ Access.php - See _node_access_where_sql() for a non-views query based implementation.
- AddFormBase::processInputValues in core/
modules/ media_library/ src/ Form/ AddFormBase.php - Creates media items from source field input values.
- AddHandler::buildForm in core/
modules/ views_ui/ src/ Form/ Ajax/ AddHandler.php - Analyze::buildForm in core/
modules/ views_ui/ src/ Form/ Ajax/ Analyze.php - Analyze::submitForm in core/
modules/ views_ui/ src/ Form/ Ajax/ Analyze.php
File
-
core/
modules/ views/ src/ Plugin/ views/ area/ View.php, line 16
Namespace
Drupal\views\Plugin\views\areaView source
class View extends AreaPluginBase {
/**
* Stores whether the embedded view is actually empty.
*
* @var bool
*/
protected $isEmpty;
/**
* The view storage.
*
* @var \Drupal\Core\Entity\EntityStorageInterface
*/
protected $viewStorage;
/**
* Constructs a View object.
*
* @param array $configuration
* A configuration array containing information about the plugin instance.
* @param string $plugin_id
* The plugin ID for the plugin instance.
* @param mixed $plugin_definition
* The plugin implementation definition.
* @param \Drupal\Core\Entity\EntityStorageInterface $view_storage
* The view storage.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityStorageInterface $view_storage) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->viewStorage = $view_storage;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container->get('entity_type.manager')
->getStorage('view'));
}
/**
* {@inheritdoc}
*/
protected function defineOptions() {
$options = parent::defineOptions();
$options['view_to_insert'] = [
'default' => '',
];
$options['inherit_arguments'] = [
'default' => FALSE,
];
return $options;
}
/**
* {@inheritdoc}
*/
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
parent::buildOptionsForm($form, $form_state);
$view_display = $this->view->storage
->id() . ':' . $this->view->current_display;
$options = [
'' => $this->t('-Select-'),
];
$options += Views::getViewsAsOptions(FALSE, 'all', $view_display, FALSE, TRUE);
$form['view_to_insert'] = [
'#type' => 'select',
'#title' => $this->t('View to insert'),
'#default_value' => $this->options['view_to_insert'],
'#description' => $this->t('The view to insert into this area.'),
'#options' => $options,
];
$form['inherit_arguments'] = [
'#type' => 'checkbox',
'#title' => $this->t('Inherit contextual filters'),
'#default_value' => $this->options['inherit_arguments'],
'#description' => $this->t('If checked, this view will receive the same contextual filters as its parent.'),
];
}
/**
* {@inheritdoc}
*/
public function render($empty = FALSE) {
if (!empty($this->options['view_to_insert'])) {
[
$view_name,
$display_id,
] = explode(':', $this->options['view_to_insert']);
$view = $this->viewStorage
->load($view_name)
->getExecutable();
if (empty($view) || !$view->access($display_id)) {
return [];
}
$view->setDisplay($display_id);
// Avoid recursion
$view->parent_views += $this->view->parent_views;
$view->parent_views[] = "{$view_name}:{$display_id}";
// Check if the view is part of the parent views of this view
$search = "{$view_name}:{$display_id}";
if (in_array($search, $this->view->parent_views)) {
\Drupal::messenger()->addError($this->t("Recursion detected in view @view display @display.", [
'@view' => $view_name,
'@display' => $display_id,
]));
}
else {
if (!empty($this->options['inherit_arguments']) && !empty($this->view->args)) {
$output = $view->preview($display_id, $this->view->args);
}
else {
$output = $view->preview($display_id);
}
$this->isEmpty = $view->display_handler
->outputIsEmpty();
return $output;
}
}
return [];
}
/**
* {@inheritdoc}
*/
public function isEmpty() {
if (isset($this->isEmpty)) {
return $this->isEmpty;
}
else {
return parent::isEmpty();
}
}
/**
* {@inheritdoc}
*/
public function calculateDependencies() {
$dependencies = parent::calculateDependencies();
[
$view_id,
] = explode(':', $this->options['view_to_insert'], 2);
// Don't call the current view, as it would result into an infinite recursion.
if ($view_id && $this->view->storage
->id() != $view_id) {
$view = $this->viewStorage
->load($view_id);
$dependencies[$view->getConfigDependencyKey()][] = $view->getConfigDependencyName();
}
return $dependencies;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
AreaPluginBase::$areaType | public | property | The type of this area handler, i.e. 'header', 'footer', or 'empty'. | ||
AreaPluginBase::adminSummary | public | function | Overrides HandlerBase::adminSummary | ||
AreaPluginBase::init | public | function | Overrides Drupal\views\Plugin\views\HandlerBase::init(). | Overrides HandlerBase::init | 1 |
AreaPluginBase::preRender | public | function | Performs any operations needed before full rendering. | 1 | |
AreaPluginBase::usesGroupBy | public | function | Overrides HandlerBase::usesGroupBy | ||
DerivativeInspectionInterface::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | 1 | |
DerivativeInspectionInterface::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | 1 | |
HandlerBase::$field | public | property | With field you can override the realField if the real field is not set. | ||
HandlerBase::$is_handler | public | property | |||
HandlerBase::$moduleHandler | protected | property | The module handler. | 2 | |
HandlerBase::$query | public | property | Where the $query object will reside. | 7 | |
HandlerBase::$realField | public | property | The real field. | ||
HandlerBase::$relationship | public | property | The relationship used for this field. | ||
HandlerBase::$table | public | property | The table this handler is attached to. | ||
HandlerBase::$tableAlias | public | property | The alias of the table of this handler which is used in the query. | ||
HandlerBase::$viewsData | protected | property | The views data service. | ||
HandlerBase::acceptExposedInput | public | function | Take input from exposed handlers and assign to this handler, if necessary. | 1 | |
HandlerBase::access | public | function | Overrides ViewsHandlerInterface::access | 5 | |
HandlerBase::adminLabel | public | function | Overrides ViewsHandlerInterface::adminLabel | 4 | |
HandlerBase::breakString | public static | function | Overrides ViewsHandlerInterface::breakString | ||
HandlerBase::broken | public | function | Overrides ViewsHandlerInterface::broken | ||
HandlerBase::buildExposedForm | public | function | Render our chunk of the exposed handler form when selecting. | 1 | |
HandlerBase::buildExposeForm | public | function | Form for exposed handler options. | 2 | |
HandlerBase::buildExtraOptionsForm | public | function | Provide a form for setting options. | 2 | |
HandlerBase::buildGroupByForm | public | function | Provide a form for aggregation settings. | 1 | |
HandlerBase::canExpose | public | function | Determine if a handler can be exposed. | 2 | |
HandlerBase::caseTransform | protected | function | Transform a string by a certain method. | ||
HandlerBase::defaultExposeOptions | public | function | Set new exposed option defaults when exposed setting is flipped on. | 2 | |
HandlerBase::defineExtraOptions | public | function | Provide defaults for the handler. | ||
HandlerBase::displayExposedForm | public | function | Displays the Expose form. | ||
HandlerBase::ensureMyTable | public | function | Overrides ViewsHandlerInterface::ensureMyTable | 2 | |
HandlerBase::exposedInfo | public | function | Get information about the exposed form for the form renderer. | 1 | |
HandlerBase::getDateField | public | function | Creates cross-database SQL dates. | 2 | |
HandlerBase::getDateFormat | public | function | Creates cross-database SQL date formatting. | 2 | |
HandlerBase::getEntityType | public | function | Overrides ViewsHandlerInterface::getEntityType | ||
HandlerBase::getField | public | function | Overrides ViewsHandlerInterface::getField | ||
HandlerBase::getJoin | public | function | Overrides ViewsHandlerInterface::getJoin | ||
HandlerBase::getModuleHandler | protected | function | Gets the module handler. | ||
HandlerBase::getTableJoin | public static | function | Overrides ViewsHandlerInterface::getTableJoin | ||
HandlerBase::getViewsData | protected | function | Gets views data service. | ||
HandlerBase::hasExtraOptions | public | function | Determines if the handler has extra options. | 2 | |
HandlerBase::isAGroup | public | function | Returns TRUE if the exposed filter works like a grouped filter. | 1 | |
HandlerBase::isExposed | public | function | Determine if this item is 'exposed'. | ||
HandlerBase::multipleExposedInput | public | function | Define if the exposed input has to be submitted multiple times. | 1 | |
HandlerBase::placeholder | protected | function | Provides a unique placeholders for handlers. | ||
HandlerBase::postExecute | public | function | Overrides ViewsHandlerInterface::postExecute | ||
HandlerBase::preQuery | public | function | Overrides ViewsHandlerInterface::preQuery | 2 | |
HandlerBase::query | public | function | Overrides PluginBase::query | 7 | |
HandlerBase::sanitizeValue | public | function | Overrides ViewsHandlerInterface::sanitizeValue | ||
HandlerBase::setModuleHandler | public | function | Sets the module handler. | ||
HandlerBase::setRelationship | public | function | Overrides ViewsHandlerInterface::setRelationship | ||
HandlerBase::setViewsData | public | function | |||
HandlerBase::showExposeButton | public | function | Shortcut to display the expose/hide button. | 2 | |
HandlerBase::showExposeForm | public | function | Shortcut to display the exposed options form. | Overrides ViewsHandlerInterface::showExposeForm | |
HandlerBase::storeExposedInput | public | function | If set to remember exposed input in the session, store it there. | 1 | |
HandlerBase::submitExposed | public | function | Submit the exposed handler form. | ||
HandlerBase::submitExposeForm | public | function | Perform any necessary changes to the form exposes prior to storage. | ||
HandlerBase::submitExtraOptionsForm | public | function | Perform any necessary changes to the form values prior to storage. | 1 | |
HandlerBase::submitFormCalculateOptions | public | function | Calculates options stored on the handler. | 1 | |
HandlerBase::submitGroupByForm | public | function | Perform any necessary changes to the form values prior to storage. | 1 | |
HandlerBase::submitTemporaryForm | public | function | Submits a temporary form. | ||
HandlerBase::validate | public | function | Overrides PluginBase::validate | 2 | |
HandlerBase::validateExposed | public | function | Validate the exposed handler form. | 5 | |
HandlerBase::validateExposeForm | public | function | Validate the options form. | 2 | |
HandlerBase::validateExtraOptionsForm | public | function | Validate the options form. | 1 | |
PluginBase::$definition | public | property | Plugins' definition. | ||
PluginBase::$displayHandler | public | property | The display object this plugin is for. | ||
PluginBase::$options | public | property | Options for this plugin will be held here. | ||
PluginBase::$position | public | property | The handler position. | ||
PluginBase::$renderer | protected | property | Stores the render API renderer. | 3 | |
PluginBase::$usesOptions | protected | property | Denotes whether the plugin has an additional options form. | 8 | |
PluginBase::$view | public | property | The top object of a view. | 1 | |
PluginBase::destroy | public | function | Overrides ViewsPluginInterface::destroy | 2 | |
PluginBase::doFilterByDefinedOptions | protected | function | Do the work to filter out stored options depending on the defined options. | ||
PluginBase::filterByDefinedOptions | public | function | Overrides ViewsPluginInterface::filterByDefinedOptions | ||
PluginBase::getAvailableGlobalTokens | public | function | Overrides ViewsPluginInterface::getAvailableGlobalTokens | ||
PluginBase::getProvider | public | function | Overrides ViewsPluginInterface::getProvider | ||
PluginBase::getRenderer | protected | function | Returns the render API renderer. | 1 | |
PluginBase::globalTokenForm | public | function | Overrides ViewsPluginInterface::globalTokenForm | ||
PluginBase::globalTokenReplace | public | function | Overrides ViewsPluginInterface::globalTokenReplace | ||
PluginBase::INCLUDE_ENTITY | constant | Include entity row languages when listing languages. | |||
PluginBase::INCLUDE_NEGOTIATED | constant | Include negotiated languages when listing languages. | |||
PluginBase::listLanguages | protected | function | Makes an array of languages, optionally including special languages. | ||
PluginBase::pluginTitle | public | function | Overrides ViewsPluginInterface::pluginTitle | ||
PluginBase::preRenderAddFieldsetMarkup | public static | function | Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup | ||
PluginBase::preRenderFlattenData | public static | function | Overrides ViewsPluginInterface::preRenderFlattenData | ||
PluginBase::queryLanguageSubstitutions | public static | function | Returns substitutions for Views queries for languages. | ||
PluginBase::setOptionDefaults | protected | function | Fills up the options of the plugin with defaults. | ||
PluginBase::submitOptionsForm | public | function | Overrides ViewsPluginInterface::submitOptionsForm | 16 | |
PluginBase::summaryTitle | public | function | Overrides ViewsPluginInterface::summaryTitle | 6 | |
PluginBase::themeFunctions | public | function | Overrides ViewsPluginInterface::themeFunctions | 1 | |
PluginBase::trustedCallbacks | public static | function | Overrides TrustedCallbackInterface::trustedCallbacks | 6 | |
PluginBase::unpackOptions | public | function | Overrides ViewsPluginInterface::unpackOptions | ||
PluginBase::usesOptions | public | function | Overrides ViewsPluginInterface::usesOptions | 8 | |
PluginBase::validateOptionsForm | public | function | Overrides ViewsPluginInterface::validateOptionsForm | 15 | |
PluginBase::viewsTokenReplace | protected | function | Replaces Views' tokens in a given string. | 1 | |
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT | constant | Query string to indicate the site default language. | |||
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin ID of the plugin instance. | 2 | |
TrustedCallbackInterface::THROW_EXCEPTION | constant | Untrusted callbacks throw exceptions. | |||
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION | constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. | |||
View::$isEmpty | protected | property | Stores whether the embedded view is actually empty. | ||
View::$viewStorage | protected | property | The view storage. | ||
View::buildOptionsForm | public | function | Overrides AreaPluginBase::buildOptionsForm | ||
View::calculateDependencies | public | function | Overrides HandlerBase::calculateDependencies | ||
View::create | public static | function | Overrides PluginBase::create | ||
View::defineOptions | protected | function | Overrides AreaPluginBase::defineOptions | ||
View::isEmpty | public | function | Overrides AreaPluginBase::isEmpty | ||
View::render | public | function | Overrides AreaPluginBase::render | ||
View::__construct | public | function | Constructs a View object. | Overrides HandlerBase::__construct |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.