AddressWithName extends RecurlyResource
Table of Contents
- $array_hints : mixed
- $_city : mixed
- $_country : mixed
- $_first_name : mixed
- $_geo_code : mixed
- $_last_name : mixed
- $_phone : mixed
- $_postal_code : mixed
- $_region : mixed
- $_response : mixed
- $_street1 : mixed
- $_street2 : 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.
- getCity() : string|null
- Getter method for the city attribute.
- getCountry() : string|null
- Getter method for the country attribute.
- getFirstName() : string|null
- Getter method for the first_name attribute.
- getGeoCode() : string|null
- Getter method for the geo_code attribute.
- getLastName() : string|null
- Getter method for the last_name attribute.
- getPhone() : string|null
- Getter method for the phone attribute.
- getPostalCode() : string|null
- Getter method for the postal_code attribute.
- getRegion() : string|null
- Getter method for the region attribute.
- getResponse() : Response
- Getter for the Recurly HTTP Response
- getStreet1() : string|null
- Getter method for the street1 attribute.
- getStreet2() : string|null
- Getter method for the street2 attribute.
- setCity() : void
- Setter method for the city attribute.
- setCountry() : void
- Setter method for the country attribute.
- setFirstName() : void
- Setter method for the first_name attribute.
- setGeoCode() : void
- Setter method for the geo_code attribute.
- setLastName() : void
- Setter method for the last_name attribute.
- setPhone() : void
- Setter method for the phone attribute.
- setPostalCode() : void
- Setter method for the postal_code attribute.
- setRegion() : void
- Setter method for the region attribute.
- setStreet1() : void
- Setter method for the street1 attribute.
- setStreet2() : void
- Setter method for the street2 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
= []
$_city
private
mixed
$_city
$_country
private
mixed
$_country
$_first_name
private
mixed
$_first_name
$_geo_code
private
mixed
$_geo_code
$_last_name
private
mixed
$_last_name
$_phone
private
mixed
$_phone
$_postal_code
private
mixed
$_postal_code
$_region
private
mixed
$_region
$_response
private
mixed
$_response
$_street1
private
mixed
$_street1
$_street2
private
mixed
$_street2
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
getCity()
Getter method for the city attribute.
public
getCity() : string|null
City
Return values
string|null —getCountry()
Getter method for the country attribute.
public
getCountry() : string|null
Country, 2-letter ISO 3166-1 alpha-2 code.
Return values
string|null —getFirstName()
Getter method for the first_name attribute.
public
getFirstName() : string|null
First name
Return values
string|null —getGeoCode()
Getter method for the geo_code attribute.
public
getGeoCode() : string|null
Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
Return values
string|null —getLastName()
Getter method for the last_name attribute.
public
getLastName() : string|null
Last name
Return values
string|null —getPhone()
Getter method for the phone attribute.
public
getPhone() : string|null
Phone number
Return values
string|null —getPostalCode()
Getter method for the postal_code attribute.
public
getPostalCode() : string|null
Zip or postal code.
Return values
string|null —getRegion()
Getter method for the region attribute.
public
getRegion() : string|null
State or province.
Return values
string|null —getResponse()
Getter for the Recurly HTTP Response
public
getResponse() : Response
Return values
Response —The Recurly HTTP Response
getStreet1()
Getter method for the street1 attribute.
public
getStreet1() : string|null
Street 1
Return values
string|null —getStreet2()
Getter method for the street2 attribute.
public
getStreet2() : string|null
Street 2
Return values
string|null —setCity()
Setter method for the city attribute.
public
setCity(string $city) : void
Parameters
- $city : string
Return values
void —setCountry()
Setter method for the country attribute.
public
setCountry(string $country) : void
Parameters
- $country : string
Return values
void —setFirstName()
Setter method for the first_name attribute.
public
setFirstName(string $first_name) : void
Parameters
- $first_name : string
Return values
void —setGeoCode()
Setter method for the geo_code attribute.
public
setGeoCode(string $geo_code) : void
Parameters
- $geo_code : string
Return values
void —setLastName()
Setter method for the last_name attribute.
public
setLastName(string $last_name) : void
Parameters
- $last_name : string
Return values
void —setPhone()
Setter method for the phone attribute.
public
setPhone(string $phone) : void
Parameters
- $phone : string
Return values
void —setPostalCode()
Setter method for the postal_code attribute.
public
setPostalCode(string $postal_code) : void
Parameters
- $postal_code : string
Return values
void —setRegion()
Setter method for the region attribute.
public
setRegion(string $region) : void
Parameters
- $region : string
Return values
void —setStreet1()
Setter method for the street1 attribute.
public
setStreet1(string $street1) : void
Parameters
- $street1 : string
Return values
void —setStreet2()
Setter method for the street2 attribute.
public
setStreet2(string $street2) : void
Parameters
- $street2 : 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