class Styleswitcher in Style Switcher 8.2

Same name and namespace in other branches

3.0.x src/Plugin/Block/Styleswitcher.php \Drupal\styleswitcher\Plugin\Block\Styleswitcher

Provides the Style Switcher block.

Plugin annotation


@Block(
  id = "styleswitcher_styleswitcher",
  admin_label = @Translation("Style Switcher")
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
  - class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
    class \Drupal\Core\Block\BlockBase implements BlockPluginInterface, PluginWithFormsInterface, PreviewFallbackInterface uses BlockPluginTrait, ContextAwarePluginAssignmentTrait
    class \Drupal\styleswitcher\Plugin\Block\Styleswitcher implements ContainerFactoryPluginInterface

Expanded class hierarchy of Styleswitcher

File

src/Plugin/Block/Styleswitcher.php, line 22

Namespace

Drupal\styleswitcher\Plugin\Block

View source

class Styleswitcher extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * The theme manager.
   *
   * @var \Drupal\Core\Theme\ThemeManagerInterface
   */
  protected $themeManager;

  /**
   * The Redirect Destination service.
   *
   * @var \Drupal\Core\Routing\RedirectDestinationInterface
   */
  protected $redirectDestination;

  /**
   * Configuration factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * Constructs a new Styleswitcher.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Theme\ThemeManagerInterface $theme_manager
   *   The theme manager.
   * @param \Drupal\Core\Routing\RedirectDestinationInterface $redirect_destination
   *   The Redirect Destination service.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   Configuration factory.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ThemeManagerInterface $theme_manager, RedirectDestinationInterface $redirect_destination, ConfigFactoryInterface $config_factory) {
    $this->themeManager = $theme_manager;
    $this->redirectDestination = $redirect_destination;
    $this->configFactory = $config_factory;
    parent::__construct($configuration, $plugin_id, $plugin_definition);
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('theme.manager'), $container
      ->get('redirect.destination'), $container
      ->get('config.factory'));
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $block = [];
    $theme = $this->themeManager
      ->getActiveTheme()
      ->getName();

    // List of styles a user can switch between.
    $styles = styleswitcher_style_load_multiple($theme, [
      'status' => TRUE,
    ]);

    // Do not display block if there is only one style (no alternatives).
    if (count($styles) > 1) {
      uasort($styles, 'styleswitcher_sort');
      $links = [];
      $destination = $this->redirectDestination
        ->getAsArray();
      foreach ($styles as $name => $style) {
        $name_hyphenated = strtr($name, '_', '-');
        $name_parts = explode('/', $name_hyphenated);
        $class = [
          'style-switcher',
          $name_parts[0] . '-style',
          'style-' . $name_parts[1],
        ];
        $route_params = [
          'theme' => $theme,
          'type' => $name_parts[0],
          'style' => $name_parts[1],
        ];
        $options = [
          'query' => $destination,
          'attributes' => [
            'class' => $class,
            'data-rel' => $name,
            'rel' => 'nofollow',
          ],
        ];
        $links[] = Link::fromTextAndUrl($style['label'], Url::fromRoute('styleswitcher.switch', $route_params, $options));

        // Make paths absolute for JS.
        if (isset($style['path'])) {
          $styles[$name]['path'] = file_create_url($style['path']);
        }
        else {
          $styles[$name]['path'] = Url::fromRoute('styleswitcher.css', [
            'theme' => $theme,
          ], [
            'absolute' => TRUE,
          ])
            ->toString();
        }
      }
      $js_settings = [
        'styleSwitcher' => [
          'styles' => $styles,
          'default' => styleswitcher_default_style_key($theme),
          'enableOverlay' => $this->configFactory
            ->get('styleswitcher.settings')
            ->get('enable_overlay'),
          'cookieExpire' => STYLESWITCHER_COOKIE_EXPIRE,
          'theme' => $theme,
        ],
      ];
      $attached['library'][] = 'styleswitcher/styleswitcher';
      $attached['drupalSettings'] = $js_settings;
      $block = [
        '#theme' => 'item_list',
        '#items' => $links,
        '#attached' => $attached,
        '#cache' => [
          // We cannot cache globally, because we use drupal_get_destination()
          // with links in block, which is different from page to page. And we
          // cannot avoid using destination, because in this case site users
          // with JS-disabled browsers won't go back to the same page they were
          // at, but will go to the front page each time. We also cannot rely on
          // $_SERVER['HTTP_REFERER'], because it can be empty.
          'contexts' => [
            'theme',
            'url',
          ],
          'tags' => [
            'config:styleswitcher.settings',
            'config:styleswitcher.custom_styles',
            'config:styleswitcher.styles_settings',
          ],
        ],
      ];
    }
    else {
      $block['#cache'] = [
        'contexts' => [
          'theme',
        ],
        'tags' => [
          'config:styleswitcher.custom_styles',
          'config:styleswitcher.styles_settings',
        ],
      ];
    }
    return $block;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BlockPluginInterface::BLOCK_LABEL_VISIBLE		constant	Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$transliteration	protected	property	The transliteration service.
BlockPluginTrait::access	public	function
BlockPluginTrait::baseConfigurationDefaults	protected	function	Returns generic default configuration for block plugins.
BlockPluginTrait::blockAccess	protected	function	Indicates whether the block should be shown.	16
BlockPluginTrait::blockForm	public	function		16
BlockPluginTrait::blockSubmit	public	function		13
BlockPluginTrait::blockValidate	public	function		3
BlockPluginTrait::buildConfigurationForm	public	function	Creates a generic configuration form for all block types. Individual block plugins can add elements to this form by overriding BlockBase::blockForm(). Most block plugins should not override this method unless they need to alter the generic form elements.	2
BlockPluginTrait::calculateDependencies	public	function
BlockPluginTrait::defaultConfiguration	public	function		19
BlockPluginTrait::getConfiguration	public	function		1
BlockPluginTrait::getMachineNameSuggestion	public	function		1
BlockPluginTrait::getPreviewFallbackString	public	function		3
BlockPluginTrait::label	public	function
BlockPluginTrait::setConfiguration	public	function
BlockPluginTrait::setConfigurationValue	public	function
BlockPluginTrait::setTransliteration	public	function	Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm	public	function	Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration	protected	function	Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm	public	function	Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate().	1
ContextAwarePluginAssignmentTrait::addContextAssignmentElement	protected	function	Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler	protected	function	Wraps the context handler.
ContextAwarePluginBase::$context	protected	property	The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated	private	property	Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::createContextFromConfiguration	protected	function	Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts	9
ContextAwarePluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge	7
ContextAwarePluginBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags	4
ContextAwarePluginBase::getContext	public	function	This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition	public	function	Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions	public	function	Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping	public	function	Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts	public	function	Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue	public	function	Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues	public	function	Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext	public	function	Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping	public	function	Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue	public	function	Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts	public	function	Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get	public	function	Implements magic __get() method.
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.
PluginWithFormsTrait::getFormClass	public	function
PluginWithFormsTrait::hasFormClass	public	function
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.
Styleswitcher::$configFactory	protected	property	Configuration factory.
Styleswitcher::$redirectDestination	protected	property	The Redirect Destination service.
Styleswitcher::$themeManager	protected	property	The theme manager.
Styleswitcher::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
Styleswitcher::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
Styleswitcher::__construct	public	function	Constructs a new Styleswitcher. Overrides BlockPluginTrait::__construct
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2

You are here

class Styleswitcher in Style Switcher 8.2

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation