Gateway

Type
Abstract Class
Namespace
craft\commerce\base
Inherits
craft\commerce\base\Gateway » craft\base\SavableComponent » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements
ArrayAccess, IteratorAggregate, craft\base\ComponentInterface, craft\base\SavableComponentInterface, craft\commerce\base\GatewayInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses traits
craft\base\ClonefixTrait, craft\base\SavableComponentTrait, craft\commerce\base\GatewayTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Extended by
craft\commerce\base\SubscriptionGateway, craft\commerce\gateways\Dummy, craft\commerce\gateways\Manual, craft\commerce\gateways\MissingGateway
Since
2.0

Class Gateway

View source

Public Properties

PropertyDescription
$activeValidatorsyii\validators\Validator – The validators applicable to the current $scenario.
$attributesarray – Attribute values (name => value).
$behaviorsyii\base\Behavior – List of behaviors attached to this component
$cpEditUrlstring
$dateArchivedDateTime – Archived Date
$dateCreatedDateTime, null – The date that the component was created
$dateUpdatedDateTime, null – The date that the component was last updated
$errorsarray – Errors for all attributes or the specified attribute.
$firstErrorsarray – The first errors.
$handlestring – Handle
$idinteger, string, null – The component’s ID (could be a temporary one: "new:X")
$isArchivedboolean – Archived
$isFrontendEnabledboolean – Enabled on the frontend
$isNewboolean – Whether the component is new
$iteratorArrayIterator – An iterator for traversing the items in the list.
$namestring – Name
$paymentFormModelcraft\commerce\models\payments\BasePaymentForm
$paymentTypestring – Payment Type
$paymentTypeOptionsarray
$scenariostring – The scenario that this model is in.
$settingsarray – The component’s settings.
$settingsHtmlstring, null
$sortOrderinteger, null – Sort order
$validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.
$webhookUrlstring

$cpEditUrl

Type
string
Access
Read-only

View source

Signature

public string getCpEditUrl ( )

$paymentTypeOptions

Type
array
Access
Read-only

View source

Signature

public array getPaymentTypeOptions ( )

$webhookUrl

Type
string
Access
Read-only

View source

Signature

public string getWebhookUrl ( array $params = [] )

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()
__construct()Constructor.
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__toString()Returns the name of this payment method.
__unset()Sets an object property to null.
activeAttributes()Returns the attribute names that are subject to validation in the current scenario.
addError()Adds a new error to the specified attribute.
addErrors()Adds a list of errors.
addModelErrors()Adds errors from another model, with a given attribute name prefix.
afterDelete()Performs actions after a component is deleted.
afterSave()Performs actions after a component is saved.
afterValidate()This method is invoked after validation ends.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attributeHints()Returns the attribute hints.
attributeLabels()Returns the attribute labels.
attributes()Returns the list of attribute names.
authorize()Makes an authorize request.
availableForUseWithOrder()Returns true if gateway supports payments for the supplied Order.
beforeDelete()Performs actions before a component is deleted.
beforeSave()Performs actions before a component is saved.
beforeValidate()This method is invoked before validation starts.
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.
capture()Makes a capture request.
className()Returns the fully qualified name of this class.
clearErrors()Removes errors for all attributes or a single attribute.
completeAuthorize()Complete the authorization for offsite payments.
completePurchase()Complete the purchase for offsite payments.
cpPaymentsEnabled()Returns whether this gateway allows payments in control panel.
createPaymentSource()Creates a payment source from source data and user id.
createValidators()Creates validator objects based on the validation rules specified in rules().
datetimeAttributes()Returns the names of any attributes that should hold DateTime values.
deletePaymentSource()Deletes a payment source on the gateway by its token.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
displayName()Returns the display name of this class.
ensureBehaviors()Makes sure that the behaviors declared in behaviors() are attached to this component.
extraFields()Returns the list of fields that can be expanded further and returned by toArray().
fields()Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
formName()Returns the form name that this model class should use.
generateAttributeLabel()Generates a user friendly attribute label based on the give attribute name.
getActiveValidators()Returns the validators applicable to the current $scenario.
getAttributeHint()Returns the text hint for the specified attribute.
getAttributeLabel()Returns the text label for the specified attribute.
getAttributes()Returns attribute values.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getCpEditUrl()
getError()Returns the first error of the specified attribute.
getErrorSummary()Returns the errors for all attributes as a one-dimensional array.
getErrors()Returns the errors for all attributes or a single attribute.
getFirstError()Returns the first error of the specified attribute.
getFirstErrors()Returns the first error of every attribute in the model.
getIsNew()Returns whether the component is new (unsaved).
getIterator()Returns an iterator for traversing the attributes in the model.
getPaymentConfirmationFormHtml()Returns the html to use when paying with a stored payment source.
getPaymentFormHtml()Returns payment Form HTML
getPaymentFormModel()Returns payment form model to use in payment forms.
getPaymentTypeOptions()Returns the payment type options.
getScenario()Returns the scenario that this model is used in.
getSettings()Returns an array of the component’s settings.
getSettingsHtml()Returns the component’s settings HTML.
getValidators()Returns all the validators declared in rules().
getWebhookUrl()Returns the webhook url for this gateway.
hasErrors()Returns a value indicating whether there is any validation error.
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.
init()Initializes the object.
instance()Returns static class instance, which can be used to obtain meta information.
isAttributeActive()Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired()Returns a value indicating whether the attribute is required.
isAttributeSafe()Returns a value indicating whether the attribute is safe for massive assignments.
isSelectable()Returns whether the component should be selectable in component Type selects.
load()Populates the model with input data.
loadMultiple()Populates a set of models with the data from end user.
off()Detaches an existing event handler from this component.
offsetExists()Returns whether there is an element at the specified offset.
offsetGet()Returns the element at the specified offset.
offsetSet()Sets the element at the specified offset.
offsetUnset()Sets the element value at the specified offset to null.
on()Attaches an event handler to an event.
onUnsafeAttribute()This method is invoked when an unsafe attribute is being massively assigned.
processWebHook()Processes a webhook and return a response
purchase()Makes a purchase request.
refund()Makes an refund request.
rules()Returns the validation rules for attributes.
safeAttributes()Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios()Returns a list of scenarios and the corresponding active attributes.
setAttributes()Sets the attribute values in a massive way.
setScenario()Sets the scenario for the model.
settingsAttributes()Returns the list of settings attribute names.
supportsAuthorize()Returns true if gateway supports authorize requests.
supportsCapture()Returns true if gateway supports capture requests.
supportsCompleteAuthorize()Returns true if gateway supports completing authorize requests
supportsCompletePurchase()Returns true if gateway supports completing purchase requests
supportsPartialRefund()Returns true if gateway supports partial refund requests.
supportsPaymentSources()Returns true if gateway supports payment sources
supportsPurchase()Returns true if gateway supports purchase requests.
supportsRefund()Returns true if gateway supports refund requests.
supportsWebhooks()Returns true if gateway supports webhooks.
toArray()Converts the model into an array.
trigger()Triggers an event.
validate()Validates the component.
validateMultiple()Validates multiple models.

