class ViewsBlock in Search API 8

Represents a Views block display.

Plugin annotation

@SearchApiDisplay(
  id = "views_block",
  views_display_type = "block",
  deriver = "Drupal\search_api\Plugin\search_api\display\ViewsDisplayDeriver"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\search_api\Plugin\HideablePluginBase implements HideablePluginInterface
      • class \Drupal\search_api\Display\DisplayPluginBase implements DisplayInterface
        • class \Drupal\search_api\Plugin\search_api\display\ViewsDisplayBase
          • class \Drupal\search_api\Plugin\search_api\display\ViewsBlock

File

src/Plugin/search_api/display/ViewsBlock.php, line 14

Namespace

Drupal\search_api\Plugin\search_api\display

class ViewsBlock extends ViewsDisplayBase {

  /**
   * {@inheritdoc}
   */
  public function isRenderedInCurrentRequest() {

    // There can be more than one block rendering the display. If any block is
    // rendered, we return TRUE.
    $plugin_id = 'views_block:' . $this->pluginDefinition['view_id'] . '-' . $this->pluginDefinition['view_display'];
    $blocks = $this
      ->getEntityTypeManager()
      ->getStorage('block')
      ->loadByProperties([
      'plugin' => $plugin_id,
    ]);
    foreach ($blocks as $block) {
      if ($block
        ->access('view')) {
        return TRUE;
      }
    }
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
DisplayPluginBase::$currentPath	protected	property	The current path service.
DisplayPluginBase::$entityTypeManager	protected	property	The entity type manager.
DisplayPluginBase::getCurrentPath	public	function	Retrieves the current path service.
DisplayPluginBase::getDescription	public	function	Returns the display description. Overrides DisplayInterface::getDescription
DisplayPluginBase::getEntityTypeManager	public	function	Retrieves the entity type manager.
DisplayPluginBase::getIndex	public	function	Returns the index used by this display. Overrides DisplayInterface::getIndex
DisplayPluginBase::getUrl	public	function	Returns the URL of this display. Overrides DisplayInterface::getUrl
DisplayPluginBase::label	public	function	Returns the display label. Overrides DisplayInterface::label
DisplayPluginBase::setCurrentPath	public	function	Sets the current path service.
DisplayPluginBase::setEntityTypeManager	public	function	Sets the entity type manager.
HideablePluginBase::isHidden	public	function	Determines whether this plugin should be hidden in the UI. Overrides HideablePluginInterface::isHidden	1
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
ViewsBlock::isRenderedInCurrentRequest	public	function	Returns true if the display is being rendered in the current request. Overrides ViewsDisplayBase::isRenderedInCurrentRequest
ViewsDisplayBase::$currentRouteMatch	protected	property	The current route match service.
ViewsDisplayBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DisplayPluginBase::calculateDependencies
ViewsDisplayBase::create	public static	function	Creates an instance of the plugin. Overrides DisplayPluginBase::create
ViewsDisplayBase::getCurrentRouteMatch	public	function	Retrieves the current route match service.
ViewsDisplayBase::getPath	public	function	Returns the base path used by this display. Overrides DisplayPluginBase::getPath
ViewsDisplayBase::getView	protected	function	Retrieves the view this search display is based on.
ViewsDisplayBase::setCurrentRouteMatch	public	function	Sets the current route match service.