You are here

Home » API reference » Search API 8 » SearchApiDataRow.php

class SearchApiDataRow in Search API 8

Displays entities as raw data.

Plugin annotation


@ViewsRow(
  id = "search_api_data",
  title = @Translation("Entity (Search API)"),
  help = @Translation("Retrieves entities as row data."),
  display_types = {"data"}
)

Hierarchy

Expanded class hierarchy of SearchApiDataRow

See also

search_api_views_plugins_row_alter()

File

src/Plugin/views/row/SearchApiDataRow.php, line 28

Namespace

Drupal\search_api\Plugin\views\row
View source 
class SearchApiDataRow extends DataEntityRow {
  use LoggerTrait;
  use SearchApiHandlerTrait;

  /**
   * The search index associated with the current view.
   *
   * @var \Drupal\search_api\IndexInterface|null
   */
  protected $index;

  /**
   * {@inheritdoc}
   */
  public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
    parent::init($view, $display, $options);
    $base_table = $view->storage
      ->get('base_table');
    $this->index = SearchApiQuery::getIndexFromTable($base_table, $this
      ->getEntityTypeManager());
    if (!$this->index) {
      $view_label = $view->storage
        ->label();
      throw new \InvalidArgumentException("View '{$view_label}' is not based on Search API but tries to use its row plugin.");
    }
  }

  /**
   * {@inheritdoc}
   */
  public function preRender($result) {
    parent::preRender($result);
    $this
      ->getQuery()
      ->getSearchApiResults()
      ->preLoadResultItems();

    /** @var \Drupal\search_api\Plugin\views\ResultRow $row */
    foreach ($result as $row) {
      if (!$row->_object) {
        try {
          $row->_object = $row->_item
            ->getOriginalObject(FALSE);
        } catch (SearchApiException $e) {

          // Can never happen for getOriginalObject() with $load = FALSE. Catch
          // for sake of static analysis.
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function render($row) {

    /** @var \Drupal\search_api\Plugin\views\ResultRow $row */
    if (!$row->_object instanceof ComplexDataInterface) {
      $context = [
        '%item_id' => $row->search_api_id,
        '%view' => $this->view->storage
          ->label(),
      ];
      $this
        ->getLogger()
        ->warning('Failed to load item %item_id in view %view.', $context);
      return NULL;
    }
    return $row->_object;
  }

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

}

Members

Namesort descending Modifiers Type Description Overrides
DataEntityRow::$deprecatedProperties protected property
DataEntityRow::$entityDisplayRepository protected property The entity display repository.
DataEntityRow::$entityRepository protected property The entity repository service.
DataEntityRow::$entityType protected property Contains the entity type of this row plugin instance.
DataEntityRow::$entityTypeManager protected property The entity type manager.
DataEntityRow::$languageManager protected property The language manager.
DataEntityRow::$usesOptions protected property Denotes whether the plugin has an additional options form. Overrides RowPluginBase::$usesOptions
DataEntityRow::create public static function Creates an instance of the plugin. Overrides PluginBase::create
DataEntityRow::getEntityManager protected function
DataEntityRow::getEntityRepository protected function Returns the entity repository. Overrides EntityTranslationRenderTrait::getEntityRepository
DataEntityRow::getEntityTypeId public function Returns the entity type identifier. Overrides EntityTranslationRenderTrait::getEntityTypeId
DataEntityRow::getEntityTypeManager protected function Returns the entity type manager. Overrides EntityTranslationRenderTrait::getEntityTypeManager
DataEntityRow::getLanguageManager protected function Returns the language manager. Overrides EntityTranslationRenderTrait::getLanguageManager
DataEntityRow::getView protected function Returns the top object of a view. Overrides EntityTranslationRenderTrait::getView
DataEntityRow::__construct public function Constructs a new DataEntityRow object. Overrides PluginBase::__construct
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
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
EntityTranslationRenderTrait::$entityTranslationRenderer protected property The renderer to be used to render the entity row.
EntityTranslationRenderTrait::getEntityTranslation public function Returns the entity translation matching the configured row language.
EntityTranslationRenderTrait::getEntityTranslationRenderer protected function Returns the current renderer.
LoggerTrait::$logger protected property The logging channel to use.
LoggerTrait::getLogger public function Retrieves the logger.
LoggerTrait::logException protected function Logs an exception.
LoggerTrait::setLogger public function Sets the logger.
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::$definition public property Plugins's 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::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$renderer protected property Stores the render API renderer. 3
PluginBase::$view public property The top object of a view. 1
PluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 14
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function Clears a plugin. 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 Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
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::getProvider public function Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer protected function Returns the render API renderer. 1
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced. 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::isConfigurable public function Determines if the plugin is configurable.
PluginBase::listLanguages protected function Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle public function Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup public static function Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData public static function Flattens the structure of form elements. 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::summaryTitle public function Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions 1
PluginBase::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks 6
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions 8
PluginBase::validate public function Validate that the plugin is correct and can be saved. Overrides ViewsPluginInterface::validate 6
PluginBase::viewsTokenReplace protected function Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin. 1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
RowPluginBase::$usesFields protected property Does the row plugin support to add fields to its output. 4
RowPluginBase::buildOptionsForm public function Provide a form for setting options. Overrides PluginBase::buildOptionsForm 8
RowPluginBase::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides PluginBase::defineOptions 8
RowPluginBase::submitOptionsForm public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. Overrides PluginBase::submitOptionsForm 1
RowPluginBase::usesFields public function Returns the usesFields property. 4
RowPluginBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm 1
SearchApiDataRow::$index protected property The search index associated with the current view.
SearchApiDataRow::init public function Initialize the plugin. Overrides PluginBase::init
SearchApiDataRow::preRender public function Allow the style to do stuff before each row is rendered. Overrides RowPluginBase::preRender
SearchApiDataRow::query public function Add anything to the query that we might need to. Overrides DataEntityRow::query
SearchApiDataRow::render public function Render a row object. This usually passes through to a theme template of some form, but not always. Overrides DataEntityRow::render
SearchApiHandlerTrait::ensureMyTable public function Overrides the Views handlers' ensureMyTable() method.
SearchApiHandlerTrait::getEntityType public function Determines the entity type used by this handler. 1
SearchApiHandlerTrait::getIndex protected function Returns the active search index.
SearchApiHandlerTrait::getQuery public function Retrieves the query plugin.
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.
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.