class SearchApiBulkForm in Search API 8

Defines an actions-based bulk operation form element.

Plugin annotation

@ViewsField("search_api_bulk_form");

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\HandlerBase implements ViewsHandlerInterface
    class \Drupal\views\Plugin\views\field\FieldPluginBase implements FieldHandlerInterface
    class \Drupal\views\Plugin\views\field\BulkForm implements CacheableDependencyInterface uses DeprecatedServicePropertyTrait, RedirectDestinationTrait, EntityTranslationRenderTrait, UncacheableFieldHandlerTrait
    class \Drupal\search_api\Plugin\views\field\SearchApiBulkForm uses SearchApiFieldTrait

Expanded class hierarchy of SearchApiBulkForm

File

src/Plugin/views/field/SearchApiBulkForm.php, line 22

Namespace

Drupal\search_api\Plugin\views\field

View source

class SearchApiBulkForm extends BulkForm {
  use SearchApiFieldTrait {
    preRender as traitPreRender;
    defineOptions as ignoreDefineOptions;
    buildOptionsForm as ignoreBuildOptionsForm;
  }

  /**
   * {@inheritdoc}
   */
  public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
    parent::init($view, $display, $options);
    $entity_type_ids = array_values($this
      ->getIndex()
      ->getEntityTypes());
    if (!$entity_type_ids) {
      $this->actions = [];
      return;
    }

