interface PaymentGatewayStorageInterface in Commerce Core 8.2

Defines the interface for payment gateway storage.

Hierarchy

• interface \Drupal\Core\Entity\EntityStorageInterface
  • interface \Drupal\Core\Config\Entity\ConfigEntityStorageInterface
    • interface \Drupal\commerce_payment\PaymentGatewayStorageInterface

File

modules/payment/src/PaymentGatewayStorageInterface.php, line 12

Namespace

Drupal\commerce_payment

interface PaymentGatewayStorageInterface extends ConfigEntityStorageInterface {

  /**
   * Loads the default payment gateway for the given user.
   *
   * Used primarily when adding payment methods from the user pages.
   * Thus, only payment gateways which support storing payment methods
   * are considered.
   *
   * @param \Drupal\user\UserInterface $account
   *   The user account.
   *
   * @return \Drupal\commerce_payment\Entity\PaymentGatewayInterface
   *   The payment gateway.
   */
  public function loadForUser(UserInterface $account);

  /**
   * Loads all eligible payment gateways for the given order.
   *
   * @param \Drupal\commerce_order\Entity\OrderInterface $order
   *   The order.
   *
   * @return \Drupal\commerce_payment\Entity\PaymentGatewayInterface[]
   *   The payment gateways.
   */
  public function loadMultipleForOrder(OrderInterface $order);

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigEntityStorageInterface::createFromStorageRecord	public	function	Creates a configuration entity from storage values.	1
ConfigEntityStorageInterface::getIDFromConfigName	public static	function	Extracts the configuration entity ID from the full configuration name.	1
ConfigEntityStorageInterface::loadMultipleOverrideFree	public	function	Loads one or more entities in their original form without overrides.	1
ConfigEntityStorageInterface::loadOverrideFree	public	function	Loads one entity in their original form without overrides.	1
ConfigEntityStorageInterface::updateFromStorageRecord	public	function	Updates a configuration entity from storage values.	1
EntityStorageInterface::create	public	function	Constructs a new entity object, without permanently saving it.	1
EntityStorageInterface::delete	public	function	Deletes permanently saved entities.	1
EntityStorageInterface::deleteRevision	public	function	Delete a specific entity revision.	4
EntityStorageInterface::FIELD_LOAD_CURRENT		constant	Load the most recent version of an entity's field data.
EntityStorageInterface::FIELD_LOAD_REVISION		constant	Load the version of an entity's field data specified in the entity.
EntityStorageInterface::getAggregateQuery	public	function	Gets an aggregated query instance.	1
EntityStorageInterface::getEntityType	public	function	Gets the entity type definition.	1
EntityStorageInterface::getEntityTypeId	public	function	Gets the entity type ID.	1
EntityStorageInterface::getQuery	public	function	Gets an entity query instance.	1
EntityStorageInterface::hasData	public	function	Determines if the storage contains any data.	1
EntityStorageInterface::load	public	function	Loads one entity.	1
EntityStorageInterface::loadByProperties	public	function	Load entities by their property values.	1
EntityStorageInterface::loadMultiple	public	function	Loads one or more entities.	1
EntityStorageInterface::loadRevision	public	function	Load a specific entity revision.	4
EntityStorageInterface::loadUnchanged	public	function	Loads an unchanged entity from the database.	1
EntityStorageInterface::resetCache	public	function	Resets the internal, static entity cache.	1
EntityStorageInterface::restore	public	function	Restores a previously saved entity.	1
EntityStorageInterface::save	public	function	Saves the entity permanently.	1
PaymentGatewayStorageInterface::loadForUser	public	function	Loads the default payment gateway for the given user.	1
PaymentGatewayStorageInterface::loadMultipleForOrder	public	function	Loads all eligible payment gateways for the given order.	1