__toString()

Returns the name of this payment method.

View source

Returns

string

Signature

public string __toString ( )

availableForUseWithOrder()

Returns true if gateway supports payments for the supplied Order.

View source

Arguments

  • $order – Order The order this gateway can or can not be available for payment with.

Returns

boolean

Signature

public boolean availableForUseWithOrder ( craft\commerce\elements\Order $order )

cpPaymentsEnabled()

Returns whether this gateway allows payments in control panel.

View source

Returns

boolean

Signature

public boolean cpPaymentsEnabled ( )

getCpEditUrl()

Signature

public string getCpEditUrl ( )

getPaymentConfirmationFormHtml()

Returns the html to use when paying with a stored payment source.

View source

Arguments

Returns

mixed

Signature

public mixed getPaymentConfirmationFormHtml ( array $params )

getPaymentFormHtml()

Returns payment Form HTML

View source

Arguments

Returns

string, null

Signature

public abstract string, null getPaymentFormHtml ( array $params )

getPaymentTypeOptions()

Returns the payment type options.

View source

Returns

array

Signature

public array getPaymentTypeOptions ( )

getWebhookUrl()

Returns the webhook url for this gateway.

View source

Arguments

  • $params (array) – Parameters for the url.

Returns

string

Signature

public string getWebhookUrl ( array $params = [] )

rules()

Returns the validation rules for attributes.

Validation rules are used by validate() to check if attribute values are valid. Child classes may override this method to declare different validation rules.

Each rule is an array with the following structure:

[
    ['attribute1', 'attribute2'],
    'validator type',
    'on' => ['scenario1', 'scenario2'],
    //...other parameters...
]

where

  • attribute list: required, specifies the attributes array to be validated, for single attribute you can pass a string;
  • validator type: required, specifies the validator to be used. It can be a built-in validator name, a method name of the model class, an anonymous function, or a validator class name.
  • on: optional, specifies the scenarios array in which the validation rule can be applied. If this option is not set, the rule will apply to all scenarios.
  • additional name-value pairs can be specified to initialize the corresponding validator properties. Please refer to individual validator class API for possible properties.

A validator can be either an object of a class extending \craft\commerce\base\Validator, or a model class method (called inline validator) that has the following signature:

// $params refers to validation parameters given in the rule
function validatorName($attribute, $params)

In the above $attribute refers to the attribute currently being validated while $params contains an array of validator configuration options such as max in case of string validator. The value of the attribute currently being validated can be accessed as $this->$attribute. Note the $ before attribute; this is taking the value of the variable $attribute and using it as the name of the property to access.

Yii also provides a set of \craft\commerce\base\Validator::builtInValidators. Each one has an alias name which can be used when specifying a validation rule.

Below are some examples:

[
    // built-in "required" validator
    [['username', 'password'], 'required'],
    // built-in "string" validator customized with "min" and "max" properties
    ['username', 'string', 'min' => 3, 'max' => 12],
    // built-in "compare" validator that is used in "register" scenario only
    ['password', 'compare', 'compareAttribute' => 'password2', 'on' => 'register'],
    // an inline validator defined via the "authenticate()" method in the model class
    ['password', 'authenticate', 'on' => 'login'],
    // a validator of class "DateRangeValidator"
    ['dateRange', 'DateRangeValidator'],
];

Note, in order to inherit rules defined in the parent class, a child class needs to merge the parent rules with child rules using functions such as array_merge().

View source

Returns

array – Validation rules

Signature

public array rules ( )

Protected Methods

MethodDescription
extractFieldsFor()Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
extractRootFields()Extracts the root field names from nested fields.
resolveFields()Determines which fields can be returned by toArray().

Constants

ConstantDescription
SCENARIO_DEFAULTThe name of the default scenario.