Gateways

Type

Class

Namespace

craft\commerce\services

Inherits

craft\commerce\services\Gateways » yii\base\Component » yii\base\BaseObject

Implements

yii\base\Configurable

Since

2.0

Gateway service.

View source

Public Properties

Property	Description
allArchivedGateways	array
allCustomerEnabledGateways	craft\commerce\base\GatewayInterface[] – all gateways enabled for the customer
allGatewayTypes	string[] – all registered gateway types
allGateways	craft\commerce\base\GatewayInterface[] – all gateways
allSubscriptionGateways	array
behaviors	yii\base\Behavior – List of behaviors attached to this component.

allArchivedGateways

Type

array

Default value

null

Access

Read-only

View source

allCustomerEnabledGateways

Type

craft\commerce\base\GatewayInterface[]

Default value

null

all gateways enabled for the customer

View source

allGatewayTypes

Type

string[]

Default value

null

all registered gateway types

View source

allGateways

Type

craft\commerce\base\GatewayInterface[]

Default value

null

all gateways

View source

allSubscriptionGateways

Type

array

Default value

null

View source

Public Methods

Method	Description
__call()	Calls the named method which is not a class method.
__clone()	This method is called after the object is created by cloning an existing one.
__construct()	Constructor.
__get()	Returns the value of a component property.
__isset()	Checks if a property is set, i.e. defined and not null.
__set()	Sets the value of a component property.
__unset()	Sets a component property to be null.
archiveGatewayById()	Archives a gateway by its ID.
attachBehavior()	Attaches a behavior to this component.
attachBehaviors()	Attaches a list of behaviors to the component.
behaviors()	Returns a list of behaviors that this component should behave as.
canGetProperty()	Returns a value indicating whether a property can be read.
canSetProperty()	Returns a value indicating whether a property can be set.
className()	Returns the fully qualified name of this class.
createGateway()	Creates a gateway with a given config
detachBehavior()	Detaches a behavior from the component.
detachBehaviors()	Detaches all behaviors from the component.
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.
getAllArchivedGateways()
getAllCustomerEnabledGateways()	Returns all customer enabled gateways.
getAllCustomerEnabledGatewaysAndAvailableForUseWithOrder()	Returns all customer enabled gateways and allowed for the order/cart.
getAllGatewayTypes()	Returns all registered gateway types.
getAllGateways()	Returns all gateways
getAllSubscriptionGateways()	Returns all subscription gateways.
getBehavior()	Returns the named behavior object.
getBehaviors()	Returns all behaviors attached to this component.
getGatewayByHandle()	Returns a gateway by its handle.
getGatewayById()	Returns a gateway by its ID.
getGatewayOverrides()	Returns any custom gateway settings form config file.
handleArchivedGateway()	Handle gateway being archived
handleChangedGateway()	Handle gateway change
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.
hasMethod()	Returns a value indicating whether a method is defined.
hasProperty()	Returns a value indicating whether a property is defined for this component.
init()	Initializes the object.
off()	Detaches an existing event handler from this component.
on()	Attaches an event handler to an event.
reorderGateways()	Reorders gateways by ids.
saveGateway()	Saves a gateway.
trigger()	Triggers an event.

archiveGatewayById()

Archives a gateway by its ID.

View source

Arguments

• $id (integer) – Gateway ID

Returns

boolean – Whether the archiving was successful or not

Throws

• yii\base\ErrorException
• yii\base\Exception
• yii\base\InvalidConfigException
• yii\base\NotSupportedException
• yii\web\ServerErrorHttpException
• yii\db\Exception

createGateway()

Creates a gateway with a given config

View source

Arguments

• $config (string, array) – The gateway’s class name, or its config, with a type value and optionally a settings value

Returns

craft\commerce\base\Gateway – The gateway

Throws

• craft\errors\DeprecationException
• yii\base\InvalidConfigException

getAllArchivedGateways()

View source

Returns

array

Throws

• craft\errors\DeprecationException
• yii\base\InvalidConfigException

getAllCustomerEnabledGateways()

Returns all customer enabled gateways.

View source

Returns

\Illuminate\Support\Collection – All gateways that are enabled for frontend

Throws

• craft\errors\DeprecationException
• yii\base\InvalidConfigException

getAllCustomerEnabledGatewaysAndAvailableForUseWithOrder()

Returns all customer enabled gateways and allowed for the order/cart.

View source

Arguments

• $order

Returns

\Illuminate\Support\Collection – All gateways that are enabled for frontend and allowed for the order/cart.

Throws

• craft\errors\DeprecationException
• yii\base\InvalidConfigException

getAllGatewayTypes()

Returns all registered gateway types.

View source

Returns

string[]

getAllGateways()

Returns all gateways

View source

Returns

\Illuminate\Support\Collection – All gateways

Throws

• craft\errors\DeprecationException
• yii\base\InvalidConfigException

getAllSubscriptionGateways()

Returns all subscription gateways.

View source

Returns

\Illuminate\Support\Collection<\craft\commerce\base\GatewayInterface> – All Subscription gateways

Throws

• craft\errors\DeprecationException
• yii\base\InvalidConfigException

getGatewayByHandle()

Returns a gateway by its handle.

View source

Arguments

• $handle (string)

Returns

craft\commerce\base\Gateway, null – The gateway or null if not found.

Throws

• craft\errors\DeprecationException
• yii\base\InvalidConfigException

getGatewayById()

Returns a gateway by its ID.

View source

Arguments

• $id (integer)

Returns

craft\commerce\base\Gateway, null – The gateway or null if not found.

Throws

• craft\errors\DeprecationException
• yii\base\InvalidConfigException

getGatewayOverrides()

DEPRECATED

Deprecated in 3.3. Overriding gateway settings using the commerce-gateways.php file has been deprecated. Use the gateway’s config file instead.

Returns any custom gateway settings form config file.

View source

Arguments

• $handle (string) – The gateway handle

Throws

• craft\errors\DeprecationException

handleArchivedGateway()

Handle gateway being archived

View source

Arguments

• $event

Throws

• Throwable
  if reasons

handleChangedGateway()

Handle gateway change

View source

Arguments

• $event

Throws

• Throwable
  if reasons

reorderGateways()

Reorders gateways by ids.

View source

Arguments

• $ids (array) – Array of gateways.

Returns

boolean – Always true.

Throws

• yii\base\ErrorException
• yii\base\Exception
• yii\base\InvalidConfigException
• yii\base\NotSupportedException
• yii\web\ServerErrorHttpException

saveGateway()

Saves a gateway.

View source

Arguments

• $gateway (craft\commerce\base\Gateway) – The gateway to be saved.
• $runValidation (boolean) – Whether the gateway should be validated

Returns

boolean – Whether the gateway was saved successfully or not.

Throws

• yii\base\Exception
• yii\base\InvalidConfigException
• yii\base\ErrorException
• yii\base\NotSupportedException
• yii\web\ServerErrorHttpException

Constants

Constant	Description
CONFIG_GATEWAY_KEY

Events

EVENT_REGISTER_GATEWAY_TYPES

Type

craft\events\RegisterComponentTypesEvent

The event that is triggered for the registration of additional gateways.

This example registers a custom gateway instance of the MyGateway class:

use craft\events\RegisterComponentTypesEvent;
use craft\commerce\services\Purchasables;
use yii\base\Event;

Event::on(
    Gateways::class,
    Gateways::EVENT_REGISTER_GATEWAY_TYPES,
    function(RegisterComponentTypesEvent $event) {
        $event->types[] = MyGateway::class;
    }
);

---