StoreHandlerInterface.php in Mailchimp E-Commerce 8

Namespace

Drupal\mailchimp_ecommerce

File

src/StoreHandlerInterface.php

<?php

namespace Drupal\mailchimp_ecommerce;


/**
 * Interface for the Store handler.
 */
interface StoreHandlerInterface {

  /**
   * Return information about the store from the supplied id.
   *
   * @param string $store_id
   *   The ID of the store.
   *
   * @return object
   *   Mailchimp store object.
   */
  public function getStore($store_id);

  /**
   * Add a new store to Mailchimp.
   *
   * @param string $store_id
   *   The ID of the store.
   * @param array $store
   *   Associative array of store information.
   *   - list_id (string) The id for the list associated with the store.
   *   - name (string) The name of the store.
   *   - currency_code (string) The three-letter ISO 4217 code for the currency
   *     that the store accepts.
   * @param string $platform
   *   The eCommerce platform being used to create this store.
   *   This module's submodules use 'Drupal Ubercart' and 'Drupal Commerce'.
   */
  public function addStore($store_id, $store, $platform);

  /**
   * Update a store name or currency code.
   *
   * @param string $store_id
   *   The ID of the store.
   * @param string $name
   *   The name of the store.
   * @param string $currency_code
   *   The three-letter ISO 4217 code.
   * @param string $platform
   *   The eCommerce platform being used to create this store.
   *   This module's submodules use 'Drupal Ubercart' and 'Drupal Commerce'.
   */
  public function updateStore($store_id, $name, $currency_code, $platform);

}

Interfaces

Name	Description
StoreHandlerInterface	Interface for the Store handler.