Recurly v3 API

ExportFile extends RecurlyResource

Table of Contents

$array_hints  : mixed
$_href  : mixed
$_md5sum  : mixed
$_name  : mixed
$_response  : 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.
getHref()  : string|null
Getter method for the href attribute.
getMd5sum()  : string|null
Getter method for the md5sum attribute.
getName()  : string|null
Getter method for the name attribute.
getResponse()  : Response
Getter for the Recurly HTTP Response
setHref()  : void
Setter method for the href attribute.
setMd5sum()  : void
Setter method for the md5sum attribute.
setName()  : void
Setter method for the name 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 = []

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
codeCoverageIgnore
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
codeCoverageIgnore
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

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

getHref()

Getter method for the href attribute.

public getHref() : string|null

A presigned link to download the export file.

Return values
string|null —

getMd5sum()

Getter method for the md5sum attribute.

public getMd5sum() : string|null

MD5 hash of the export file.

Return values
string|null —

getName()

Getter method for the name attribute.

public getName() : string|null

Name of the export file.

Return values
string|null —

setHref()

Setter method for the href attribute.

public setHref(string $href) : void
Parameters
$href : string
Return values
void —

setMd5sum()

Setter method for the md5sum attribute.

public setMd5sum(string $md5sum) : void
Parameters
$md5sum : string
Return values
void —

setName()

Setter method for the name attribute.

public setName(string $name) : void
Parameters
$name : 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

Search results