You are here

class MobileDeviceDetectionExtenderPlugin in Mobile Device Detection 8

Same name and namespace in other branches
  1. 8.3 src/Plugin/views/display_extender/MobileDeviceDetectionExtenderPlugin.php \Drupal\mobile_device_detection\Plugin\views\display_extender\MobileDeviceDetectionExtenderPlugin
  2. 8.2 src/Plugin/views/display_extender/MobileDeviceDetectionExtenderPlugin.php \Drupal\mobile_device_detection\Plugin\views\display_extender\MobileDeviceDetectionExtenderPlugin

Default display extender plugin; does nothing.

Plugin annotation


@ViewsDisplayExtender(
  id = "mobile_device_detection",
  title = @Translation("Mobile device detection display extender"),
  help = @Translation("Mobile device detection settings for this view."),
  no_ui = TRUE
)

Hierarchy

Expanded class hierarchy of MobileDeviceDetectionExtenderPlugin

1 string reference to 'MobileDeviceDetectionExtenderPlugin'
mobile_device_detection.services.yml in ./mobile_device_detection.services.yml
mobile_device_detection.services.yml
1 service uses MobileDeviceDetectionExtenderPlugin
object.mdd.plugin_extender in ./mobile_device_detection.services.yml
Drupal\mobile_device_detection\Plugin\views\display_extender\MobileDeviceDetectionExtenderPlugin

File

src/Plugin/views/display_extender/MobileDeviceDetectionExtenderPlugin.php, line 21

Namespace

Drupal\mobile_device_detection\Plugin\views\display_extender
View source
class MobileDeviceDetectionExtenderPlugin extends DisplayExtenderPluginBase {

  /**
   * Provide the key options for this plugin.
   */
  public function defineOptionsAlter(&$options) {
    $options['device_detection'] = array(
      'contains' => array(
        'title' => array(
          'default' => '',
        ),
        'description' => array(
          'default' => '',
        ),
      ),
    );
  }

  /**
   * Provide the default summary for options and category in the views UI.
   */
  public function optionsSummary(&$categories, &$options) {
    $categories['device_detection'] = array(
      'title' => $this
        ->t('Show "View" on special devices'),
      'column' => 'second',
    );
    $options['device_detection'] = array(
      'category' => 'other',
      'title' => $this
        ->t('Show "View" on special devices'),
      'value' => $this
        ->getDevices() ? implode(', ', $this
        ->getDevices()) : $this
        ->t('none'),
    );
  }

  /**
   * Provide a form to edit options for this plugin.
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    if ($form_state
      ->get('section') == 'device_detection') {
      $form['#title'] .= $this
        ->t('Show "View" on special devices');
      $form['device_detection']['#type'] = 'container';
      $form['device_detection']['#tree'] = TRUE;
      $form['device_detection']['devices'] = array(
        '#type' => 'checkboxes',
        '#options' => [
          'mobile' => $this
            ->t('Mobile'),
          'tablet' => $this
            ->t('Tablet'),
          'desktop' => $this
            ->t('Desktop'),
        ],
        '#default_value' => $this
          ->getDevices() ? $this
          ->getDevices() : [],
        '#title' => $this
          ->t('Select device'),
      );
    }
  }

  /**
   * Validate the options form.
   */
  public function validateOptionsForm(&$form, FormStateInterface $form_state) {
  }

  /**
   * Handle any special handling on the validate form.
   */
  public function submitOptionsForm(&$form, FormStateInterface $form_state) {
    if ($form_state
      ->get('section') == 'device_detection') {
      $device_detection = $form_state
        ->getValue('device_detection');
      $this->options['device_detection'] = $device_detection;
    }
  }

  /**
   * Set up any variables on the view prior to execution.
   */
  public function preExecute() {
  }

  /**
   * Inject anything into the query that the display_extender handler needs.
   */
  public function query() {
  }

  /**
   * Static member function to list which sections are defaultable
   * and what items each section contains.
   */
  public function defaultableSections(&$sections, $section = NULL) {
  }

  /**
   * Get the selected devices for this display.
   *
   * @return array
   */
  public function getDevices() {
    $devices = isset($this->options['device_detection']) ? $this->options['device_detection'] : null;
    if ($devices && isset($devices['devices'])) {
      $devices = array_filter($devices['devices'], function ($var) {
        return $var != false;
      });
    }
    return $devices;
  }

}

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.
MobileDeviceDetectionExtenderPlugin::buildOptionsForm public function Provide a form to edit options for this plugin. Overrides DisplayExtenderPluginBase::buildOptionsForm
MobileDeviceDetectionExtenderPlugin::defaultableSections public function Static member function to list which sections are defaultable and what items each section contains. Overrides DisplayExtenderPluginBase::defaultableSections
MobileDeviceDetectionExtenderPlugin::defineOptionsAlter public function Provide the key options for this plugin. Overrides DisplayExtenderPluginBase::defineOptionsAlter
MobileDeviceDetectionExtenderPlugin::getDevices public function Get the selected devices for this display.
MobileDeviceDetectionExtenderPlugin::optionsSummary public function Provide the default summary for options and category in the views UI. Overrides DisplayExtenderPluginBase::optionsSummary
MobileDeviceDetectionExtenderPlugin::preExecute public function Set up any variables on the view prior to execution. Overrides DisplayExtenderPluginBase::preExecute
MobileDeviceDetectionExtenderPlugin::query public function Inject anything into the query that the display_extender handler needs. Overrides DisplayExtenderPluginBase::query
MobileDeviceDetectionExtenderPlugin::submitOptionsForm public function Handle any special handling on the validate form. Overrides DisplayExtenderPluginBase::submitOptionsForm
MobileDeviceDetectionExtenderPlugin::validateOptionsForm public function Validate the options form. Overrides DisplayExtenderPluginBase::validateOptionsForm
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::$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::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 14
PluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 62
PluginBase::defineOptions protected function Information about options for all kinds of purposes will be held here. 18
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::init public function Initialize the plugin. Overrides ViewsPluginInterface::init 8
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.
PluginBase::__construct public function Constructs a PluginBase object. Overrides PluginBase::__construct
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.