class NivoSliderSliderBlock in Nivo Slider 8

Provides a 'Slider' block.

Plugin annotation


@Block(
  id = "nivo_slider_slider_block",
  admin_label = @Translation("Slider"),
  category = "nivo_slider"
)

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\nivo_slider\Plugin\Block\NivoSliderSliderBlock

Expanded class hierarchy of NivoSliderSliderBlock

File

src/Plugin/Block/NivoSliderSliderBlock.php, line 25: Contains \Drupal\nivo_slider\Plugin\block\block\NivoSliderSliderBlock.

Namespace

Drupal\nivo_slider\Plugin\Block

View source

class NivoSliderSliderBlock extends BlockBase {

  /**
   * Overrides \Drupal\block\BlockBase::blockAccess().
   */

  //  public function blockAccess() {
  //    return user_access('access content');
  //  }

  /**
   * Implements \Drupal\block\BlockBase::build().
   */
  public function build() {

    // Get the current slider settings.
    $config = \Drupal::getContainer()
      ->get('config.factory')
      ->getEditable('nivo_slider.settings');
    $build = [
      '#type' => 'markup',
      '#theme' => 'nivo_slider_wrapper',
      '#attached' => [
        'drupalSettings' => [
          'nivo_slider' => [
            'effect' => $config
              ->get('options.effect') ? Html::escape($config
              ->get('options.effect')) : 'random',
            'slices' => $config
              ->get('options.slices') ? (int) Html::escape($config
              ->get('options.slices')) : 15,
            'boxCols' => $config
              ->get('options.box_columns') ? (int) Html::escape($config
              ->get('options.box_columns')) : 8,
            'boxRows' => $config
              ->get('options.box_rows') ? (int) Html::escape($config
              ->get('options.box_rows')) : 4,
            'animSpeed' => $config
              ->get('options.animation_speed') ? (int) Html::escape($config
              ->get('options.animation_speed')) : 500,
            'pauseTime' => $config
              ->get('options.pause_time') ? (int) Html::escape($config
              ->get('options.pause_time')) : 3000,
            'startSlide' => $config
              ->get('options.start_slide') ? (int) Html::escape($config
              ->get('options.start_slide')) : 0,
            'directionNav' => Html::escape($config
              ->get('options.directional_navigation')) == 1 ? TRUE : FALSE,
            'controlNav' => Html::escape($config
              ->get('options.control_navigation')) == 1 ? TRUE : FALSE,
            'controlNavThumbs' => Html::escape($config
              ->get('options.control_nav_thumbs')) == 1 ? TRUE : FALSE,
            'pauseOnHover' => Html::escape($config
              ->get('options.pause_on_hover')) == 1 ? TRUE : FALSE,
            'manualAdvance' => Html::escape($config
              ->get('options.manual_advance')) == 1 ? TRUE : FALSE,
            'prevText' => $config
              ->get('options.previous_text') ? Html::escape($config
              ->get('options.previous_text')) : t('Prev')
              ->render(),
            'nextText' => $config
              ->get('options.next_text') ? Html::escape($config
              ->get('options.next_text')) : t('Next')
              ->render(),
            'randomStart' => Html::escape($config
              ->get('options.random_start')) == 1 ? TRUE : FALSE,
          ],
        ],
        'library' => [
          'nivo_slider/nivo.slider',
        ],
      ],
    ];

    // Collect all themes.
    $themes = \Drupal::moduleHandler()
      ->invokeAll('nivo_slider_theme_info');

    // Allow theme information to be altered.
    \Drupal::moduleHandler()
      ->alter('nivo_slider_theme_info', $themes);

    // Find the currently selected theme.
    $current_theme = $config
      ->get('options.theme');

    // Get the current theme's settings.
    $theme = $themes[$current_theme];

    // Add the theme's resources.
    foreach ([
      'js',
      'css',
    ] as $type) {
      if (!empty($theme['resources'][$type])) {
        foreach ($theme['resources'][$type] as $file_path) {
          $build['content']['#attached'][$type][] = $file_path;
        }
      }
    }
    return $build;
  }

}

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
BlockPluginTrait::__construct	public	function		22
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.
NivoSliderSliderBlock::build	public	function	Implements \Drupal\block\BlockBase::build(). Overrides BlockPluginInterface::build
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.
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 NivoSliderSliderBlock in Nivo Slider 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation