class CartButtonBlock in Commerce Cart Blocks 8

Provides a cart block.

Plugin annotation


@Block(
  id = "commerce_cart_blocks_button",
  admin_label = @Translation("Cart button"),
  category = @Translation("Commerce cart blocks")
)

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\commerce_cart_blocks\Plugin\Block\CartBlockBase implements ContainerFactoryPluginInterface
    class \Drupal\commerce_cart_blocks\Plugin\Block\CartBlock
    class \Drupal\commerce_cart_blocks\Plugin\Block\CartButtonBlock

Expanded class hierarchy of CartButtonBlock

File

src/Plugin/Block/CartButtonBlock.php, line 17

Namespace

Drupal\commerce_cart_blocks\Plugin\Block

View source

class CartButtonBlock extends CartBlock {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $defaultConfig = [
      'dropdown' => TRUE,
      'button_label' => '@items',
      'icon_type' => 'image',
      'icon_class' => 'fa fa-shopping-cart',
    ];
    return array_merge(parent::defaultConfiguration(), $defaultConfig);
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form = parent::blockForm($form, $form_state);
    $form['commerce_cart_dropdown'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display cart contents in a dropdown'),
      '#default_value' => $this->configuration['dropdown'],
    ];
    $form['button_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Button label'),
      '#description' => $this
        ->t('The text to show on the button, optionally using the @items and @total placeholders.'),
      '#default_value' => $this->configuration['button_label'],
    ];
    $form['icon_type'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Icon type'),
      '#description' => $this
        ->t('Select the type of icon to display, if any.'),
      '#default_value' => $this->configuration['icon_type'],
      '#options' => [
        'image' => $this
          ->t('Image'),
        'class' => $this
          ->t('Icon class'),
        '' => $this
          ->t('No icon'),
      ],
    ];
    $form['icon_class'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Icon class'),
      '#description' => $this
        ->t('If using the Class icon type, these are the CSS classes that will be applied.'),
      '#default_value' => $this->configuration['icon_class'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $this->configuration['dropdown'] = $form_state
      ->getValue('commerce_cart_dropdown');
    $this->configuration['button_label'] = $form_state
      ->getValue('button_label');
    $this->configuration['icon_type'] = $form_state
      ->getValue('icon_type');
    $this->configuration['icon_class'] = $form_state
      ->getValue('icon_class');
    parent::blockSubmit($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    if ($this
      ->shouldHide()) {
      return [];
    }
    $content = [];
    if ($this->configuration['dropdown']) {
      $content = [
        '#theme' => 'commerce_cart_blocks_cart',
        '#count' => $this
          ->getCartCount(),
        '#heading' => $this
          ->buildHeading(),
        '#content' => $this
          ->getCartViews(),
        '#links' => $this
          ->buildLinks(),
      ];
    }
    return [
      '#attached' => [
        'library' => $this
          ->getLibraries(),
      ],
      '#theme' => 'commerce_cart_blocks_cart_button',
      '#count' => $this
        ->getCartCount(),
      '#button_label' => $this
        ->getButtonLabel(),
      '#in_cart' => $this
        ->isInCart(),
      '#icon' => $this
        ->buildIcon(),
      '#url' => Url::fromRoute('commerce_cart.page')
        ->toString(),
      '#content' => $content,
      '#cache' => $this
        ->buildCache(),
    ];
  }

  /**
   * Builds the icon output.
   */
  private function buildIcon() {
    $iconType = $this->configuration['icon_type'];
    return $iconType === 'image' ? $this
      ->getIconImage() : $this
      ->getIconTag();
  }

  /**
   * Gets the image for the icon.
   */
  private function getIconImage() {
    return [
      '#theme' => 'image',
      '#uri' => drupal_get_path('module', 'commerce') . '/icons/ffffff/cart.png',
      '#alt' => $this
        ->t('Shopping cart'),
    ];
  }

  /**
   * Gets the HTML tag used for the icon as markup.
   */
  private function getIconTag() {
    $iconType = $this->configuration['icon_type'];
    return [
      '#type' => 'markup',
      '#markup' => $iconType === 'class' ? '<i class="' . $this->configuration['icon_class'] . '"></i>' : '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function getLibraries() {
    return [
      'commerce_cart_blocks/commerce_cart_blocks_cart',
      'commerce_cart_blocks/commerce_cart_blocks_button',
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function getCartViews() {
    $cartViews = [];
    if ($this->configuration['dropdown']) {
      $cartViews = parent::getCartViews();
    }
    return $cartViews;
  }

  /**
   * Gets the text representation of the count of items.
   */
  protected function getButtonLabel() {
    $buttonLabel = $this->configuration['button_label'];
    return str_replace([
      '@items',
      '@total',
    ], [
      $this
        ->getCountText(),
      $this
        ->getTotalText(),
    ], $buttonLabel);
  }

}

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::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
CartBlock::buildHeading	protected	function
CartBlock::buildItems	protected	function
CartBlockBase::$cartProvider	protected	property	The cart provider.
CartBlockBase::$entityTypeManager	protected	property	The entity type manager.
CartBlockBase::buildCache	protected	function
CartBlockBase::buildLinks	protected	function
CartBlockBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
CartBlockBase::createPrice	protected	function
CartBlockBase::getAvailableViews	private	function
CartBlockBase::getCacheabilityMetadata	protected	function
CartBlockBase::getCacheMaxAge	public	function	@todo Find proper cache tags to make this cacheable Overrides ContextAwarePluginBase::getCacheMaxAge
CartBlockBase::getCartCount	protected	function
CartBlockBase::getCarts	protected	function
CartBlockBase::getCountText	protected	function	Gets the text representation of the count of items.
CartBlockBase::getOrderTypeIds	private	function
CartBlockBase::getTotal	protected	function	Gets the total price of the carts.
CartBlockBase::getTotalText	protected	function	Gets the total price as a formatted string.
CartBlockBase::isInCart	protected	function
CartBlockBase::shouldHide	protected	function
CartBlockBase::__construct	public	function	Constructs a new CartBlock. Overrides BlockPluginTrait::__construct
CartButtonBlock::blockForm	public	function	Overrides CartBlock::blockForm
CartButtonBlock::blockSubmit	public	function	Overrides CartBlock::blockSubmit
CartButtonBlock::build	public	function	Builds the cart block. Overrides CartBlock::build
CartButtonBlock::buildIcon	private	function	Builds the icon output.
CartButtonBlock::defaultConfiguration	public	function	Overrides CartBlock::defaultConfiguration
CartButtonBlock::getButtonLabel	protected	function	Gets the text representation of the count of items.
CartButtonBlock::getCartViews	protected	function	Gets the cart views for each cart. Overrides CartBlockBase::getCartViews
CartButtonBlock::getIconImage	private	function	Gets the image for the icon.
CartButtonBlock::getIconTag	private	function	Gets the HTML tag used for the icon as markup.
CartButtonBlock::getLibraries	protected	function	Overrides CartBlock::getLibraries
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::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.
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 CartButtonBlock in Commerce Cart Blocks 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation