interface OperationResultInterface in Payment 8.2

Defines an operation result.

When operations can be initialized programmatically, but may require human interaction to be completed, this interface provides calling code with information to continue the human part of the operation.

Hierarchy

• interface \Drupal\payment\OperationResultInterface

7 files declare their use of OperationResultInterface

CompletePaymentTest.php in tests/src/Unit/Controller/CompletePaymentTest.php

PaymentAccessControlHandlerTest.php in tests/src/Unit/Entity/Payment/PaymentAccessControlHandlerTest.php

PaymentCaptureFormTest.php in tests/src/Unit/Entity/Payment/PaymentCaptureFormTest.php

PaymentFormTest.php in modules/payment_form/tests/src/Unit/Entity/Payment/PaymentFormTest.php

PaymentMethodBaseTest.php in tests/src/Unit/Plugin/Payment/Method/PaymentMethodBaseTest.php

... See full list

File

src/OperationResultInterface.php, line 12

Namespace

Drupal\payment

interface OperationResultInterface {

  /**
   * Gets whether the operation is completed.
   *
   * @return bool
   *   Whether the operation is completed. When FALSE is returned,
   *   self::getCompletionResponse() MUST return a response.
   */
  public function isCompleted();

  /**
   * Gets the response to complete the operation.
   *
   * @return \Drupal\payment\Response\ResponseInterface|null
   *   A response (only if self::isInProgress() returns TRUE) or NULL if the
   *   operation cannot be completed (anymore).
   */
  public function getCompletionResponse();

}

Members

Name	Modifiers	Type	Description	Overrides
OperationResultInterface::getCompletionResponse	public	function	Gets the response to complete the operation.	1
OperationResultInterface::isCompleted	public	function	Gets whether the operation is completed.	1