You are here

Home » API reference » Floating Menu 8 » FloatingMenuBlock.php

class FloatingMenuBlock in Floating Menu 8

Provides a menu block

Plugin annotation


@Block(
  id = "floating_menu_block",
  admin_label = @Translation("Floating Menu"),
)

Hierarchy

Expanded class hierarchy of FloatingMenuBlock

File

src/Plugin/Block/FloatingMenuBlock.php, line 20

Namespace

Drupal\floating_menu\Plugin\Block
View source 
class FloatingMenuBlock extends BlockBase implements BlockPluginInterface {

  /**
   * {@inheritdoc}
   */
  public function build() {
    $config = $this
      ->getConfiguration();
    $max_items = $config['count_of_items'];
    if (empty($max_items)) {
      $max_items = 5;
    }
    $menu_item_variables = [];
    for ($i = 0; $i < $max_items; $i++) {
      $untranslated_url = $config['menu_item'][$i]['menu_item_target_url'];
      if (!empty($untranslated_url) && substr($untranslated_url, 0, 1) == '/') {
        $langManager = \Drupal::service('language_manager');
        $path = \Drupal::service('path.alias_manager')
          ->getPathByAlias($untranslated_url, 'fi');
        $translated_url = \Drupal::service('path.alias_manager')
          ->getAliasByPath($path, $langManager
          ->getCurrentLanguage()
          ->getId());
        if ($langManager
          ->getCurrentLanguage()
          ->getId() != $langManager
          ->getDefaultLanguage()
          ->getId()) {
          $translated_url = '/' . $langManager
            ->getCurrentLanguage()
            ->getId() . $translated_url;
        }
      }
      else {
        $translated_url = $untranslated_url;
      }
      if (!empty($config['menu_item'][$i]['menu_item_icon_url'])) {
        $menu_item_variables[] = [
          'popup_html' => [
            '#markup' => $config['menu_item'][$i]['menu_item_popup_html']['value'],
          ],
          'url' => $translated_url,
          'icon_url' => $config['menu_item'][$i]['menu_item_icon_url'],
        ];
      }
    }
    return array(
      '#theme' => 'floating_menu_block',
      '#attached' => array(
        'library' => array(
          'floating_menu/floating-menu',
        ),
      ),
      '#menu_items' => $menu_item_variables,
    );
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form = parent::blockForm($form, $form_state);
    $config = $this
      ->getConfiguration();
    $form['count_of_items'] = [
      '#type' => 'number',
      '#title' => t('Menu item count'),
      '#description' => t('Select how many items to show in the menu. Save the form and enter details.'),
      '#default_value' => $config['count_of_items'],
    ];
    $form['menu_items'] = [
      '#type' => 'fieldset',
      '#title' => t('Menu Items'),
      '#prefix' => '<div id="menu-item-fieldset-wrapper">',
      '#suffix' => '</div>',
    ];
    $max_items = $config['count_of_items'];
    if (empty($max_items)) {
      $max_items = 5;
    }
    for ($i = 0; $i < $max_items; $i++) {
      $form['menu_items']['menu_item_' . $i] = [
        '#type' => 'fieldset',
        '#title' => t('Menu Item ' . ($i + 1)),
        '#tree' => TRUE,
      ];
      $form['menu_items']['menu_item_' . $i]['menu_item_popup_html'] = [
        '#type' => 'text_format',
        '#format' => 'full_html',
        '#title' => $this
          ->t('Menu Item Popup HTML'),
        '#default_value' => !empty($config['menu_item']) ? $config['menu_item'][$i]['menu_item_popup_html']['value'] : '',
      ];
      $form['menu_items']['menu_item_' . $i]['menu_item_target_url'] = [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Menu Item Target URL'),
        '#default_value' => !empty($config['menu_item']) ? $config['menu_item'][$i]['menu_item_target_url'] : '',
      ];
      $form['menu_items']['menu_item_' . $i]['menu_item_icon'] = [
        '#type' => 'managed_file',
        '#title' => t('Menu Item Icon'),
        '#upload_validators' => array(
          'file_validate_is_image' => array(),
          'file_validate_extensions' => array(
            'jpg jpeg png gif',
          ),
        ),
        '#upload_location' => 'public://',
        '#default_value' => !empty($config['menu_item']) ? [
          $config['menu_item'][$i]['menu_item_icon_file_id'],
        ] : '',
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $form_state_values = $form_state
      ->getValues();
    $this->configuration['count_of_items'] = $form_state_values['count_of_items'];
    $this->configuration['menu_item'] = [];
    foreach ($form_state_values['menu_items'] as $key => $value) {
      $file = File::load($value['menu_item_icon'][0]);
      if (!empty($file)) {
        $file
          ->setPermanent();
        $file
          ->save();
        $image_url = file_create_url($file
          ->getFileUri());
      }
      else {
        $image_url = NULL;
      }
      $this->configuration['menu_item'][] = [
        'menu_item_popup_html' => $value['menu_item_popup_html'],
        'menu_item_target_url' => $value['menu_item_target_url'],
        'menu_item_icon_file_id' => intval($value['menu_item_icon'][0]),
        'menu_item_icon_url' => $image_url,
      ];
    }
  }

}

Members

Namesort descending 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::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
FloatingMenuBlock::blockForm public function Returns the configuration form elements specific to this block plugin. Overrides BlockPluginTrait::blockForm
FloatingMenuBlock::blockSubmit public function Adds block type-specific submission handling for the block form. Overrides BlockPluginTrait::blockSubmit
FloatingMenuBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
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.
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