Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/job-board.corals.io/Corals/modules/Payment/SagePay/Traits/ |
<?php
namespace Corals\Modules\Payment\SagePay\Traits;
/**
* Response fields shared between the Direct/Server response class and
* the notification handler.
*/
trait ResponseFieldsTrait
{
/**
* Get a POST data item, or null if not present.
*
* @param string $name The key for the field.
* @param mixed $default The value to return if the data item is not found at all, or is null.
* @return mixed The value of the field, often a string, but could be case to anything..
*/
protected function getDataItem($name, $default = null)
{
$data = $this->getData();
return isset($this->data[$name]) ? $this->data[$name] : $default;
}
/**
* @return bool True if the transaction is successful and complete.
*/
public function isSuccessful()
{
return $this->getStatus() === static::SAGEPAY_STATUS_OK
|| $this->getStatus() === static::SAGEPAY_STATUS_OK_REPEATED
|| $this->getStatus() === static::SAGEPAY_STATUS_REGISTERED
|| $this->getStatus() === static::SAGEPAY_STATUS_AUTHENTICATED;
}
/**
* Get the cardReference generated when creating a card reference
* during an authorisation or payment, or as an explicit request.
*
* @return string Currently an md5 format token.
*/
public function getCardReference()
{
return $this->getToken();
}
/**
* A card token is returned if one has been requested.
*
* @return string Currently an md5 format token.
*/
public function getToken()
{
return $this->getDataItem('Token');
}
/**
* The raw status code.
*
* @return string One of static::SAGEPAY_STATUS_*
*/
public function getStatus()
{
return $this->getCode();
}
/**
* The raw status code.
*
* @return string One of static::SAGEPAY_STATUS_*
*/
public function getCode()
{
return $this->getDataItem('Status');
}
/**
* Response Textual Message
*
* @return string A response message from the payment gateway
*/
public function getMessage()
{
return $this->getDataItem('StatusDetail');
}
/**
* Sage Pay unique Authorisation Code for a successfully authorised transaction.
* Only present if Status is OK
*
* @return string
*/
public function getTxAuthNo()
{
return $this->getDataItem('TxAuthNo');
}
/**
* This is the response from AVS and CV2 checks.
* Provided for Vendor info and backward compatibility with the
* banks. Rules set up in MySagePay will accept or reject
* the transaction based on these values.
*
* More detailed results are split out in the next three fields:
* AddressResult, PostCodeResult and CV2Result.
*
* Not present if the Status is:
* 3DAUTH, AUTHENTICATED, PPREDIRECT or REGISTERED.
*
* @return string One of static::AVSCV2_RESULT_*
*/
public function getAVSCV2()
{
return $this->getDataItem('AVSCV2');
}
/**
* The specific result of the checks on the cardholder’s
* address numeric from the AVS/CV2 checks.
*
* @return string Once of static::ADDRESS_RESULT_*
*/
public function getAddressResult()
{
return $this->getDataItem('AddressResult');
}
/**
* The specific result of the checks on the cardholder’s
* Postcode from the AVS/CV2 checks.
*
* @return string Once of static::POSTCODE_RESULT_*
*/
public function getPostCodeResult()
{
return $this->getDataItem('PostCodeResult');
}
/**
* The specific result of the checks on the cardholder’s CV2
* code from the AVS/CV2 checks.
*
* @return string One of static::CV2_RESULT_*
*/
public function getCV2Result()
{
return $this->getDataItem('CV2Result');
}
/**
* This field details the results of the 3D-Secure checks
* where appropriate.
*
* @return string One of static::SECURE3D_STATUS_*
*/
public function get3DSecureStatus()
{
return $this->getDataItem('3DSecureStatus');
}
/**
* The encoded result code from the 3D-Secure checks (CAVV or UCAF).
* Only present if the 3DSecureStatus field is OK or ATTEMPTONLY.
*
* @return string Up to 32 characters long.
*/
public function getCAVV()
{
return $this->getDataItem('CAVV');
}
/**
* The raw frawd response from the gateway.
*
* @return string One of static::FRAUD_RESPONSE_*
*/
public function getFraudResponse()
{
return $this->getDataItem('FraudResponse');
}
/**
* The authorisation code returned from the bank. e.g. T99777
* @return string
*/
public function getBankAuthCode()
{
return $this->getDataItem('BankAuthCode');
}
/**
* The decline code from the bank. These codes are
* specific to the bank. Please contact them for a description
* of each code. e.g. 00
* @return string Two digit code, specific to the bacnk.
*/
public function getDeclineCode()
{
return $this->getDataItem('DeclineCode');
}
/**
* Returns the surcharge amount charged and is only
* present if a surcharge was applied to the transaction.
* The surcharge should be added to the original requested amount
* to give the total amount authorised for payment.
*
* @return string|null Contains a floating point number.
*/
public function getSurcharge()
{
return $this->getDataItem('Surcharge');
}
/**
* Raw expiry date for the card, "MMYY" format by default.
* The expiry date is available for Sage Pay Direct responses, even if the
* remaining card details are not.
* Also supports custom formats.
*
* @param string|null $format Format using the PHP date() format string.
* @return string
*/
public function getExpiryDate($format = null)
{
$expiryDate = $this->getDataItem('ExpiryDate');
if ($format === null || $expiryDate === null) {
return $expiryDate;
} else {
return gmdate(
$format,
gmmktime(0, 0, 0, $this->getExpiryMonth(), 1, $this->getExpiryYear())
);
}
}
/**
* Get the card expiry month.
*
* @return int The month number, 1 to 12.
*/
public function getExpiryMonth()
{
$expiryDate = $this->getDataItem('ExpiryDate');
if (! empty($expiryDate)) {
return (int)substr($expiryDate, 0, 2);
}
}
/**
* Get the card expiry year.
*
* @return int The full four-digit year.
*/
public function getExpiryYear()
{
$expiryDate = $this->getDataItem('ExpiryDate');
if (! empty($expiryDate)) {
// COnvert 2-digit year to 4-dogot year, in 1970-2069 range.
$dateTime = \DateTime::createFromFormat('y', substr($expiryDate, 2, 2));
return (int)$dateTime->format('Y');
}
}
/**
* The transaction ID will be returned in the data for the Form API, or
* we will have to refer to the request for the Server and Direct APIs.
*
* @return @inherit
*/
public function getTransactionId()
{
return $this->getDataItem('VendorTxCode')
?: $this->getRequest()->getTransactionId();
}
}