Recurly v3 API

Site extends RecurlyResource

Table of Contents

$array_hints  : mixed
$_address  : mixed
$_created_at  : mixed
$_deleted_at  : mixed
$_features  : mixed
$_id  : mixed
$_mode  : mixed
$_object  : mixed
$_public_api_key  : mixed
$_response  : mixed
$_settings  : mixed
$_subdomain  : 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.
getAddress()  : Address|null
Getter method for the address attribute.
getCreatedAt()  : string|null
Getter method for the created_at attribute.
getDeletedAt()  : string|null
Getter method for the deleted_at attribute.
getFeatures()  : array<string|int, mixed>
Getter method for the features attribute.
getId()  : string|null
Getter method for the id attribute.
getMode()  : string|null
Getter method for the mode attribute.
getObject()  : string|null
Getter method for the object attribute.
getPublicApiKey()  : string|null
Getter method for the public_api_key attribute.
getResponse()  : Response
Getter for the Recurly HTTP Response
getSettings()  : Settings|null
Getter method for the settings attribute.
getSubdomain()  : string|null
Getter method for the subdomain attribute.
getUpdatedAt()  : string|null
Getter method for the updated_at attribute.
setAddress()  : void
Setter method for the address attribute.
setCreatedAt()  : void
Setter method for the created_at attribute.
setDeletedAt()  : void
Setter method for the deleted_at attribute.
setFeatures()  : void
Setter method for the features attribute.
setId()  : void
Setter method for the id attribute.
setMode()  : void
Setter method for the mode attribute.
setObject()  : void
Setter method for the object attribute.
setPublicApiKey()  : void
Setter method for the public_api_key attribute.
setSettings()  : void
Setter method for the settings attribute.
setSubdomain()  : void
Setter method for the subdomain 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 = ['setFeatures' => 'string']

$_address

private mixed $_address

$_created_at

private mixed $_created_at

$_deleted_at

private mixed $_deleted_at

$_features

private mixed $_features

$_mode

private mixed $_mode

$_object

private mixed $_object

$_public_api_key

private mixed $_public_api_key

$_settings

private mixed $_settings

$_subdomain

private mixed $_subdomain

$_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
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

getAddress()

Getter method for the address attribute.

public getAddress() : Address|null
Return values
Address|null

getCreatedAt()

Getter method for the created_at attribute.

public getCreatedAt() : string|null

Created at

Return values
string|null

getDeletedAt()

Getter method for the deleted_at attribute.

public getDeletedAt() : string|null

Deleted at

Return values
string|null

getFeatures()

Getter method for the features attribute.

public getFeatures() : array<string|int, mixed>

A list of features enabled for the site.

Return values
array<string|int, mixed>

getId()

Getter method for the id attribute.

public getId() : string|null

Site ID

Return values
string|null

getMode()

Getter method for the mode attribute.

public getMode() : string|null

Mode

Return values
string|null

getObject()

Getter method for the object attribute.

public getObject() : string|null

Object type

Return values
string|null

getPublicApiKey()

Getter method for the public_api_key attribute.

public getPublicApiKey() : string|null

This value is used to configure RecurlyJS to submit tokenized billing information.

Return values
string|null

getSettings()

Getter method for the settings attribute.

public getSettings() : Settings|null
Return values
Settings|null

getSubdomain()

Getter method for the subdomain attribute.

public getSubdomain() : string|null
Return values
string|null

getUpdatedAt()

Getter method for the updated_at attribute.

public getUpdatedAt() : string|null

Updated at

Return values
string|null

setAddress()

Setter method for the address attribute.

public setAddress(Address $address) : void
Parameters
$address : Address
Return values
void

setCreatedAt()

Setter method for the created_at attribute.

public setCreatedAt(string $created_at) : void
Parameters
$created_at : string
Return values
void

setDeletedAt()

Setter method for the deleted_at attribute.

public setDeletedAt(string $deleted_at) : void
Parameters
$deleted_at : string
Return values
void

setFeatures()

Setter method for the features attribute.

public setFeatures(array<string|int, mixed> $features) : void
Parameters
$features : array<string|int, mixed>
Return values
void

setId()

Setter method for the id attribute.

public setId(string $id) : void
Parameters
$id : string
Return values
void

setMode()

Setter method for the mode attribute.

public setMode(string $mode) : void
Parameters
$mode : string
Return values
void

setObject()

Setter method for the object attribute.

public setObject(string $object) : void
Parameters
$object : string
Return values
void

setPublicApiKey()

Setter method for the public_api_key attribute.

public setPublicApiKey(string $public_api_key) : void
Parameters
$public_api_key : string
Return values
void

setSettings()

Setter method for the settings attribute.

public setSettings(Settings $settings) : void
Parameters
$settings : Settings
Return values
void

setSubdomain()

Setter method for the subdomain attribute.

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

Search results