You are here

Home » API reference » Flag Search API 8 » UserFlagWidget.php

class UserFlagWidget in Flag Search API 8

The user_flag widget.

Plugin annotation


@FacetsWidget(
  id = "user_flag",
  label = @Translation("User Flags"),
  description = @Translation("A simple widget that shows a single checkbox of a user's flagged content by Flag Search API"),
)

Hierarchy

Expanded class hierarchy of UserFlagWidget

File

src/Plugin/facets/widget/UserFlagWidget.php, line 21

Namespace

Drupal\flag_search_api\Plugin\facets\widget
View source 
class UserFlagWidget extends WidgetPluginBase implements ContainerFactoryPluginInterface {

  /**
   * AccountProxy.
   *
   * @var \Drupal\Core\Session\AccountProxy
   */
  protected $currentUser;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, $current_user) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->currentUser = $current_user;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('current_user'));
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'flags_label' => "My Flagged Items",
      'no_flags_label' => "No Flagged Items Available",
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function build(FacetInterface $facet) {

    // Get current user ID.
    $uid = $this->currentUser
      ->id();
    $userFlagResult = FALSE;

    // Get results.
    $results = $facet
      ->getResults();
    foreach ($results as $result) {

      // Select a result that matches the current user.
      if ($result
        ->getRawValue() == $uid) {
        $userFlagResult = $result;
        $userFlagResult
          ->setDisplayValue($this
          ->getConfiguration()['flags_label']);
      }
    }
    if ($userFlagResult) {

      // Replace all results with the selected result.
      $facet
        ->setResults([
        $userFlagResult,
      ]);
    }
    else {

      // Replace all results with an empty result.
      $emptyResult = new Result($facet, $uid, $this
        ->getConfiguration()['no_flags_label'], 0);
      $facet
        ->setResults([
        $emptyResult,
      ]);
    }

    // Go through normal build process with checkboxes.
    $build = parent::build($facet);
    $build['#attributes']['class'][] = 'js-facets-checkbox-links';
    $build['#attached']['library'][] = 'facets/drupal.facets.checkbox-widget';
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state, FacetInterface $facet) {
    $form = parent::buildConfigurationForm($form, $form_state, $facet);
    $form['flags_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Flags label'),
      '#description' => $this
        ->t('This text will be used for the flags checkbox label.'),
      '#default_value' => $this
        ->getConfiguration()['flags_label'],
    ];
    $form['no_flags_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('No Flags label'),
      '#description' => $this
        ->t("This text will be used when there aren't any matching flags."),
      '#default_value' => $this
        ->getConfiguration()['no_flags_label'],
    ];
    return $form;
  }

}

Members

Namesort descending 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
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.
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.
UserFlagWidget::$currentUser protected property AccountProxy.
UserFlagWidget::build public function Builds the facet widget for rendering. Overrides WidgetPluginBase::build
UserFlagWidget::buildConfigurationForm public function Provides a configuration form for this widget. Overrides WidgetPluginBase::buildConfigurationForm
UserFlagWidget::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
UserFlagWidget::defaultConfiguration public function Gets default configuration for this plugin. Overrides WidgetPluginBase::defaultConfiguration
UserFlagWidget::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides WidgetPluginBase::__construct
WidgetPluginBase::$facet protected property The facet the widget is being built for.
WidgetPluginBase::$showNumbers protected property Show the amount of results next to the result.
WidgetPluginBase::buildListItems protected function Builds a renderable array of result items. 1
WidgetPluginBase::buildResultItem protected function Builds a facet result item.
WidgetPluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
WidgetPluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
WidgetPluginBase::getFacetItemListThemeHook protected function Provides a full array of possible theme functions to try for a given hook.
WidgetPluginBase::getQueryType public function Picks the preferred query type for this widget. Overrides WidgetPluginInterface::getQueryType 3
WidgetPluginBase::isPropertyRequired public function Checks is a specific property is required for this widget. Overrides WidgetPluginInterface::isPropertyRequired 2
WidgetPluginBase::prepareLink protected function Returns the text or link for an item.
WidgetPluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
WidgetPluginBase::supportsFacet public function Checks if the facet is supported by this processor. Overrides WidgetPluginInterface::supportsFacet 1