class AjaxCartHelper in Ajax Add to Cart 8

Class AjaxCartHelper.

@package Drupal\modules\ajax_add_to_cart

Hierarchy

• class \Drupal\ajax_add_to_cart\Helper\AjaxCartHelper

1 file declares its use of AjaxCartHelper

ajax_add_to_cart.module in ./ajax_add_to_cart.module

Contains ajax_add_to_cart.module.

File

src/Helper/AjaxCartHelper.php, line 16

Namespace

Drupal\ajax_add_to_cart\Helper

class AjaxCartHelper {

  /**
   * Keep class object.
   *
   * @var object
   */
  public static $helper = NULL;

  /**
   * Protected cartBlock variable.
   *
   * @var cartBlock
   */
  protected $cartBlock;

  /**
   * Protected container variable.
   *
   * @var container
   */
  protected $container;

  /**
   * Protected configFactory variable.
   *
   * @var configFactory
   */
  protected $configFactory;

  /**
   * The Drupal messenger.
   *
   * @var \Drupal\Core\Messenger\Messenger
   */
  protected $messenger;

  /**
   * Private constructor to avoid instantiation.
   */
  private function __construct() {
    $this->container = Drupal::getContainer();
    $this->cartBlock = $this
      ->getCartBlock($this->container);
    $this->configFactory = $this->container
      ->get('config.factory');
    $this->messenger = $this->container
      ->get('messenger');
  }

  /**
   * Get cart block.
   *
   * @param object $container
   *   Container object.
   *
   * @return object
   *   Return render object.
   */
  private function getCartBlock($container = NULL) {
    $blockId = $this
      ->getCartBlockId();
    if ($blockId != FALSE) {
      $block = Block::load($blockId);
      $render = $container
        ->get('entity_type.manager')
        ->getViewBuilder('block')
        ->view($block);
    }
    return isset($render) ? $render : NULL;
  }

  /**
   * Gets the machine name (id) of a commerce cart block
   * visible on the current page. Returns only the first cart found
   *
   * @param none
   *
   * @return mixed or FALSE
   *   Return id of the first commerce cart block found on current page.
   *  Returns FALSE if no commerce cart block is visible.
   */
  private function getCartBlockId() {
    $blockRepo = Drupal::service('block.repository');

    //Returns an array of regions each with an array of blocks
    $regions = $blockRepo
      ->getVisibleBlocksPerRegion();

    //Iterate all visible blocks and regions
    foreach ($regions as $region) {
      foreach ($region as $block) {
        $idPlugin = $block
          ->get('plugin');

        //check if this is a commerce cart block
        if ($idPlugin == 'commerce_cart') {
          $cartBlockId = $block
            ->get('id');
          return $cartBlockId;
        }
      }
    }
    return FALSE;
  }

  /**
   * Get class instance using this function.
   *
   * @return DomainRouteMetaHelper
   *   return Object.
   */
  public static function getInstance() {
    if (!self::$helper) {
      self::$helper = new AjaxCartHelper();
    }
    return self::$helper;
  }

  /**
   * Ajax add to cart Form.
   *
   * @param string $form_id
   *   Form id.
   * @param array $form
   *   Form array.
   *
   * @return string
   *   Return Form array.
   */
  public function ajaxAddToCartAjaxForm($form_id, &$form) {
    $messages = [
      $form_id => t('Adding to cart ...'),
    ];
    $form['status_messages_' . $form_id] = [
      '#type' => 'status_messages',
      '#weight' => -10,
    ];
    $form['form_id'] = [
      '#type' => 'hidden',
      '#value' => $form_id,
    ];

    // // Add ajax callback to the form.
    $form['actions']['submit']['#attributes']['class'][] = 'use-ajax';
    $form['actions']['submit']['#ajax'] = [
      'callback' => 'ajax_add_to_cart_ajax_validate',
      'disable-refocus' => TRUE,
      'event' => 'click',
      'progress' => [
        'type' => 'throbber',
        'message' => $messages[$form_id],
      ],
    ];

    // Add ajax dialoge library to open the form in popup.
    // Adding own library to add extra functionality.
    $form['#attached']['library'][] = 'ajax_add_to_cart/ajax_add_to_cart.commands';
    $form['#attached']['library'][] = 'core/drupal.dialog.ajax';
    $form['#attached']['drupalSettings']['ajax_add_to_cart']['ajax_add_to_cart']['time'] = $this->configFactory
      ->get('ajax_add_to_cart.ajaxconfig')
      ->get('time_ajax_modal');
    return $form;
  }

  /**
   * Ajax add to cart response.
   *
   * @param string $form_id
   *   Form id.
   * @param object $response
   *   Response object to store information.
   *
   * @return object
   *   Return response object.
   */
  public function ajaxAddToCartAjaxResponse($form_id, $response) {

    // Adding modal window.
    $options = [
      'width' => $this->configFactory
        ->get('ajax_add_to_cart.ajaxconfig')
        ->get('ajax_modal_width'),
      'height' => $this->configFactory
        ->get('ajax_add_to_cart.ajaxconfig')
        ->get('ajax_modal_height'),
    ];
    $title = t('Successfully Added');
    $message = [
      '#theme' => 'status_messages',
      '#message_list' => [
        'status' => $this->messenger
          ->deleteByType('status'),
      ],
    ];
    if (!empty($this->cartBlock)) {
      $response
        ->addCommand(new OpenModalDialogCommand($title, $message, $options));
    }
    else {
      $customblock = $this->container
        ->get('plugin.manager.block')
        ->createInstance('commerce_cart', []);
      $render = $customblock
        ->build();
      $response
        ->addCommand(new OpenModalDialogCommand($title, $render, $options));
    }
    $response
      ->addCommand(new ReplaceCommand('.block-commerce-cart', $this->cartBlock));
    $response
      ->addCommand(new ReloadCommand());
    return $response;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AjaxCartHelper::$cartBlock	protected	property	Protected cartBlock variable.
AjaxCartHelper::$configFactory	protected	property	Protected configFactory variable.
AjaxCartHelper::$container	protected	property	Protected container variable.
AjaxCartHelper::$helper	public static	property	Keep class object.
AjaxCartHelper::$messenger	protected	property	The Drupal messenger.
AjaxCartHelper::ajaxAddToCartAjaxForm	public	function	Ajax add to cart Form.
AjaxCartHelper::ajaxAddToCartAjaxResponse	public	function	Ajax add to cart response.
AjaxCartHelper::getCartBlock	private	function	Get cart block.
AjaxCartHelper::getCartBlockId	private	function	Gets the machine name (id) of a commerce cart block visible on the current page. Returns only the first cart found
AjaxCartHelper::getInstance	public static	function	Get class instance using this function.
AjaxCartHelper::__construct	private	function	Private constructor to avoid instantiation.