Class Request

Base abstract for all MeS APIs

Direct known subclasses

OpenDNS\MES\Recurring\Request, OpenDNS\MES\Reporting\Report, OpenDNS\MES\Trident\Request

Indirect known subclasses

OpenDNS\MES\Recurring\Create, OpenDNS\MES\Recurring\Delete, OpenDNS\MES\Trident\Refund, OpenDNS\MES\Trident\Sale, OpenDNS\MES\Trident\StoreCard, OpenDNS\MES\Trident\Verification, OpenDNS\MES\Trident\Void, OpenDNS\MES\Recurring\RecurringDetailRequest, OpenDNS\MES\Recurring\Update, OpenDNS\MES\Trident\Capture, OpenDNS\MES\Trident\CardTransaction, OpenDNS\MES\Trident\Credit, OpenDNS\MES\Trident\DeleteStoredCard, OpenDNS\MES\Trident\PreAuthorization, OpenDNS\MES\Trident\ReAuthorization

Abstract
Namespace: OpenDNS\MES
Located at Request.php

Methods summary

`public`	# `__construct( string $environment )` Constructor, for constructing new instances Constructor, for constructing new instances Parameters `$environment` One of the ENV consts for API environment
`public static OpenDNS\MES\Request`	# `factory( string $environment )` Factory method for convenient chaining Factory method for convenient chaining Parameters `$environment` One of the ENV consts for API environment Returns `OpenDNS\MES\Request` A new instance
`final public Guzzle\Http\Stream\StreamInterface`	# `execute( )` Run the request and return the response body Run the request and return the response body Returns `Guzzle\Http\Stream\StreamInterface` A Guzzle stream object representing the response body
`protected string`	# `getApiUrl( )` Assemble a full API url out of class properties Assemble a full API url out of class properties Returns `string` the combined API url
`protected Guzzle\Http\Client`	# `getClient( )` Return a singleton Guzzle HTTP client Return a singleton Guzzle HTTP client Returns `Guzzle\Http\Client`
`protected OpenDNS\MES\Request`	# `removeField( string $field )` Remove a set field from the current request Remove a set field from the current request Parameters `$field` Field name to unset from the request Returns `OpenDNS\MES\Request` The current class instance for chaining
`protected OpenDNS\MES\Request`	# `setField( string $field, integer\|string $value )` Set a new field on the current request Set a new field on the current request Parameters `$field` The field name to set `$value` value of the field (will be cast to string) Returns `OpenDNS\MES\Request` The current class instance for chaining
`protected OpenDNS\MES\Request`	# `setDefaults( )` Set any defined default fields on the request Set any defined default fields on the request Returns `OpenDNS\MES\Request` The current class instance for chaining
`protected OpenDNS\MES\Response`	# `processResponse( Guzzle\Http\Stream\StreamInterface $response )` Allows child classes to post-process the results before returning them Allows child classes to post-process the results before returning them Parameters `$response` The Guzzle stream object returned by execute() Returns `OpenDNS\MES\Response` An object representing the MeS response

Magic methods summary

Constants summary

`string`	`ENV_PROD`	# `'api'`
`string`	`ENV_CERT`	# `'cert'`
`string`	`ENV_TEST`	# `'test'`

Properties summary

`protected string`	`$httpMethod` HTTP Method to use for the request HTTP Method to use for the request	# `'POST'`
`protected string`	`$apiBaseDomain` Base domain name for the API as a whole Base domain name for the API as a whole	# `'merchante-solutions.com'`
`protected string`	`$apiEnvironment` Environment subdomain for the api Environment subdomain for the api	#
`protected string`	`$apiBasePath` The path to an API's endpoints on the server The path to an API's endpoints on the server	#
`protected string`	`$apiEndpointPath` The name of a specific endpoint within the api base path The name of a specific endpoint within the api base path	#
`protected string[]`	`$defaultFieldValues` key/value pairs to be set by default on new requests key/value pairs to be set by default on new requests	# `array()`