AbstractIpn Class Reference

Inheritance diagram for AbstractIpn:

Public Member Functions
	__construct (\Magento\Paypal\Model\ConfigFactory $configFactory, \Psr\Log\LoggerInterface $logger, \Magento\Framework\HTTP\Adapter\CurlFactory $curlFactory, array $data=[])
	getRequestData ($key=null)

Protected Member Functions
	_postBack ()
	_filterPaymentStatus ($ipnPaymentStatus)
	_debug ()
	_addDebugData ($key, $value)

Protected Attributes
	$_config
	$_ipnRequest
	$_debugData = []
	$_configFactory
	$_curlFactory

Detailed Description

Definition at line 11 of file AbstractIpn.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Paypal\Model\ConfigFactory	$configFactory,
		\Psr\Log\LoggerInterface	$logger,
		\Magento\Framework\HTTP\Adapter\CurlFactory	$curlFactory,
		array	$data = []
	)

Parameters

\Magento\Paypal\Model\ConfigFactory	$configFactory
\Psr\Log\LoggerInterface	$logger
\Magento\Framework\HTTP\Adapter\CurlFactory	$curlFactory
array	$data

Definition at line 48 of file AbstractIpn.php.

      {
        $this->_configFactory = $configFactory;
        $this->logger = $logger;
        $this->_curlFactory = $curlFactory;
        $this->_ipnRequest = $data;
    }

Member Function Documentation

_addDebugData()

_addDebugData (   $key,   $value  )

protected

Parameters

string	$key
array | string	$value

Returns

$this

Definition at line 178 of file AbstractIpn.php.

    {
        $this->_debugData[$key] = $value;
        return $this;
    }

_debug()

_debug ( )

protected

Log debug data to file

Returns

void

Definition at line 166 of file AbstractIpn.php.

    {
        if ($this->_config && $this->_config->getValue('debug')) {
            $this->logger->debug(var_export($this->_debugData, true));
        }
    }

_filterPaymentStatus()

_filterPaymentStatus (   $ipnPaymentStatus )

protected

Filter payment status from NVP into paypal/info format

Parameters

string

$ipnPaymentStatus

Returns

string @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 127 of file AbstractIpn.php.

    {
        switch ($ipnPaymentStatus) {
            case 'Created':
                // break is intentionally omitted
            case 'Completed':
                return Info::PAYMENTSTATUS_COMPLETED;
            case 'Denied':
                return Info::PAYMENTSTATUS_DENIED;
            case 'Expired':
                return Info::PAYMENTSTATUS_EXPIRED;
            case 'Failed':
                return Info::PAYMENTSTATUS_FAILED;
            case 'Pending':
                return Info::PAYMENTSTATUS_PENDING;
            case 'Refunded':
                return Info::PAYMENTSTATUS_REFUNDED;
            case 'Reversed':
                return Info::PAYMENTSTATUS_REVERSED;
            case 'Canceled_Reversal':
                return Info::PAYMENTSTATUS_UNREVERSED;
            case 'Processed':
                return Info::PAYMENTSTATUS_PROCESSED;
            case 'Voided':
                return Info::PAYMENTSTATUS_VOIDED;
            default:
                return '';
        }
        // documented in NVP, but not documented in IPN:
        //Info::PAYMENTSTATUS_NONE
        //Info::PAYMENTSTATUS_INPROGRESS
        //Info::PAYMENTSTATUS_REFUNDEDPART
    }

_postBack()

_postBack ( )

protected

Post back to PayPal to check whether this request is a valid one

Returns

void

Exceptions

RemoteServiceUnavailableException

Definition at line 81 of file AbstractIpn.php.

    {
        $httpAdapter = $this->_curlFactory->create();
        $postbackQuery = http_build_query($this->getRequestData()) . '&cmd=_notify-validate';
        $postbackUrl = $this->_config->getPayPalIpnUrl();
        $this->_addDebugData('postback_to', $postbackUrl);

        $httpAdapter->setConfig(['verifypeer' => $this->_config->getValue('verifyPeer')]);
        $httpAdapter->write(\Zend_Http_Client::POST, $postbackUrl, '1.1', ['Connection: close'], $postbackQuery);
        try {
            $postbackResult = $httpAdapter->read();
        } catch (\Exception $e) {
            $this->_addDebugData('http_error', ['error' => $e->getMessage(), 'code' => $e->getCode()]);
            throw $e;
        }

        /*
         * Handle errors on PayPal side.
         */
        $responseCode = \Zend_Http_Response::extractCode($postbackResult);
        if (empty($postbackResult) || in_array($responseCode, ['500', '502', '503'])) {
            if (empty($postbackResult)) {
                $reason = 'Empty response.';
            } else {
                $reason = 'Response code: ' . $responseCode . '.';
            }
            $this->_debugData['exception'] = 'PayPal IPN postback failure. ' . $reason;
            throw new RemoteServiceUnavailableException(__($reason));
        }

        $response = preg_split('/^\r?$/m', $postbackResult, 2);
        $response = trim($response[1]);
        if ($response != 'VERIFIED') {
            $this->_addDebugData('postback', $postbackQuery);
            $this->_addDebugData('postback_result', $postbackResult);
            throw new \Exception('PayPal IPN postback failure. See system.log for details.');
        }
    }

getRequestData()

getRequestData

(

$key = null

)

IPN request data getter

Parameters

string

$key

Returns

array|string

Definition at line 66 of file AbstractIpn.php.

    {
        if (null === $key) {
            return $this->_ipnRequest;
        }
        return isset($this->_ipnRequest[$key]) ? $this->_ipnRequest[$key] : null;
    }

Field Documentation

$_config

$_config

protected

Definition at line 16 of file AbstractIpn.php.

$_configFactory

$_configFactory

protected

Definition at line 35 of file AbstractIpn.php.

$_curlFactory

$_curlFactory

protected

Definition at line 40 of file AbstractIpn.php.

$_debugData

$_debugData = []

protected

Definition at line 30 of file AbstractIpn.php.

$_ipnRequest

$_ipnRequest

protected

Definition at line 23 of file AbstractIpn.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-paypal/Model/AbstractIpn.php