Overview

Namespaces

  • Ingenico
    • Connect
      • Sdk
        • Domain
          • Capture
            • Definitions
          • Definitions
          • Dispute
            • Definitions
          • Errors
            • Definitions
          • File
            • Definitions
          • Hostedcheckout
            • Definitions
          • Hostedmandatemanagement
            • Definitions
          • Installments
            • Definitions
          • Mandates
            • Definitions
          • MetaData
          • Payment
            • Definitions
          • Payout
            • Definitions
          • Product
            • Definitions
          • Refund
            • Definitions
          • Riskassessments
            • Definitions
          • Services
            • Definitions
          • Sessions
            • Definitions
          • Token
            • Definitions
          • Webhooks
        • Merchant
          • Disputes
          • Payments
          • Payouts
          • Productgroups
          • Products
          • Refunds
          • Services
          • Tokens
        • Webhooks

Classes

  • BodyHandler
  • BodyObfuscator
  • CallContext
  • Client
  • Communicator
  • CommunicatorConfiguration
  • CommunicatorLoggerHelper
  • DataObject
  • DefaultConnection
  • DefaultConnectionResponse
  • HeaderObfuscator
  • HttpHeaderHelper
  • HttpObfuscator
  • Merchant
  • MultipartDataObject
  • MultipartFormDataObject
  • ProxyConfiguration
  • RequestHeaderGenerator
  • RequestObject
  • Resource
  • ResourceLogger
  • ResponseBuilder
  • ResponseClassMap
  • ResponseExceptionFactory
  • ResponseFactory
  • ResponseHeaderBuilder
  • SplFileObjectLogger
  • UploadableFile
  • UuidGenerator
  • ValueObfuscator

Interfaces

  • CommunicatorLogger
  • Connection
  • ConnectionResponse

Exceptions

  • ApiException
  • AuthorizationException
  • DeclinedPaymentException
  • DeclinedPayoutException
  • DeclinedRefundException
  • GlobalCollectException
  • IdempotenceException
  • InvalidResponseException
  • ReferenceException
  • ResponseException
  • ValidationException
  • Overview
  • Namespace
  • Class
  • Deprecated

Class Communicator

Class Communicator

Namespace: Ingenico\Connect\Sdk
Package: Ingenico\Connect\Sdk
Located at Ingenico/Connect/Sdk/Communicator.php
Methods summary
public
# __construct( Ingenico\Connect\Sdk\Connection $connection, Ingenico\Connect\Sdk\CommunicatorConfiguration $communicatorConfiguration )

Parameters

$connection
$communicatorConfiguration
public
# enableLogging( Ingenico\Connect\Sdk\CommunicatorLogger $communicatorLogger )

Parameters

$communicatorLogger
public
# disableLogging( )
public Ingenico\Connect\Sdk\DataObject
# get( Ingenico\Connect\Sdk\ResponseClassMap $responseClassMap, string $relativeUriPath, string $clientMetaInfo = '', Ingenico\Connect\Sdk\RequestObject $requestParameters = null, Ingenico\Connect\Sdk\CallContext $callContext = null, Ingenico\Connect\Sdk\ResponseExceptionFactory $responseExceptionFactory = null )

Parameters

$responseClassMap
$relativeUriPath
$clientMetaInfo
$requestParameters
$callContext
$responseExceptionFactory

Returns

Ingenico\Connect\Sdk\DataObject

Throws

Exception
public
# getWithBinaryResponse( Ingenico\Connect\Sdk\ResponseClassMap $responseClassMap, string $relativeUriPath, string $clientMetaInfo = '', Ingenico\Connect\Sdk\RequestObject $requestParameters = null, callable $bodyHandler = null, Ingenico\Connect\Sdk\CallContext $callContext = null, Ingenico\Connect\Sdk\ResponseExceptionFactory $responseExceptionFactory = null )

Parameters

$responseClassMap
$relativeUriPath
$clientMetaInfo
$requestParameters
$bodyHandler
Callable accepting a response body chunk and the response headers
$callContext
$responseExceptionFactory

Throws

Exception
public Ingenico\Connect\Sdk\DataObject
# delete( Ingenico\Connect\Sdk\ResponseClassMap $responseClassMap, string $relativeUriPath, string $clientMetaInfo = '', Ingenico\Connect\Sdk\RequestObject $requestParameters = null, Ingenico\Connect\Sdk\CallContext $callContext = null, Ingenico\Connect\Sdk\ResponseExceptionFactory $responseExceptionFactory = null )

Parameters

$responseClassMap
$relativeUriPath
$clientMetaInfo
$requestParameters
$callContext
$responseExceptionFactory

Returns

Ingenico\Connect\Sdk\DataObject

Throws

Exception
public
# deleteWithBinaryResponse( Ingenico\Connect\Sdk\ResponseClassMap $responseClassMap, string $relativeUriPath, string $clientMetaInfo = '', Ingenico\Connect\Sdk\RequestObject $requestParameters = null, callable $bodyHandler = null, Ingenico\Connect\Sdk\CallContext $callContext = null, Ingenico\Connect\Sdk\ResponseExceptionFactory $responseExceptionFactory = null )

Parameters

$responseClassMap
$relativeUriPath
$clientMetaInfo
$requestParameters
$bodyHandler
Callable accepting a response body chunk and the response headers
$callContext
$responseExceptionFactory

Throws

Exception
public Ingenico\Connect\Sdk\DataObject
# post( Ingenico\Connect\Sdk\ResponseClassMap $responseClassMap, string $relativeUriPath, string $clientMetaInfo = '', Ingenico\Connect\Sdk\DataObject|Ingenico\Connect\Sdk\MultipartDataObject|null $requestBodyObject = null, Ingenico\Connect\Sdk\RequestObject $requestParameters = null, Ingenico\Connect\Sdk\CallContext $callContext = null, Ingenico\Connect\Sdk\ResponseExceptionFactory $responseExceptionFactory = null )

Parameters

$responseClassMap
$relativeUriPath
$clientMetaInfo
$requestBodyObject
$requestParameters
$callContext
$responseExceptionFactory

Returns

Ingenico\Connect\Sdk\DataObject

Throws

Exception
public
# postWithBinaryResponse( Ingenico\Connect\Sdk\ResponseClassMap $responseClassMap, string $relativeUriPath, string $clientMetaInfo = '', Ingenico\Connect\Sdk\DataObject|Ingenico\Connect\Sdk\MultipartDataObject|null $requestBodyObject = null, Ingenico\Connect\Sdk\RequestObject $requestParameters = null, callable $bodyHandler = null, Ingenico\Connect\Sdk\CallContext $callContext = null, Ingenico\Connect\Sdk\ResponseExceptionFactory $responseExceptionFactory = null )

Parameters

$responseClassMap
$relativeUriPath
$clientMetaInfo
$requestBodyObject
$requestParameters
$bodyHandler
Callable accepting a response body chunk and the response headers
$callContext
$responseExceptionFactory

Throws

Exception
public Ingenico\Connect\Sdk\DataObject
# put( Ingenico\Connect\Sdk\ResponseClassMap $responseClassMap, string $relativeUriPath, string $clientMetaInfo = '', Ingenico\Connect\Sdk\DataObject|Ingenico\Connect\Sdk\MultipartDataObject|null $requestBodyObject = null, Ingenico\Connect\Sdk\RequestObject $requestParameters = null, Ingenico\Connect\Sdk\CallContext $callContext = null, Ingenico\Connect\Sdk\ResponseExceptionFactory $responseExceptionFactory = null )

Parameters

$responseClassMap
$relativeUriPath
$clientMetaInfo
$requestBodyObject
$requestParameters
$callContext
$responseExceptionFactory

Returns

Ingenico\Connect\Sdk\DataObject

Throws

Exception
public
# putWithBinaryResponse( Ingenico\Connect\Sdk\ResponseClassMap $responseClassMap, string $relativeUriPath, string $clientMetaInfo = '', Ingenico\Connect\Sdk\DataObject|Ingenico\Connect\Sdk\MultipartDataObject|null $requestBodyObject = null, Ingenico\Connect\Sdk\RequestObject $requestParameters = null, callable $bodyHandler = null, Ingenico\Connect\Sdk\CallContext $callContext = null, Ingenico\Connect\Sdk\ResponseExceptionFactory $responseExceptionFactory = null )

Parameters

$responseClassMap
$relativeUriPath
$clientMetaInfo
$requestBodyObject
$requestParameters
$bodyHandler
Callable accepting a response body chunk and the response headers
$callContext
$responseExceptionFactory

Throws

Exception
protected
# updateCallContext( Ingenico\Connect\Sdk\ConnectionResponse $response, Ingenico\Connect\Sdk\CallContext $callContext = null )

Parameters

$response
$callContext
public Ingenico\Connect\Sdk\Connection
# getConnection( )

Returns

Ingenico\Connect\Sdk\Connection
public
# setConnection( Ingenico\Connect\Sdk\Connection $connection )

Parameters

$connection
protected Ingenico\Connect\Sdk\CommunicatorConfiguration
# getCommunicatorConfiguration( )

Returns

Ingenico\Connect\Sdk\CommunicatorConfiguration
public Ingenico\Connect\Sdk\Communicator
# setCommunicatorConfiguration( Ingenico\Connect\Sdk\CommunicatorConfiguration $communicatorConfiguration )

Parameters

$communicatorConfiguration

Returns

Ingenico\Connect\Sdk\Communicator
protected string
# getRequestUri( $relativeUriPath, Ingenico\Connect\Sdk\RequestObject $requestParameters = null )

Parameters

$relativeUriPath
$requestParameters

Returns

string

Throws

Exception
protected string[]
# getRequestHeaders( string $httpMethod, string $relativeUriPathWithRequestParameters, string $contentType, string $clientMetaInfo = '', Ingenico\Connect\Sdk\CallContext $callContext = null )

Parameters

$httpMethod
$relativeUriPathWithRequestParameters
$contentType
$clientMetaInfo
$callContext

Returns

string[]
protected string
# getRelativeUriPathWithRequestParameters( $relativeUriPath, Ingenico\Connect\Sdk\RequestObject $requestParameters = null )

Parameters

$relativeUriPath
$requestParameters

Returns

string
protected Ingenico\Connect\Sdk\ResponseFactory
# getResponseFactory( )

Returns

Ingenico\Connect\Sdk\ResponseFactory
protected Ingenico\Connect\Sdk\ResponseExceptionFactory
# getResponseExceptionFactory( )

Returns

Ingenico\Connect\Sdk\ResponseExceptionFactory
Constants summary
string MIME_APPLICATION_JSON
# 'application/json'
Ingenico Connect PHP SDK API documentation generated by ApiGen