class CountBlock in Basic cart 8.6

Same name and namespace in other branches

8.2 src/Plugin/Block/CountBlock.php \Drupal\basic_cart\Plugin\Block\CountBlock
8.3 src/Plugin/Block/CountBlock.php \Drupal\basic_cart\Plugin\Block\CountBlock
8.4 src/Plugin/Block/CountBlock.php \Drupal\basic_cart\Plugin\Block\CountBlock
8.5 src/Plugin/Block/CountBlock.php \Drupal\basic_cart\Plugin\Block\CountBlock

Provides a 'Basic Cart Count' block.

Plugin annotation


@Block(
  id = "basic_cart_countblock",
  admin_label = @Translation("Basic Cart Count Block")
)

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\basic_cart\Plugin\Block\CountBlock

Expanded class hierarchy of CountBlock

File

src/Plugin/Block/CountBlock.php, line 18

Namespace

Drupal\basic_cart\Plugin\Block

View source

class CountBlock extends BlockBase {

  /**
   * {@inheritdoc}
   */
  public function build() {
    $config = $this
      ->getConfiguration();
    $render = array(
      '#theme' => 'basic_cart_count_block',
      '#cartcount' => Utility::cartCount(),
      '#cache' => array(
        'max-age' => 0,
      ),
    );
    if ($config['float']) {
      $render['#float'] = Html::escape($config['float']);
    }
    if ($config['size']) {
      $render['#size'] = Html::escape($config['size']);
      $render['#size_class'] = "-" . str_replace("x", "-", Html::escape($config['size']));
      $css = str_replace("x", "", Html::escape($config['size']));
    }
    if ($config['top']) {
      $render['#top'] = Html::escape($config['top']) . 'px';
    }
    if ($config['bottom']) {
      $render['#bottom'] = Html::escape($config['bottom']) . 'px';
    }
    if ($config['left']) {
      $render['#left'] = Html::escape($config['left']) . 'px';
    }
    if ($config['right']) {
      $render['#right'] = Html::escape($config['right']) . 'px';
    }
    if (!$css) {
      $css = "4839";
    }
    $render['#attached']['library'][] = 'basic_cart/' . $css;
    return $render;
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form = parent::blockForm($form, $form_state);
    $config = $this
      ->getConfiguration();
    $form['size'] = array(
      '#type' => 'select',
      '#options' => [
        '32x26' => '32x26',
        '48x39' => '48x39',
        '128x105' => '128x105',
        '64x52' => '64x52',
      ],
      '#title' => $this
        ->t('Cart Icon Size'),
      '#description' => $this
        ->t('Cart icon size'),
      '#default_value' => isset($config['size']) ? $config['size'] : '48x29',
    );
    $form['float'] = array(
      '#type' => 'select',
      '#options' => [
        'none' => 'none',
        'right' => 'right',
        'left' => 'left',
      ],
      '#title' => $this
        ->t('Float'),
      '#description' => $this
        ->t('Cart icon floated to right or left'),
      '#default_value' => isset($config['float']) ? $config['float'] : '',
    );
    $form['top'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Top'),
      '#description' => $this
        ->t('Top positon value in pixel'),
      '#default_value' => isset($config['top']) ? $config['top'] : '',
      '#size' => 3,
    );
    $form['bottom'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Bottom'),
      '#description' => $this
        ->t('Bottom positon value in pixel'),
      '#default_value' => isset($config['bottom']) ? $config['bottom'] : '',
      '#size' => 3,
    );
    $form['left'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Left'),
      '#description' => $this
        ->t('Left positon value in pixel'),
      '#default_value' => isset($config['left']) ? $config['left'] : '',
      '#size' => 3,
    );
    $form['right'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Right'),
      '#description' => $this
        ->t('Right positon value in pixel'),
      '#default_value' => isset($config['right']) ? $config['right'] : '',
      '#size' => 3,
    );
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    parent::blockSubmit($form, $form_state);
    $values = $form_state
      ->getValues();
    $this->configuration['float'] = $values['float'];
    $this->configuration['top'] = $values['top'];
    $this->configuration['bottom'] = $values['bottom'];
    $this->configuration['left'] = $values['left'];
    $this->configuration['right'] = $values['right'];
    $this->configuration['size'] = $values['size'];
  }

}

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::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.
CountBlock::blockForm	public	function	Overrides BlockPluginTrait::blockForm
CountBlock::blockSubmit	public	function	Overrides BlockPluginTrait::blockSubmit
CountBlock::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
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.
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 CountBlock in Basic cart 8.6

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation