CustomFieldDefinition extends RecurlyResource
Table of Contents
- $array_hints : mixed
- $_created_at : mixed
- $_deleted_at : mixed
- $_display_name : mixed
- $_id : mixed
- $_name : mixed
- $_object : mixed
- $_related_type : mixed
- $_response : mixed
- $_tooltip : mixed
- $_updated_at : mixed
- $_user_access : 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.
- getDeletedAt() : string|null
- Getter method for the deleted_at attribute.
- getDisplayName() : string|null
- Getter method for the display_name attribute.
- getId() : string|null
- Getter method for the id attribute.
- getName() : string|null
- Getter method for the name attribute.
- getObject() : string|null
- Getter method for the object attribute.
- getRelatedType() : string|null
- Getter method for the related_type attribute.
- getResponse() : Response
- Getter for the Recurly HTTP Response
- getTooltip() : string|null
- Getter method for the tooltip attribute.
- getUpdatedAt() : string|null
- Getter method for the updated_at attribute.
- getUserAccess() : string|null
- Getter method for the user_access attribute.
- setCreatedAt() : void
- Setter method for the created_at attribute.
- setDeletedAt() : void
- Setter method for the deleted_at attribute.
- setDisplayName() : void
- Setter method for the display_name attribute.
- setId() : void
- Setter method for the id attribute.
- setName() : void
- Setter method for the name attribute.
- setObject() : void
- Setter method for the object attribute.
- setRelatedType() : void
- Setter method for the related_type attribute.
- setTooltip() : void
- Setter method for the tooltip attribute.
- setUpdatedAt() : void
- Setter method for the updated_at attribute.
- setUserAccess() : void
- Setter method for the user_access 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
$_deleted_at
private
mixed
$_deleted_at
$_display_name
private
mixed
$_display_name
$_id
private
mixed
$_id
$_name
private
mixed
$_name
$_object
private
mixed
$_object
$_related_type
private
mixed
$_related_type
$_response
private
mixed
$_response
$_tooltip
private
mixed
$_tooltip
$_updated_at
private
mixed
$_updated_at
$_user_access
private
mixed
$_user_access
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
Created at
Return values
string|null —getDeletedAt()
Getter method for the deleted_at attribute.
public
getDeletedAt() : string|null
Definitions are initially soft deleted, and once all the values are removed from the accouts or subscriptions, will be hard deleted an no longer visible.
Return values
string|null —getDisplayName()
Getter method for the display_name attribute.
public
getDisplayName() : string|null
Used to label the field when viewing and editing the field in Recurly's admin UI.
Return values
string|null —getId()
Getter method for the id attribute.
public
getId() : string|null
Custom field definition ID
Return values
string|null —getName()
Getter method for the name attribute.
public
getName() : string|null
Used by the API to identify the field or reading and writing. The name can only be used once per Recurly object type.
Return values
string|null —getObject()
Getter method for the object attribute.
public
getObject() : string|null
Object type
Return values
string|null —getRelatedType()
Getter method for the related_type attribute.
public
getRelatedType() : string|null
Related Recurly object type
Return values
string|null —getResponse()
Getter for the Recurly HTTP Response
public
getResponse() : Response
Return values
Response —The Recurly HTTP Response
getTooltip()
Getter method for the tooltip attribute.
public
getTooltip() : string|null
Displayed as a tooltip when editing the field in the Recurly admin UI.
Return values
string|null —getUpdatedAt()
Getter method for the updated_at attribute.
public
getUpdatedAt() : string|null
Last updated at
Return values
string|null —getUserAccess()
Getter method for the user_access attribute.
public
getUserAccess() : string|null
The access control applied inside Recurly's admin UI:
-
api_only- No one will be able to view or edit this field's data via the admin UI. -
read_only- Users with the Customers role will be able to view this field's data via the admin UI, but editing will only be available via the API. -
write- Users with the Customers role will be able to view and edit this field's data via the admin UI. -
set_only- Users with the Customers role will be able to set this field's data via the admin console.
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 —setDeletedAt()
Setter method for the deleted_at attribute.
public
setDeletedAt(string $deleted_at) : void
Parameters
- $deleted_at : string
Return values
void —setDisplayName()
Setter method for the display_name attribute.
public
setDisplayName(string $display_name) : void
Parameters
- $display_name : string
Return values
void —setId()
Setter method for the id attribute.
public
setId(string $id) : void
Parameters
- $id : string
Return values
void —setName()
Setter method for the name attribute.
public
setName(string $name) : void
Parameters
- $name : string
Return values
void —setObject()
Setter method for the object attribute.
public
setObject(string $object) : void
Parameters
- $object : string
Return values
void —setRelatedType()
Setter method for the related_type attribute.
public
setRelatedType(string $related_type) : void
Parameters
- $related_type : string
Return values
void —setTooltip()
Setter method for the tooltip attribute.
public
setTooltip(string $tooltip) : void
Parameters
- $tooltip : 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 —setUserAccess()
Setter method for the user_access attribute.
public
setUserAccess(string $user_access) : void
Parameters
- $user_access : 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