Dummy

Type

Class

Namespace

craft\commerce\gateways

Inherits

craft\commerce\gateways\Dummy » craft\commerce\base\SubscriptionGateway » craft\commerce\base\Gateway » craft\base\SavableComponent (opens new window) » craft\base\ConfigurableComponent (opens new window) » craft\base\Component (opens new window) » craft\base\Model (opens new window) » yii\base\Model (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)

Implements

ArrayAccess (opens new window), IteratorAggregate (opens new window), craft\base\ComponentInterface (opens new window), craft\base\ConfigurableComponentInterface (opens new window), craft\base\ModelInterface (opens new window), craft\base\SavableComponentInterface (opens new window), craft\commerce\base\GatewayInterface, craft\commerce\base\SubscriptionGatewayInterface, yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window)

Uses traits

craft\base\ClonefixTrait (opens new window), craft\base\SavableComponentTrait (opens new window), craft\commerce\base\GatewayTrait, yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)

Since

2.0

Dummy represents a dummy gateway.

View source (opens new window)

Public Properties

Property	Description
_isFrontendEnabled	boolean (opens new window), string (opens new window), null (opens new window) – Enabled on the frontend
activeValidators (opens new window)	yii\validators\Validator (opens new window) – The validators applicable to the current scenario (opens new window).
attributes (opens new window)	array (opens new window) – Attribute values (name => value).
behaviors (opens new window)	yii\base\Behavior (opens new window) – List of behaviors attached to this component.
cancelSubscriptionFormModel	craft\commerce\models\subscriptions\CancelSubscriptionForm
cpEditUrl	string (opens new window)
dateArchived	DateTime (opens new window), null (opens new window) – Archived Date
dateCreated (opens new window)	DateTime (opens new window), null (opens new window) – The date that the component was created
dateUpdated (opens new window)	DateTime (opens new window), null (opens new window) – The date that the component was last updated
errors (opens new window)	array (opens new window) – Errors for all attributes or the specified attribute.
firstErrors (opens new window)	array (opens new window) – The first errors.
handle	string (opens new window), null (opens new window) – Handle
id (opens new window)	integer (opens new window), string (opens new window), null (opens new window) – The component’s ID (could be a temporary one: "new:X")
isArchived	boolean (opens new window) – Archived
isFrontendEnabled	boolean (opens new window), string (opens new window), null (opens new window)
isNew (opens new window)	boolean (opens new window) – Whether the component is new (unsaved)
iterator (opens new window)	ArrayIterator (opens new window) – An iterator for traversing the items in the list.
name	string (opens new window), null (opens new window) – Name
paymentFormModel	null (opens new window), craft\commerce\models\payments\BasePaymentForm
paymentType	string (opens new window) – Payment Type
paymentTypeOptions	array (opens new window)
planModel	craft\commerce\base\Plan
planSettingsHtml	string (opens new window), null (opens new window)
scenario (opens new window)	string (opens new window) – The scenario that this model is in.
settings (opens new window)	array (opens new window) – The component’s settings
settingsHtml (opens new window)	string (opens new window), null (opens new window)
sortOrder	integer (opens new window), null (opens new window) – Sort order
subscriptionFormModel	craft\commerce\models\subscriptions\SubscriptionForm
subscriptionPlans
switchPlansFormModel	craft\commerce\models\subscriptions\SwitchPlansForm
transactionHashFromWebhook	null (opens new window), string (opens new window)
uid	string (opens new window), null (opens new window) – UID
validators (opens new window)	ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.
webhookUrl

planSettingsHtml

Type

string (opens new window), null (opens new window)

Default value

null

Access

Read-only

View source (opens new window)

subscriptionPlans

Default value

null

Access

Read-only

View source (opens new window)

Public Methods

