DisputeInterface
DisputeInterface is used as part of the WHMCS\Billing\Payment\Dispute object to ensure that all required methods are present for output.
Utilise the factory method to initialise the DisputeInterface object that will be added to a DisputeCollection object in your custom gateway module.
Methods summary
| Return Type | Method Name | Description | |
|---|---|---|---|
| static DisputeInterface | factory(string $id, float $amount, string $currencyCode, string $transactionId, Carbon $createdDate, Carbon $respondBy, string $reason, string $status) | Factory method for a Dispute to create the object with the minimum required information to display a dispute within WHMCS. | |
| DisputeInterface | setEvidence(array $evidence) | Set an array of evidence. The evidence array format requires each item have a name and value. | |
| DisputeInterface | setEvidenceType(string $evidenceKey, string $evidenceType) | Override an evidence type from 'text' to one of 'file' or 'textarea'. | |
| DisputeInterface | setGateway(string $gateway) | Set the gateway module filename for the dispute for additional loading when viewing a specific dispute. | |
| DisputeInterface | setIsClosable(bool $closable) | Set whether the dispute is closable. This will show the close button on a dispute when set to true. | |
| DisputeInterface | setIsSubmittable(bool $submittable) | Set whether the dispute is submittable. This will show the submit dispute button on a dispute when set to true. | |
| DisputeInterface | setIsUpdatable(bool $updatable) | Set whether the dispute is updatable. This will show the update dispute button on a dispute when set to true allowing evidence to be submitted. | |
| DisputeInterface | setTransactionId(string $transactionId) | Set the related transaction id for the dispute. |
Details
static DisputeInterface
factory (string $id, float $amount, string $currencyCode, string $transactionId, Carbon $createdDate, Carbon $respondBy, string $reason, string $status)
Factory method for a Dispute to create the object with the minimum required information to display a dispute within WHMCS.
DisputeInterface
setEvidence (array $evidence)
Set an array of evidence. The evidence array format requires each item have a name and value.
DisputeInterface
setEvidenceType (string $evidenceKey, string $evidenceType)
Override an evidence type from 'text' to one of 'file' or 'textarea'.
Any $evidenceKey provided in setEvidence will default to the type of text.
DisputeInterface
setGateway (string $gateway)
Set the gateway module filename for the dispute for additional loading when viewing a specific dispute.
DisputeInterface
setIsClosable (bool $closable)
Set whether the dispute is closable. This will show the close button on a dispute when set to true.
DisputeInterface
setIsSubmittable (bool $submittable)
Set whether the dispute is submittable. This will show the submit dispute button on a dispute when set to true.
DisputeInterface
setIsUpdatable (bool $updatable)
Set whether the dispute is updatable. This will show the update dispute button on a dispute when set to true allowing evidence to be submitted.
DisputeInterface
setTransactionId (string $transactionId)
Set the related transaction id for the dispute.