ExternalProductReferenceMini extends RecurlyResource
Table of Contents
- $array_hints : mixed
- $_created_at : mixed
- $_external_connection_type : mixed
- $_id : mixed
- $_object : mixed
- $_reference_code : mixed
- $_response : mixed
- $_updated_at : mixed
- __construct() : mixed
- Constructor
- __debugInfo() : array<string|int, mixed>
- Override of the magic method __debugInfo that will only return the relevant attributes of the \Recurly\RecurlyResource
- __set() : void
- Guard against setting invalid properties
- cast() : RecurlyResource
- Recursively converts a response object into a \Recurly\RecurlyResource.
- fromBinary() : BinaryFile
- Converts a binary response into a Recurly BinaryFile
- fromEmpty() : EmptyResource
- Returns a \Recurly\EmptyResource for API requests that do not have a response body.
- fromResponse() : RecurlyResource
- Converts a Recurly response object into a \Recurly\RecurlyResource.
- getCreatedAt() : string|null
- Getter method for the created_at attribute.
- getExternalConnectionType() : string|null
- Getter method for the external_connection_type attribute.
- getId() : string|null
- Getter method for the id attribute.
- getObject() : string|null
- Getter method for the object attribute.
- getReferenceCode() : string|null
- Getter method for the reference_code attribute.
- getResponse() : Response
- Getter for the Recurly HTTP Response
- getUpdatedAt() : string|null
- Getter method for the updated_at attribute.
- setCreatedAt() : void
- Setter method for the created_at attribute.
- setExternalConnectionType() : void
- Setter method for the external_connection_type attribute.
- setId() : void
- Setter method for the id attribute.
- setObject() : void
- Setter method for the object attribute.
- setReferenceCode() : void
- Setter method for the reference_code attribute.
- setUpdatedAt() : void
- Setter method for the updated_at attribute.
- encodeApiKey() : string
- Base64 encodes the API key
- getUserAgent() : string
- Generates User-Agent for API requests
- hintArrayType() : string
- The hintArrayType method will provide type hinting for setter methods that have array parameters.
- resourceClass() : string
- Converts a string into a representation of a Recurly Resource
- setResponse() : void
- Setter for the Recurly HTTP Response
- setterParamClass() : string
- Uses the Reflection API to determine what \Recurly\RecurlyResource is the expected parameter for the given method.
- titleize() : string
- Capitalizes all the words in the $input.
Properties
$array_hints
protected
static mixed
$array_hints
= []
$_created_at
private
mixed
$_created_at
$_external_connection_type
private
mixed
$_external_connection_type
$_id
private
mixed
$_id
$_object
private
mixed
$_object
$_reference_code
private
mixed
$_reference_code
$_response
private
mixed
$_response
$_updated_at
private
mixed
$_updated_at
Methods
__construct()
Constructor
public
final __construct() : mixed
Return values
mixed —__debugInfo()
Override of the magic method __debugInfo that will only return the relevant attributes of the \Recurly\RecurlyResource
public
__debugInfo() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —__set()
Guard against setting invalid properties
public
__set(string $key, mixed $value) : void
Parameters
- $key : string
-
The parameter name that is being set
- $value : mixed
-
The parameter value that is being set
Tags
Return values
void —cast()
Recursively converts a response object into a \Recurly\RecurlyResource.
public
static cast(object $data) : RecurlyResource
Parameters
- $data : object
-
PHP Object containing the decoded JSON
Return values
RecurlyResource —An instance of a Recurly Resource
fromBinary()
Converts a binary response into a Recurly BinaryFile
public
static fromBinary(string $data, Response $response) : BinaryFile
Parameters
- $data : string
-
The binary file data
- $response : Response
-
(optional) The Recurly HTTP Response
Return values
BinaryFile —An instance of a Recurly BinaryFile
fromEmpty()
Returns a \Recurly\EmptyResource for API requests that do not have a response body.
public
static fromEmpty(Response $response) : EmptyResource
Parameters
- $response : Response
-
(optional) The Recurly HTTP Response
Return values
EmptyResource —fromResponse()
Converts a Recurly response object into a \Recurly\RecurlyResource.
public
static fromResponse(Response $response[, object $json = null ]) : RecurlyResource
Parameters
- $response : Response
-
The Recurly HTTP Response
- $json : object = null
-
(optional) JSON payload to use instead of the $response's. Primarily used for errors
Return values
RecurlyResource —An instance of a Recurly Resource
getCreatedAt()
Getter method for the created_at attribute.
public
getCreatedAt() : string|null
When the external product was created in Recurly.
Return values
string|null —getExternalConnectionType()
Getter method for the external_connection_type attribute.
public
getExternalConnectionType() : string|null
Source connection platform.
Return values
string|null —getId()
Getter method for the id attribute.
public
getId() : string|null
System-generated unique identifier for an external product ID, e.g. e28zov4fw0v2.
Return values
string|null —getObject()
Getter method for the object attribute.
public
getObject() : string|null
object
Return values
string|null —getReferenceCode()
Getter method for the reference_code attribute.
public
getReferenceCode() : string|null
A code which associates the external product to a corresponding object or resource in an external platform like the Apple App Store or Google Play Store.
Return values
string|null —getResponse()
Getter for the Recurly HTTP Response
public
getResponse() : Response
Return values
Response —The Recurly HTTP Response
getUpdatedAt()
Getter method for the updated_at attribute.
public
getUpdatedAt() : string|null
When the external product was updated in Recurly.
Return values
string|null —setCreatedAt()
Setter method for the created_at attribute.
public
setCreatedAt(string $created_at) : void
Parameters
- $created_at : string
Return values
void —setExternalConnectionType()
Setter method for the external_connection_type attribute.
public
setExternalConnectionType(string $external_connection_type) : void
Parameters
- $external_connection_type : string
Return values
void —setId()
Setter method for the id attribute.
public
setId(string $id) : void
Parameters
- $id : string
Return values
void —setObject()
Setter method for the object attribute.
public
setObject(string $object) : void
Parameters
- $object : string
Return values
void —setReferenceCode()
Setter method for the reference_code attribute.
public
setReferenceCode(string $reference_code) : void
Parameters
- $reference_code : string
Return values
void —setUpdatedAt()
Setter method for the updated_at attribute.
public
setUpdatedAt(string $updated_at) : void
Parameters
- $updated_at : string
Return values
void —encodeApiKey()
Base64 encodes the API key
protected
static encodeApiKey(string $key) : string
Parameters
- $key : string
-
The API key to encode
Return values
string —base64 encoded API key
getUserAgent()
Generates User-Agent for API requests
protected
static getUserAgent() : string
Return values
string —Recurly client User-Agent string
hintArrayType()
The hintArrayType method will provide type hinting for setter methods that have array parameters.
protected
static hintArrayType(string $key) : string
Parameters
- $key : string
-
The property to get teh type hint for.
Return values
string —The class name of the expected array type.
resourceClass()
Converts a string into a representation of a Recurly Resource
protected
static resourceClass(string $type) : string
Parameters
- $type : string
-
A string to convert to a Recurly Resource
Return values
string —The string representation of a Recurly Resource
setResponse()
Setter for the Recurly HTTP Response
protected
setResponse(Response $response) : void
Parameters
- $response : Response
-
The Recurly HTTP Response
Return values
void —setterParamClass()
Uses the Reflection API to determine what \Recurly\RecurlyResource is the expected parameter for the given method.
protected
static setterParamClass(string $method) : string
Parameters
- $method : string
-
The name of the setter method to find the type hint for
Return values
string —The \Recurly\RecurlyResource that the setter method expects
titleize()
Capitalizes all the words in the $input.
protected
static titleize(string $input[, string $prefix = '' ]) : string
Parameters
- $input : string
-
The string to titleize
- $prefix : string = ''
-
(optional) Prefix to add to the beginning of the titleized string. The prefix will not be titleized.
Return values
string —The titleized $input wtih the prepended $prefix