Method	Description
__call() (opens new window)	Calls the named method which is not a class method.
__clone() (opens new window)
__construct() (opens new window)
__get() (opens new window)	Returns the value of a component property.
__isset() (opens new window)	Checks if a property is set, i.e. defined and not null.
__set() (opens new window)	Sets the value of a component property.
__toString()	Returns the name of this payment method.
__unset() (opens new window)	Sets a component property to be null.
activeAttributes() (opens new window)	Returns the attribute names that are subject to validation in the current scenario.
addError() (opens new window)	Adds a new error to the specified attribute.
addErrors() (opens new window)	Adds a list of errors.
addModelErrors() (opens new window)	Adds errors from another model, with a given attribute name prefix.
afterDelete() (opens new window)	Performs actions after a component is deleted.
afterSave() (opens new window)	Performs actions after a component is saved.
afterValidate() (opens new window)	This method is invoked after validation ends.
attachBehavior() (opens new window)	Attaches a behavior to this component.
attachBehaviors() (opens new window)	Attaches a list of behaviors to the component.
attributeHints() (opens new window)	Returns the attribute hints.
attributeLabels() (opens new window)	Returns the attribute labels.
attributes() (opens new window)	Returns the list of attribute names.
authorize()	Makes an authorize request.
availableForUseWithOrder()	Returns true if gateway supports payments for the supplied order.
beforeApplyDelete() (opens new window)	Performs actions before a component delete is applied to the database.
beforeDelete() (opens new window)	Performs actions before a component is deleted.
beforeSave() (opens new window)	Performs actions before a component is saved.
beforeValidate() (opens new window)	This method is invoked before validation starts.
behaviors() (opens new window)	Returns a list of behaviors that this component should behave as.
canGetProperty() (opens new window)	Returns a value indicating whether a property can be read.
canSetProperty() (opens new window)	Returns a value indicating whether a property can be set.
cancelSubscription()	Cancels a subscription.
capture()	Makes a capture request.
className() (opens new window)	Returns the fully qualified name of this class.
clearErrors() (opens new window)	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 customer id.
createValidators() (opens new window)	Creates validator objects based on the validation rules specified in rules() (opens new window).
datetimeAttributes() (opens new window)	Returns the names of any attributes that should hold DateTime (opens new window) values.
defineRules()	Returns the validation rules for attributes.
deletePaymentSource()	Deletes a payment source on the gateway by its token.
detachBehavior() (opens new window)	Detaches a behavior from the component.
detachBehaviors() (opens new window)	Detaches all behaviors from the component.
displayName() (opens new window)	Returns the display name of this class.
ensureBehaviors() (opens new window)	Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
extraFields() (opens new window)	Returns the list of fields that can be expanded further and returned by toArray() (opens new window).
fields() (opens new window)	Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified.
formName() (opens new window)	Returns the form name that this model class should use.
generateAttributeLabel() (opens new window)	Generates a user friendly attribute label based on the give attribute name.
getActiveValidators() (opens new window)	Returns the validators applicable to the current scenario (opens new window).
getAttributeHint() (opens new window)	Returns the text hint for the specified attribute.
getAttributeLabel() (opens new window)	Returns the text label for the specified attribute.
getAttributes() (opens new window)	Returns attribute values.
getBehavior() (opens new window)	Returns the named behavior object.
getBehaviors() (opens new window)	Returns all behaviors attached to this component.
getBillingIssueDescription()	Return a description of the billing issue (if any) with this subscription.
getBillingIssueResolveFormHtml()	Return the form HTML for resolving the billing issue (if any) with this subscription.
getCancelSubscriptionFormHtml()	Returns the cancel subscription form HTML
getCancelSubscriptionFormModel()	Returns the cancel subscription form model
getCpEditUrl()
getErrorSummary() (opens new window)	Returns the errors for all attributes as a one-dimensional array.
getErrors() (opens new window)	Returns the errors for all attributes or a single attribute.
getFirstError() (opens new window)	Returns the first error of the specified attribute.
getFirstErrors() (opens new window)	Returns the first error of every attribute in the model.
getHasBillingIssues()	Returns whether this subscription has billing issues.
getIsFrontendEnabled()
getIsNew() (opens new window)	Returns whether the component is new (unsaved).
getIterator() (opens new window)	Returns an iterator for traversing the attributes in the model.
getNextPaymentAmount()	Returns the next payment amount for a subscription, taking into account all discounts.
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.
getPlanModel()	Returns the subscription plan model.
getPlanSettingsHtml()	Returns the subscription plan settings HTML
getScenario() (opens new window)	Returns the scenario that this model is used in.
getSettings() (opens new window)	Returns an array of the component’s settings.
getSettingsHtml() (opens new window)	Returns the component’s settings HTML.
getSubscriptionFormModel()	Returns the subscription form model
getSubscriptionPayments()	Returns a list of subscription payments for a given subscription.
getSubscriptionPlanByReference()	Returns a subscription plan by its reference
getSubscriptionPlans()	Returns all subscription plans as array containing hashes with reference and name as keys.
getSwitchPlansFormHtml()	Returns the html form to use when switching between two plans
getSwitchPlansFormModel()	Returns the form model used for switching plans.
getTransactionHashFromWebhook()	Retrieves the transaction hash from the webhook data. This could be a query string param or part of the response data.
getValidators() (opens new window)	Returns all the validators declared in rules() (opens new window).
getWebhookUrl()	Returns the webhook url for this gateway.
hasErrors() (opens new window)	Returns a value indicating whether there is any validation error.
hasEventHandlers() (opens new window)	Returns a value indicating whether there is any handler attached to the named event.
hasMethod() (opens new window)	Returns a value indicating whether a method is defined.
hasProperty() (opens new window)	Returns a value indicating whether a property is defined for this component.
init() (opens new window)	Initializes the object.
instance() (opens new window)	Returns static class instance, which can be used to obtain meta information.
isAttributeActive() (opens new window)	Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired() (opens new window)	Returns a value indicating whether the attribute is required.
isAttributeSafe() (opens new window)	Returns a value indicating whether the attribute is safe for massive assignments.
isSelectable() (opens new window)	Returns whether the component should be selectable in component Type selects.
load() (opens new window)	Populates the model with input data.
loadMultiple() (opens new window)	Populates a set of models with the data from end user.
off() (opens new window)	Detaches an existing event handler from this component.
offsetExists() (opens new window)	Returns whether there is an element at the specified offset.
offsetGet() (opens new window)	Returns the element at the specified offset.
offsetSet() (opens new window)	Sets the element at the specified offset.
offsetUnset() (opens new window)	Sets the element value at the specified offset to null.
on() (opens new window)	Attaches an event handler to an event.
onUnsafeAttribute() (opens new window)	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.
reactivateSubscription()	Reactivates a subscription.
refreshPaymentHistory()	Refresh the subscription payment history for a given subscription.
refund()	Makes an refund request.
rules() (opens new window)	Returns the validation rules for attributes.
safeAttributes() (opens new window)	Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios() (opens new window)	Returns a list of scenarios and the corresponding active attributes.
setAttributes() (opens new window)	Sets the attribute values in a massive way.
setIsFrontendEnabled()
setScenario() (opens new window)	Sets the scenario for the model.
settingsAttributes() (opens new window)	Returns the list of settings attribute names.
showPaymentFormSubmitButton()	Shows the payment button on the payment form.
subscribe()	Subscribe user to a plan.
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
supportsPartialPayment()	Returns true if gateway supports partial refund requests.
supportsPartialRefund()	Returns true if gateway supports partial refund requests.
supportsPaymentSources()	Returns true if gateway supports storing payment sources
supportsPlanSwitch()	Returns whether this gateway supports switching plans.
supportsPurchase()	Returns true if gateway supports purchase requests.
supportsReactivation()	Returns whether this gateway supports reactivating subscriptions.
supportsRefund()	Returns true if gateway supports refund requests.
supportsWebhooks()	Returns true if gateway supports webhooks.
switchSubscriptionPlan()	Switch a subscription to a different subscription plan.
toArray() (opens new window)	Converts the model into an array.
trigger() (opens new window)	Triggers an event.
validate() (opens new window)	Performs the data validation.
validateMultiple() (opens new window)	Validates multiple models.

authorize()

Makes an authorize request.

View source (opens new window)

Arguments

• $transaction (craft\commerce\models\Transaction) – The authorize transaction
• $form (craft\commerce\models\payments\BasePaymentForm) – A form filled with payment info

cancelSubscription()

Cancels a subscription.

View source (opens new window)

Arguments

• $subscription (craft\commerce\elements\Subscription) – The subscription to cancel
• $parameters (craft\commerce\models\subscriptions\CancelSubscriptionForm) – Additional parameters to use

Throws

• craft\commerce\errors\SubscriptionException
  for all subscription-related errors.

capture()

Makes a capture request.

View source (opens new window)

Arguments

• $transaction (craft\commerce\models\Transaction) – The capture transaction
• $reference (string (opens new window)) – Reference for the transaction being captured.

completeAuthorize()

Complete the authorization for offsite payments.

View source (opens new window)

Arguments

• $transaction (craft\commerce\models\Transaction) – The transaction

completePurchase()

Complete the purchase for offsite payments.

View source (opens new window)

Arguments

• $transaction (craft\commerce\models\Transaction) – The transaction

createPaymentSource()

Creates a payment source from source data and customer id.

View source (opens new window)

Arguments

• $sourceData
• $customerId

deletePaymentSource()

Deletes a payment source on the gateway by its token.

View source (opens new window)

Arguments

• $token (string (opens new window))

getBillingIssueDescription()

Return a description of the billing issue (if any) with this subscription.

View source (opens new window)

Arguments

• $subscription

getBillingIssueResolveFormHtml()

Return the form HTML for resolving the billing issue (if any) with this subscription.

View source (opens new window)

Arguments

• $subscription

getCancelSubscriptionFormHtml()

Returns the cancel subscription form HTML

View source (opens new window)

Arguments

• $subscription (craft\commerce\elements\Subscription) – The subscription to cancel

getCancelSubscriptionFormModel()

Returns the cancel subscription form model

View source (opens new window)

getHasBillingIssues()

Returns whether this subscription has billing issues.

View source (opens new window)

Arguments

• $subscription

getNextPaymentAmount()

Returns the next payment amount for a subscription, taking into account all discounts.

View source (opens new window)

Arguments

• $subscription

Returns

string (opens new window) – Next payment amount with currency code

getPaymentFormHtml()

Returns payment Form HTML

View source (opens new window)

Arguments

• $params

getPaymentFormModel()

Returns payment form model to use in payment forms.

View source (opens new window)

getPlanModel()

Returns the subscription plan model.

View source (opens new window)

getPlanSettingsHtml()

Returns the subscription plan settings HTML

View source (opens new window)

Arguments

• $params (array (opens new window))

Returns

string (opens new window), null (opens new window)

getSubscriptionFormModel()

Returns the subscription form model

View source (opens new window)

getSubscriptionPayments()

Returns a list of subscription payments for a given subscription.

View source (opens new window)

Arguments

• $subscription

Returns

craft\commerce\models\subscriptions\SubscriptionPayment[]

getSubscriptionPlanByReference()

Returns a subscription plan by its reference

View source (opens new window)

Arguments

• $reference

getSubscriptionPlans()

Returns all subscription plans as array containing hashes with reference and name as keys.

View source (opens new window)

getSwitchPlansFormModel()

Returns the form model used for switching plans.

View source (opens new window)

processWebHook()

Processes a webhook and return a response

View source (opens new window)

Throws

• Throwable (opens new window)
  if something goes wrong

purchase()

Makes a purchase request.

View source (opens new window)

Arguments

• $transaction (craft\commerce\models\Transaction) – The purchase transaction
• $form (craft\commerce\models\payments\BasePaymentForm) – A form filled with payment info

refund()

Makes an refund request.

View source (opens new window)

Arguments

• $transaction (craft\commerce\models\Transaction) – The refund transaction

subscribe()

Subscribe user to a plan.

View source (opens new window)

Arguments

• $user (craft\elements\User (opens new window)) – The Craft user to subscribe
• $plan (craft\commerce\base\Plan) – The plan to subscribe to
• $parameters (craft\commerce\models\subscriptions\SubscriptionForm) – Additional parameters to use

Throws

• craft\commerce\errors\SubscriptionException
  for all subscription-related errors.

supportsAuthorize()

Returns true if gateway supports authorize requests.

View source (opens new window)

supportsCapture()

Returns true if gateway supports capture requests.

View source (opens new window)

supportsCompleteAuthorize()

Returns true if gateway supports completing authorize requests

View source (opens new window)

supportsCompletePurchase()

Returns true if gateway supports completing purchase requests

View source (opens new window)

supportsPartialRefund()

Returns true if gateway supports partial refund requests.

View source (opens new window)

supportsPaymentSources()

Returns true if gateway supports storing payment sources

View source (opens new window)

supportsPlanSwitch()

Returns whether this gateway supports switching plans.

View source (opens new window)

supportsPurchase()

Returns true if gateway supports purchase requests.

View source (opens new window)

supportsReactivation()

Returns whether this gateway supports reactivating subscriptions.

View source (opens new window)

supportsRefund()

Returns true if gateway supports refund requests.

View source (opens new window)

supportsWebhooks()

Returns true if gateway supports webhooks.

If true is returned, this show the webhook url to the person setting up your gateway (after the gateway is saved). This also affects whether the webhook controller should route webhook requests to your processWebHook() method in this class.

View source (opens new window)

switchSubscriptionPlan()

Switch a subscription to a different subscription plan.

View source (opens new window)

Arguments

• $subscription (craft\commerce\elements\Subscription) – The subscription to modify
• $plan (craft\commerce\base\Plan) – The plan to change the subscription to
• $parameters (craft\commerce\models\subscriptions\SwitchPlansForm) – Additional parameters to use

Protected Methods

Method	Description
defineBehaviors() (opens new window)	Returns the behaviors to attach to this class.
extractFieldsFor() (opens new window)	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() (opens new window)	Extracts the root field names from nested fields.
resolveFields() (opens new window)	Determines which fields can be returned by toArray() (opens new window).

Constants

Constant	Description
SCENARIO_DEFAULT	The name of the default scenario.