CouponMini extends RecurlyResource
Table of Contents
- $array_hints : mixed
- $_code : mixed
- $_coupon_type : mixed
- $_discount : mixed
- $_expired_at : mixed
- $_id : mixed
- $_name : mixed
- $_object : mixed
- $_response : mixed
- $_state : 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.
- getCode() : string|null
- Getter method for the code attribute.
- getCouponType() : string|null
- Getter method for the coupon_type attribute.
- getDiscount() : CouponDiscount|null
- Getter method for the discount attribute.
- getExpiredAt() : string|null
- Getter method for the expired_at 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.
- getResponse() : Response
- Getter for the Recurly HTTP Response
- getState() : string|null
- Getter method for the state attribute.
- setCode() : void
- Setter method for the code attribute.
- setCouponType() : void
- Setter method for the coupon_type attribute.
- setDiscount() : void
- Setter method for the discount attribute.
- setExpiredAt() : void
- Setter method for the expired_at 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.
- setState() : void
- Setter method for the state 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
= []
$_code
private
mixed
$_code
$_coupon_type
private
mixed
$_coupon_type
$_discount
private
mixed
$_discount
$_expired_at
private
mixed
$_expired_at
$_id
private
mixed
$_id
$_name
private
mixed
$_name
$_object
private
mixed
$_object
$_response
private
mixed
$_response
$_state
private
mixed
$_state
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
getCode()
Getter method for the code attribute.
public
getCode() : string|null
The code the customer enters to redeem the coupon.
Return values
string|null —getCouponType()
Getter method for the coupon_type attribute.
public
getCouponType() : string|null
Whether the coupon is "single_code" or "bulk". Bulk coupons will require a unique_code_template and will generate unique codes through the /generate endpoint.
Return values
string|null —getDiscount()
Getter method for the discount attribute.
public
getDiscount() : CouponDiscount|null
Details of the discount a coupon applies. Will contain a type
property and one of the following properties: percent, fixed, trial.
Return values
CouponDiscount|null —getExpiredAt()
Getter method for the expired_at attribute.
public
getExpiredAt() : string|null
The date and time the coupon was expired early or reached its max_redemptions.
Return values
string|null —getId()
Getter method for the id attribute.
public
getId() : string|null
Coupon ID
Return values
string|null —getName()
Getter method for the name attribute.
public
getName() : string|null
The internal name for the coupon.
Return values
string|null —getObject()
Getter method for the object attribute.
public
getObject() : string|null
Object type
Return values
string|null —getResponse()
Getter for the Recurly HTTP Response
public
getResponse() : Response
Return values
Response —The Recurly HTTP Response
getState()
Getter method for the state attribute.
public
getState() : string|null
Indicates if the coupon is redeemable, and if it is not, why.
Return values
string|null —setCode()
Setter method for the code attribute.
public
setCode(string $code) : void
Parameters
- $code : string
Return values
void —setCouponType()
Setter method for the coupon_type attribute.
public
setCouponType(string $coupon_type) : void
Parameters
- $coupon_type : string
Return values
void —setDiscount()
Setter method for the discount attribute.
public
setDiscount(CouponDiscount $discount) : void
Parameters
- $discount : CouponDiscount
Return values
void —setExpiredAt()
Setter method for the expired_at attribute.
public
setExpiredAt(string $expired_at) : void
Parameters
- $expired_at : 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 —setState()
Setter method for the state attribute.
public
setState(string $state) : void
Parameters
- $state : 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