    // Filter the actions to only include those that are supported by at least
    // one entity type contained in the index.
    $filter = function (ActionConfigEntityInterface $action) use ($entity_type_ids) {
      return in_array($action
        ->getType(), $entity_type_ids, TRUE);
    };
    $actions = $this->actionStorage
      ->loadMultiple();
    $this->actions = array_filter($actions, $filter);
  }

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

    // The standard BulkForm only works with a single entity type, but results
    // returned by Search API might contain entities of many different entity
    // types, and even datasources that are not based on entities.
    // Override the parent method as BulkForm::init() will call this and will
    // complain that a valid entity type cannot be retrieved.
    // @see \Drupal\views\Plugin\views\field\BulkForm::init()
    // @see \Drupal\views\Plugin\views\HandlerBase::getEntityType()
    return NULL;
  }

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

    // We cannot use the parent's method as we don't know the entity type on a
    // per-view basis. Using this cache context covers us on multilingual sites.
    if ($this->languageManager
      ->isMultilingual()) {
      return [
        'languages:' . LanguageInterface::TYPE_CONTENT,
      ];
    }
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getEntity(ResultRow $values) {

    /** @var \Drupal\search_api\Plugin\views\ResultRow $values */
    try {
      $value = $values->_item
        ->getOriginalObject()
        ->getValue();
    } catch (SearchApiException $e) {
      return NULL;
    }
    return $value instanceof EntityInterface ? $value : NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function preRender(&$values) {
    $this
      ->traitPreRender($values);

    // If the view is using a table style, provide a placeholder for a "select
    // all" checkbox.
    if (($this->view->style_plugin ?? NULL) instanceof Table) {

      // Add the tableselect css classes.
      $this->options['element_label_class'] .= 'select-all';

      // Hide the actual label of the field on the table header.
      $this->options['label'] = '';
    }
  }

  // phpcs:disable Drupal.Commenting.FunctionComment.TypeHintMissing

  /**
   * Form constructor for the bulk form.
   *
   * Search API supports also non-entity datasources but, as actions
   * require an entity, we don't show the checkbox for such rows. Unfortunately
   * it's hard to extend this method, so we are forking the parent's method.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function viewsForm(&$form, FormStateInterface $form_state) {

    // phpcs:enable
    // Make sure we do not accidentally cache this form.
    // @todo Evaluate this again in https://www.drupal.org/node/2503009.
    $form['#cache']['max-age'] = 0;

    // Add the tableselect javascript.
    $form['#attached']['library'][] = 'core/drupal.tableselect';
    $use_revision = array_key_exists('revision', $this->view
      ->getQuery()
      ->getEntityTableInfo());

    // Only add the bulk form options and buttons if there are results.
    if (!empty($this->view->result)) {

      // Render checkboxes for all rows.
      $form[$this->options['id']]['#tree'] = TRUE;
      foreach ($this->view->result as $row_index => $row) {

        // Search API supports also non-entity datasources but, as actions
        // require an entity, we don't show the checkbox for such rows.
        if (!$this
          ->getEntity($row)) {
          continue;
        }
        $entity = $this
          ->getEntityTranslation($this
          ->getEntity($row), $row);
        $form[$this->options['id']][$row_index] = [
          '#type' => 'checkbox',
          // We are not able to determine a main "title" for each row, so we can
          // only output a generic label.
          '#title' => $this
            ->t('Update this item'),
          '#title_display' => 'invisible',
          '#default_value' => !empty($form_state
            ->getValue($this->options['id'])[$row_index]) ? 1 : NULL,
          '#return_value' => $this
            ->calculateEntityBulkFormKey($entity, $use_revision),
        ];
      }

      // Replace the form submit button label.
      $form['actions']['submit']['#value'] = $this
        ->t('Apply to selected items');

      // Ensure a consistent container for filters/operations in the view header.
      $form['header'] = [
        '#type' => 'container',
        '#weight' => -100,
      ];

      // Build the bulk operations action widget for the header.
      // Allow themes to apply .container-inline on this separate container.
      $form['header'][$this->options['id']] = [
        '#type' => 'container',
      ];
      $form['header'][$this->options['id']]['action'] = [
        '#type' => 'select',
        '#title' => $this->options['action_title'],
        '#options' => $this
          ->getBulkOptions(),
      ];

      // Duplicate the form actions into the action container in the header.
      $form['header'][$this->options['id']]['actions'] = $form['actions'];
    }
    else {

      // Remove the default actions build array.
      unset($form['actions']);
    }
  }

  // phpcs:enable Drupal.Commenting.FunctionComment.TypeHintMissing

  /**
   * {@inheritdoc}
   */
  public function viewsFormValidate(&$form, FormStateInterface $form_state) {

    // As the view might contain rows from diverse entity types and an action
    // is designed to act only on a specific entity type, we remove the
    // incompatible selected rows from the selection and popup a warning.
    // @todo Use Javascript to already reflect this in the UI.
    $user_input = $form_state
      ->getUserInput();
    $input_key = $this->options['id'];
    $selected = $form_state
      ->getValue($input_key);
    $action = $this->actions[$form_state
      ->getValue('action')];
    $removed_entities = [];
    foreach ($selected as $delta => $bulk_form_key) {
      if ($bulk_form_key) {
        try {
          $entity = $this
            ->loadEntityFromBulkFormKey($bulk_form_key);
        } catch (\Exception $e) {
          $entity = NULL;
        }
        if (!$entity || $entity
          ->getEntityTypeId() !== $action
          ->getType()) {
          $removed_entities[] = $entity
            ->label();
          unset($selected[$delta]);
        }
      }
    }
    if ($removed_entities) {
      $form_state
        ->setValue($input_key, $selected);
      $user_input[$input_key] = $selected;
      $form_state
        ->setUserInput($user_input);
      $this
        ->messenger()
        ->addWarning($this
        ->formatPlural(count($removed_entities), "Row %items removed from selection as it's not compatible with %action action.", 'Rows %items removed from selection as they are not compatible with %action action.', [
        '%action' => $action
          ->label(),
        '%items' => implode(', ', $removed_entities),
      ]));
    }
    parent::viewsFormValidate($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  protected function calculateEntityBulkFormKey(EntityInterface $entity, $use_revision) {
    $parent_value = parent::calculateEntityBulkFormKey($entity, $use_revision);
    $bulk_form_key = json_decode(base64_decode($parent_value));

    // Rows of Search API views, based on entity datasources, might have
    // different entity types. We add the entity type ID to the bulk form key.
    array_unshift($bulk_form_key, $entity
      ->getEntityTypeId());
    $key = json_encode($bulk_form_key);
    return base64_encode($key);
  }

  /**
   * Loads an entity based on a bulk form key.
   *
   * This is a slightly changed copy of the parent's method, except that the
   * entity type ID is not view based but is extracted from the bulk form key.
   *
   * @param string $bulk_form_key
   *   The bulk form key representing the entity's id, language and revision (if
   *   applicable) as one string.
   *
   * @return \Drupal\Core\Entity\EntityInterface
   *   The entity loaded in the state (language, optionally revision) specified
   *   as part of the bulk form key.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   *   Thrown if the entity type doesn't exist.
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   *   Thrown if the storage handler couldn't be loaded.
   */
  protected function loadEntityFromBulkFormKey($bulk_form_key) {
    $key = base64_decode($bulk_form_key);
    $key_parts = json_decode($key);
    $revision_id = NULL;

    // If there are 4 items, the revision ID  will be last.
    if (count($key_parts) === 4) {
      $revision_id = array_pop($key_parts);
    }

    // The first three items will always be the entity type, langcode and ID.
    list($entity_type_id, $langcode, $id) = $key_parts;

    // Load the entity or a specific revision depending on the given key.
    $storage = $this->entityTypeManager
      ->getStorage($entity_type_id);
    $entity = $revision_id ? $storage
      ->loadRevision($revision_id) : $storage
      ->load($id);
    if ($entity instanceof TranslatableInterface) {
      $entity = $entity
        ->getTranslation($langcode);
    }
    return $entity;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BulkForm::$actions	protected	property	An array of actions that can be executed.
BulkForm::$actionStorage	protected	property	The action storage.
BulkForm::$deprecatedProperties	protected	property
BulkForm::$entityRepository	protected	property	The entity repository service.
BulkForm::$languageManager	protected	property	The language manager.
BulkForm::$messenger	protected	property	The messenger. Overrides MessengerTrait::$messenger
BulkForm::buildOptionsForm	public	function	Default options form that provides the label widget that all fields should have. Overrides FieldPluginBase::buildOptionsForm
BulkForm::create	public static	function	Creates an instance of the plugin. Overrides PluginBase::create
BulkForm::defineOptions	protected	function	Information about options for all kinds of purposes will be held here. Overrides FieldPluginBase::defineOptions
BulkForm::emptySelectedMessage	protected	function	Returns the message to be displayed when there are no selected items.	3
BulkForm::getBulkOptions	protected	function	Returns the available operations for this form.
BulkForm::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
BulkForm::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
BulkForm::getEntityManager	protected	function
BulkForm::getEntityRepository	protected	function	Returns the entity repository. Overrides EntityTranslationRenderTrait::getEntityRepository
BulkForm::getEntityTypeId	public	function	Returns the entity type identifier. Overrides EntityTranslationRenderTrait::getEntityTypeId
BulkForm::getLanguageManager	protected	function	Returns the language manager. Overrides EntityTranslationRenderTrait::getLanguageManager
BulkForm::getView	protected	function	Returns the top object of a view. Overrides EntityTranslationRenderTrait::getView
BulkForm::validateOptionsForm	public	function	Validate the options form. Overrides PluginBase::validateOptionsForm
BulkForm::viewsFormSubmit	public	function	Submit handler for the bulk form.
BulkForm::__construct	public	function	Constructs a new BulkForm object. Overrides HandlerBase::__construct	1
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.
FieldPluginBase::$additional_fields	public	property	Stores additional fields which get added to the query.
FieldPluginBase::$aliases	public	property
FieldPluginBase::$field_alias	public	property
FieldPluginBase::$lastRenderIndex	protected	property	Keeps track of the last render index.
FieldPluginBase::$linkGenerator	protected	property	The link generator.
FieldPluginBase::$original_value	public	property	The field value prior to any rewriting.
FieldPluginBase::$renderer	protected	property	Stores the render API renderer. Overrides PluginBase::$renderer	1
FieldPluginBase::addAdditionalFields	protected	function	Add 'additional' fields to the query.
FieldPluginBase::addSelfTokens	protected	function	Add any special tokens this field might use for itself.	4
FieldPluginBase::adminLabel	public	function	Return a string representing this handler's name in the UI. Overrides HandlerBase::adminLabel
FieldPluginBase::adminSummary	public	function	Provide extra data to the administration form Overrides HandlerBase::adminSummary
FieldPluginBase::advancedRender	public	function	Renders a field using advanced settings. Overrides FieldHandlerInterface::advancedRender
FieldPluginBase::allowAdvancedRender	protected	function	Determine if this field can allow advanced rendering.
FieldPluginBase::documentSelfTokens	protected	function	Document any special tokens this field might use for itself.	3
FieldPluginBase::elementClasses	public	function	Returns the class of the field. Overrides FieldHandlerInterface::elementClasses
FieldPluginBase::elementLabelClasses	public	function	Returns the class of the field's label. Overrides FieldHandlerInterface::elementLabelClasses
FieldPluginBase::elementLabelType	public	function	Returns an HTML element for the label based upon the field's element type. Overrides FieldHandlerInterface::elementLabelType
FieldPluginBase::elementType	public	function	Returns an HTML element based upon the field's element type. Overrides FieldHandlerInterface::elementType	1
FieldPluginBase::elementWrapperClasses	public	function	Returns the class of the field's wrapper. Overrides FieldHandlerInterface::elementWrapperClasses
FieldPluginBase::elementWrapperType	public	function	Returns an HTML element for the wrapper based upon the field's element type. Overrides FieldHandlerInterface::elementWrapperType
FieldPluginBase::getElements	public	function	Provides a list of elements valid for field HTML. Overrides FieldHandlerInterface::getElements
FieldPluginBase::getPreviousFieldLabels	protected	function	Returns all field labels of fields before this field.
FieldPluginBase::getRenderTokens	public	function	Gets the 'render' tokens to use for advanced rendering. Overrides FieldHandlerInterface::getRenderTokens
FieldPluginBase::getTokenValuesRecursive	protected	function	Recursive function to add replacements for nested query string parameters.
FieldPluginBase::isValueEmpty	public	function	Checks if a field value is empty. Overrides FieldHandlerInterface::isValueEmpty
FieldPluginBase::label	public	function	Gets this field's label. Overrides FieldHandlerInterface::label
FieldPluginBase::linkGenerator	protected	function	Gets the link generator.
FieldPluginBase::renderAltered	protected	function	Render this field as user-defined altered text.
FieldPluginBase::renderAsLink	protected	function	Render this field as a link, with the info from a fieldset set by the user.
FieldPluginBase::renderText	public	function	Performs an advanced text render for the item. Overrides FieldHandlerInterface::renderText
FieldPluginBase::renderTrimText	protected	function	Trims the field down to the specified length.
FieldPluginBase::RENDER_TEXT_PHASE_COMPLETELY		constant	Indicator of the renderText() method for rendering the whole element. (if no render_item() method is available).
FieldPluginBase::RENDER_TEXT_PHASE_EMPTY		constant	Indicator of the renderText() method for rendering the empty text.
FieldPluginBase::RENDER_TEXT_PHASE_SINGLE_ITEM		constant	Indicator of the renderText() method for rendering a single item. (If no render_item() is present).
FieldPluginBase::submitOptionsForm	public	function	Performs some cleanup tasks on the options array before saving it. Overrides PluginBase::submitOptionsForm	1
FieldPluginBase::theme	public	function	Passes values to drupal_render() using $this->themeFunctions() as #theme. Overrides FieldHandlerInterface::theme
FieldPluginBase::themeFunctions	public	function	Provide a full list of possible theme templates used by this style. Overrides PluginBase::themeFunctions
FieldPluginBase::tokenizeValue	public	function	Replaces a value with tokens from the last field. Overrides FieldHandlerInterface::tokenizeValue
FieldPluginBase::trimText	public static	function	Trims the field down to the specified length.
FieldPluginBase::useStringGroupBy	public	function	Determines if this field will be available as an option to group the result by in the style settings. Overrides FieldHandlerInterface::useStringGroupBy
HandlerBase::$field	public	property	With field you can override the realField if the real field is not set.
HandlerBase::$moduleHandler	protected	property	The module handler.	3
HandlerBase::$query	public	property	Where the $query object will reside:	7
HandlerBase::$realField	public	property	The actual field in the database table, maybe different on other kind of query plugins/special handlers.
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	Check whether given user has access to this handler. Overrides ViewsHandlerInterface::access	4
HandlerBase::breakString	public static	function	Breaks x,y,z and x+y+z into an array. Overrides ViewsHandlerInterface::breakString
HandlerBase::broken	public	function	Determines if the handler is considered 'broken', meaning it's a placeholder used when a handler can't be found. 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.	1
HandlerBase::buildGroupByForm	public	function	Provide a form for aggregation settings.	1
HandlerBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides PluginBase::calculateDependencies	10
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::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::getField	public	function	Shortcut to get a handler's raw field value. Overrides ViewsHandlerInterface::getField
HandlerBase::getJoin	public	function	Get the join object that should be used for this handler. Overrides ViewsHandlerInterface::getJoin
HandlerBase::getModuleHandler	protected	function	Gets the module handler.
HandlerBase::getTableJoin	public static	function	Fetches a handler to join one table to a primary table from the data cache. Overrides ViewsHandlerInterface::getTableJoin
HandlerBase::getViewsData	protected	function	Gets views data service.
HandlerBase::hasExtraOptions	public	function	If a handler has 'extra options' it will get a little settings widget and another form called extra_options.	1
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', meaning it provides form elements to let users modify the view.
HandlerBase::multipleExposedInput	public	function	Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets.	1
HandlerBase::placeholder	protected	function	Provides a unique placeholders for handlers.
HandlerBase::postExecute	public	function	Run after the view is executed, before the result is cached. Overrides ViewsHandlerInterface::postExecute
HandlerBase::preQuery	public	function	Run before the view is built. Overrides ViewsHandlerInterface::preQuery	2
HandlerBase::setModuleHandler	public	function	Sets the module handler.
HandlerBase::setRelationship	public	function	Called just prior to query(), this lets a handler set up any relationship it needs. 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. There is no need for this function to actually store the data.
HandlerBase::submitExtraOptionsForm	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.
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. There is no need for this function to actually store the data.	1
HandlerBase::submitTemporaryForm	public	function	A submit handler that is used for storing temporary items when using multi-step changes, such as ajax requests.
HandlerBase::usesGroupBy	public	function	Provides the handler some groupby.	13
HandlerBase::validate	public	function	Validate that the plugin is correct and can be saved. Overrides PluginBase::validate	2
HandlerBase::validateExposed	public	function	Validate the exposed handler form	4
HandlerBase::validateExposeForm	public	function	Validate the options form.	1
HandlerBase::validateExtraOptionsForm	public	function	Validate the options form.
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	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::$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::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::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::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::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.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
SearchApiBulkForm::calculateEntityBulkFormKey	protected	function	Calculates a bulk form key. Overrides BulkForm::calculateEntityBulkFormKey
SearchApiBulkForm::getCacheContexts	public	function	The cache contexts associated with this object. Overrides BulkForm::getCacheContexts
SearchApiBulkForm::getEntity	public	function	Gets the entity matching the current row and relationship. Overrides SearchApiFieldTrait::getEntity
SearchApiBulkForm::getEntityType	public	function	Determines the entity type used by this handler. Overrides SearchApiHandlerTrait::getEntityType
SearchApiBulkForm::init	public	function	Initialize the plugin. Overrides BulkForm::init
SearchApiBulkForm::loadEntityFromBulkFormKey	protected	function	Loads an entity based on a bulk form key. Overrides BulkForm::loadEntityFromBulkFormKey
SearchApiBulkForm::preRender	public	function	Runs before any fields are rendered. Overrides BulkForm::preRender
SearchApiBulkForm::viewsForm	public	function	Form constructor for the bulk form. Overrides BulkForm::viewsForm
SearchApiBulkForm::viewsFormValidate	public	function	Overrides BulkForm::viewsFormValidate
SearchApiFieldTrait::$accessAccount	protected	property	The account to use for access checks for this search.
SearchApiFieldTrait::$combinedPropertyPath	protected	property	The combined property path of this field.
SearchApiFieldTrait::$datasourceId	protected	property	The datasource ID of this field, if any.
SearchApiFieldTrait::$entityTypeManager	protected	property	The entity type manager.
SearchApiFieldTrait::$fieldsHelper	protected	property	The fields helper.
SearchApiFieldTrait::$overriddenValues	protected	property	Contains overridden values to be returned on the next getValue() call.
SearchApiFieldTrait::$propertyReplacements	protected	property	Array of replacement property paths to use when getting field values.
SearchApiFieldTrait::$retrievedProperties	protected	property	Contains the properties needed by this field handler.
SearchApiFieldTrait::$skipAccessChecks	protected	property	Associative array keyed by property paths for which to skip access checks.
SearchApiFieldTrait::$typedDataManager	protected	property	The typed data manager.
SearchApiFieldTrait::$valueIndex	protected	property	Index in the current row's field values that is currently displayed.
SearchApiFieldTrait::addRetrievedProperty	protected	function	Adds a property to be retrieved.
SearchApiFieldTrait::buildOptionsForm	public	function	Provide a form to edit options for this plugin. Aliased as: ignoreBuildOptionsForm	3
SearchApiFieldTrait::checkEntityAccess	protected	function	Checks whether the searching user has access to the given value.
SearchApiFieldTrait::checkHighlighting	protected	function	Replaces extracted property values with highlighted field values.
SearchApiFieldTrait::clickSort	public	function	Adds an ORDER BY clause to the query for click sort columns.
SearchApiFieldTrait::clickSortable	public	function	Determines if this field is click sortable.
SearchApiFieldTrait::combineHighlightedValues	protected	function	Combines raw field values with highlighted ones to get a complete set.
SearchApiFieldTrait::createCombinedPropertyPath	protected	function	Creates a combined property path.
SearchApiFieldTrait::defineOptions	public	function	Defines the options used by this plugin. Aliased as: ignoreDefineOptions	3
SearchApiFieldTrait::expandRequiredProperties	protected	function	Expands the properties to retrieve for this field.
SearchApiFieldTrait::extractProcessorProperty	protected	function	Extracts a processor-based property from an item.
SearchApiFieldTrait::extractPropertyValues	protected	function	Places extracted property values and objects into the result row.
SearchApiFieldTrait::getCombinedPropertyPath	public	function	Retrieves the combined property path of this field.
SearchApiFieldTrait::getDatasourceId	public	function	Retrieves the ID of the datasource to which this field belongs.
SearchApiFieldTrait::getEntityTypeManager	public	function	Retrieves the entity type manager.
SearchApiFieldTrait::getFieldsHelper	public	function	Retrieves the fields helper.
SearchApiFieldTrait::getItems	public	function	Gets an array of items for the field.	2
SearchApiFieldTrait::getItemUrl	protected	function	Retrieves an alter options array for linking the given value to its item.
SearchApiFieldTrait::getRenderer	abstract protected	function	Returns the Render API renderer.
SearchApiFieldTrait::getTypedDataManager	public	function	Retrieves the typed data manager.
SearchApiFieldTrait::getValue	public	function	Retrieves the value that's supposed to be rendered.
SearchApiFieldTrait::getValuesToExtract	protected	function	Determines and prepares the property values that need to be extracted.
SearchApiFieldTrait::isActiveForRow	protected	function	Determines whether this field is active for the given row.	1
SearchApiFieldTrait::isMultiple	public	function	Determines whether this field can have multiple values.
SearchApiFieldTrait::preLoadResultItems	protected	function	Pre-loads the result objects, where necessary.
SearchApiFieldTrait::preRender	public	function	Runs before any fields are rendered. Aliased as: traitPreRender	1
SearchApiFieldTrait::query	public	function	Add anything to the query that we might need to.	3
SearchApiFieldTrait::renderItems	public	function	Renders all items in this field together.	1
SearchApiFieldTrait::render_item	public	function	Renders a single item of a row.	2
SearchApiFieldTrait::sanitizeValue	public	function	Sanitizes the value for output.
SearchApiFieldTrait::setEntityTypeManager	public	function	Sets the entity type manager.
SearchApiFieldTrait::setFieldsHelper	public	function	Sets the fields helper.
SearchApiFieldTrait::setTypedDataManager	public	function	Sets the typed data manager.
SearchApiHandlerTrait::ensureMyTable	public	function	Overrides the Views handlers' ensureMyTable() method.
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.
UncacheableFieldHandlerTrait::doRender	protected	function	Actually renders the field markup.
UncacheableFieldHandlerTrait::getFieldTokenPlaceholder	abstract protected	function
UncacheableFieldHandlerTrait::postRender	public	function
UncacheableFieldHandlerTrait::render	public	function

You are here

class SearchApiBulkForm in Search API 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation