Manual

Type: Class
Namespace: craft\commerce\gateways
Inherits: craft\commerce\gateways\Manual » 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, 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

Manual represents a manual gateway.

# 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.
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
onlyAllowForZeroPriceOrders	boolean (opens new window), string (opens new window)
paymentFormModel	null (opens new window), craft\commerce\models\payments\BasePaymentForm
paymentType	string (opens new window) – Payment Type
paymentTypeOptions	array (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	null (opens new window), string (opens new window)
sortOrder	integer (opens new window), null (opens new window) – Sort order
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

# `onlyAllowForZeroPriceOrders`

Type: boolean (opens new window), string (opens new window)
Default value: null

View source (opens new window)

# `settingsHtml`

Type: null (opens new window), string (opens new window)
Default value: null

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.
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.
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.
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.
getOnlyAllowForZeroPriceOrders()
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() (opens new window)	Returns the scenario that this model is used in.
getSettings()
getSettingsHtml()	Returns the component’s settings HTML.
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.
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()
setOnlyAllowForZeroPriceOrders()
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.
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
supportsPurchase()	Returns true if gateway supports purchase requests.
supportsRefund()	Returns true if gateway supports refund requests.
supportsWebhooks()	Returns true if gateway supports webhooks.
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

# `availableForUseWithOrder()`

Returns true if gateway supports payments for the supplied order.

This method is called before a payment is made for the supplied order. It can be used by developers building a checkout and deciding if this gateway should be shown as and option to the customer.

It also can prevent a gateway from being used with a particular order.

An example of this can be found in the manual payment gateway: It has a setting that can limit its use to only be used with orders that are of a zero value amount. See below for an example of how it uses this method to reject the gateway's use on orders that are not $0.00 if the setting is turned on

public function availableForUseWithOrder($order): bool
 if ($this->onlyAllowForZeroPriceOrders && $order->getTotalPrice() != 0) {
   return false;
 }
return true;
}

View source (opens new window)

Arguments

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

# `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))

# `getOnlyAllowForZeroPriceOrders()`

Since: 4.1.1

View source (opens new window)

Arguments

$parse (boolean (opens new window))

Returns

boolean (opens new window), string (opens new window)

# `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)

# `getPaymentTypeOptions()`

Returns the payment type options.

View source (opens new window)

# `getSettings()`

View source (opens new window)

# `getSettingsHtml()`

Returns the component’s settings HTML.

An extremely simple implementation would be to directly return some HTML:

return '<textarea name="foo">'.$this->foo.'</textarea>';

For more complex settings, you might prefer to create a template, and render it via craft\web\View::renderTemplate() (opens new window). For example, the following code would render a template located at src/templates/_settings.html, passing the settings to it:

return Craft::$app->view->renderTemplate('plugin-handle/_widget-settings', [
    'widget' => $this
]);

If you need to tie any JavaScript code to your settings, it’s important to know that any name and id attributes within the returned HTML will probably get namespaced (opens new window), however your JavaScript code will be left untouched. For example, if getSettingsHtml() returns the following HTML:

<textarea id="foo" name="foo"></textarea>
<script type="text/javascript">
  var textarea = document.getElementById('foo');
</script>

…then it might actually look like this before getting output to the browser:

<textarea id="namespace-foo" name="namespace[foo]"></textarea>
<script type="text/javascript">
  var textarea = document.getElementById('foo');
</script>

As you can see, that JavaScript code will not be able to find the textarea, because the textarea’s id attribute was changed from foo to namespace-foo. Before you start adding namespace- to the beginning of your element ID selectors, keep in mind that the actual namespace is going to change depending on the context. Often they are randomly generated. So it’s not quite that simple.

Thankfully, Craft provides a couple handy methods that can help you deal with this:

craft\web\View::namespaceInputId() (opens new window) will give you the namespaced version of a given ID.
craft\web\View::namespaceInputName() (opens new window) will give you the namespaced version of a given input name.

So here’s what a getSettingsHtml() method that includes field-targeting JavaScript code might look like:

public function getSettingsHtml(): ?string
{
    // Figure out what the ID is going to be namespaced into
    $id = 'foo';
    $namespacedId = Craft::$app->view->namespaceInputId($id);
    // Render and return the input template
    return Craft::$app->view->renderTemplate('plugin-handle/_widget-settings', [
        'id' => $id,
        'namespacedId' => $namespacedId,
        'widget' => $this,
    ]);
}

And the _widget-settings.twig template might look like this:

<textarea id="{{ id }}" name="foo">{{ widget.foo }}</textarea>
<script type="text/javascript">
  var textarea = document.getElementById('{{ namespacedId }}');
</script>

The same principles also apply if you’re including your JavaScript code with craft\web\View::registerJs() (opens new window).

View source (opens new window)

Returns

string (opens new window), null (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

# `setOnlyAllowForZeroPriceOrders()`

Since: 4.1.1

View source (opens new window)

Arguments

$onlyAllowForZeroPriceOrders (boolean (opens new window), string (opens new window))

Returns

void

# `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)

# `supportsPurchase()`

Returns true if gateway supports purchase requests.

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)

# 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.

← Dummy MissingGateway →

Manual

# Public Properties

# onlyAllowForZeroPriceOrders

# settingsHtml

# Public Methods

# authorize()

Arguments

# availableForUseWithOrder()

Arguments

# capture()

Arguments

# completeAuthorize()

Arguments

# completePurchase()

Arguments

# createPaymentSource()

Arguments

# deletePaymentSource()

Arguments

# getOnlyAllowForZeroPriceOrders()

Arguments

Returns

# getPaymentFormHtml()

Arguments

# getPaymentFormModel()

# getPaymentTypeOptions()

# getSettings()

# getSettingsHtml()

Returns

# processWebHook()

Throws

# purchase()

Arguments

# refund()

Arguments

# setOnlyAllowForZeroPriceOrders()

Arguments

Returns

# supportsAuthorize()

# supportsCapture()

# supportsCompleteAuthorize()

# supportsCompletePurchase()

# supportsPartialRefund()

# supportsPaymentSources()

# supportsPurchase()

# supportsRefund()

# supportsWebhooks()

# Protected Methods

# Constants

# `onlyAllowForZeroPriceOrders`

# `settingsHtml`

# `authorize()`

# `availableForUseWithOrder()`

# `capture()`

# `completeAuthorize()`

# `completePurchase()`

# `createPaymentSource()`

# `deletePaymentSource()`

# `getOnlyAllowForZeroPriceOrders()`

# `getPaymentFormHtml()`

# `getPaymentFormModel()`

# `getPaymentTypeOptions()`

# `getSettings()`

# `getSettingsHtml()`

# `processWebHook()`

# `purchase()`

# `refund()`

# `setOnlyAllowForZeroPriceOrders()`

# `supportsAuthorize()`

# `supportsCapture()`

# `supportsCompleteAuthorize()`

# `supportsCompletePurchase()`

# `supportsPartialRefund()`

# `supportsPaymentSources()`

# `supportsPurchase()`

# `supportsRefund()`

# `supportsWebhooks()`