Membership
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
Membership Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- CURRENCY_JPY = 'JPY'
- CURRENCY_THB = 'THB'
- CURRENCY_TWD = 'TWD'
- DISCRIMINATOR = null
- $attributeMap : array<string|int, string>
- Array of attributes where the key is the local name, and the value is the original name
- $container : array<string|int, mixed>
- Associative array for storing property values
- $getters : array<string|int, string>
- Array of attributes to getter functions (for serialization of requests)
- $openAPIFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $openAPIModelName : string
- The original name of the model.
- $openAPINullables : array<string|int, mixed>
- Array of nullable properties. Used for (de)serialization
- $openAPINullablesSetToNull : array<string|int, mixed>
- If a nullable field gets set to null, insert it here
- $openAPITypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- $setters : array<string|int, string>
- Array of attributes to setter functions (for deserialization of responses)
- __construct() : mixed
- Constructor
- __toString() : string
- Gets the string presentation of the object
- attributeMap() : array<string|int, mixed>
- Array of attributes where the key is the local name, and the value is the original name
- getBenefits() : array<string|int, string>
- Gets benefits
- getCurrency() : string
- Gets currency
- getCurrencyAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getDescription() : string
- Gets description
- getIsInAppPurchase() : bool
- Gets isInAppPurchase
- getIsPublished() : bool
- Gets isPublished
- getMemberCount() : int
- Gets memberCount
- getMemberLimit() : int
- Gets memberLimit
- getMembershipId() : int
- Gets membershipId
- getModelName() : string
- The original name of the model.
- getPrice() : float
- Gets price
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTitle() : string
- Gets title
- isNullable() : bool
- Checks if a property is nullable
- isNullableSetToNull() : bool
- Checks if a nullable property is set to null.
- jsonSerialize() : mixed
- Serializes the object to a value that can be serialized natively by json_encode().
- listInvalidProperties() : array<string|int, mixed>
- Show all the invalid properties with reasons.
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed|null
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- openAPIFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- openAPITypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
- setBenefits() : self
- Sets benefits
- setCurrency() : self
- Sets currency
- setDescription() : self
- Sets description
- setIsInAppPurchase() : self
- Sets isInAppPurchase
- setIsPublished() : self
- Sets isPublished
- setMemberCount() : self
- Sets memberCount
- setMemberLimit() : self
- Sets memberLimit
- setMembershipId() : self
- Sets membershipId
- setPrice() : self
- Sets price
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTitle() : self
- Sets title
- toHeaderValue() : string
- Gets a header-safe presentation of the object
- valid() : bool
- Validate all the properties in the model return true if all passed
- openAPINullables() : array<string|int, mixed>
- Array of nullable properties
- getOpenAPINullablesSetToNull() : array<string|int, bool>
- Array of nullable field names deliberately set to null
- setIfExists() : void
- Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
- setOpenAPINullablesSetToNull() : void
- Setter - Array of nullable field names deliberately set to null
Constants
CURRENCY_JPY
public
mixed
CURRENCY_JPY
= 'JPY'
CURRENCY_THB
public
mixed
CURRENCY_THB
= 'THB'
CURRENCY_TWD
public
mixed
CURRENCY_TWD
= 'TWD'
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
Properties
$attributeMap
Array of attributes where the key is the local name, and the value is the original name
protected
static array<string|int, string>
$attributeMap
= ['membershipId' => 'membershipId', 'title' => 'title', 'description' => 'description', 'benefits' => 'benefits', 'price' => 'price', 'currency' => 'currency', 'memberCount' => 'memberCount', 'memberLimit' => 'memberLimit', 'isInAppPurchase' => 'isInAppPurchase', 'isPublished' => 'isPublished']
$container
Associative array for storing property values
protected
array<string|int, mixed>
$container
= []
$getters
Array of attributes to getter functions (for serialization of requests)
protected
static array<string|int, string>
$getters
= ['membershipId' => 'getMembershipId', 'title' => 'getTitle', 'description' => 'getDescription', 'benefits' => 'getBenefits', 'price' => 'getPrice', 'currency' => 'getCurrency', 'memberCount' => 'getMemberCount', 'memberLimit' => 'getMemberLimit', 'isInAppPurchase' => 'getIsInAppPurchase', 'isPublished' => 'getIsPublished']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['membershipId' => null, 'title' => null, 'description' => null, 'benefits' => null, 'price' => 'double', 'currency' => null, 'memberCount' => null, 'memberLimit' => null, 'isInAppPurchase' => null, 'isPublished' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'Membership'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['membershipId' => false, 'title' => false, 'description' => false, 'benefits' => false, 'price' => false, 'currency' => false, 'memberCount' => false, 'memberLimit' => true, 'isInAppPurchase' => false, 'isPublished' => false]
$openAPINullablesSetToNull
If a nullable field gets set to null, insert it here
protected
array<string|int, mixed>
$openAPINullablesSetToNull
= []
$openAPITypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPITypes
= ['membershipId' => 'int', 'title' => 'string', 'description' => 'string', 'benefits' => 'string[]', 'price' => 'float', 'currency' => 'string', 'memberCount' => 'int', 'memberLimit' => 'int', 'isInAppPurchase' => 'bool', 'isPublished' => 'bool']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['membershipId' => 'setMembershipId', 'title' => 'setTitle', 'description' => 'setDescription', 'benefits' => 'setBenefits', 'price' => 'setPrice', 'currency' => 'setCurrency', 'memberCount' => 'setMemberCount', 'memberLimit' => 'setMemberLimit', 'isInAppPurchase' => 'setIsInAppPurchase', 'isPublished' => 'setIsPublished']
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
- $data : array<string|int, mixed> = null
-
Associated array of property values initializing the model
Return values
mixed —__toString()
Gets the string presentation of the object
public
__toString() : string
Return values
string —attributeMap()
Array of attributes where the key is the local name, and the value is the original name
public
static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getBenefits()
Gets benefits
public
getBenefits() : array<string|int, string>
Return values
array<string|int, string> —getCurrency()
Gets currency
public
getCurrency() : string
Return values
string —getCurrencyAllowableValues()
Gets allowable values of the enum
public
getCurrencyAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getDescription()
Gets description
public
getDescription() : string
Return values
string —getIsInAppPurchase()
Gets isInAppPurchase
public
getIsInAppPurchase() : bool
Return values
bool —getIsPublished()
Gets isPublished
public
getIsPublished() : bool
Return values
bool —getMemberCount()
Gets memberCount
public
getMemberCount() : int
Return values
int —getMemberLimit()
Gets memberLimit
public
getMemberLimit() : int
Return values
int —getMembershipId()
Gets membershipId
public
getMembershipId() : int
Return values
int —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPrice()
Gets price
public
getPrice() : float
Return values
float —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getTitle()
Gets title
public
getTitle() : string
Return values
string —isNullable()
Checks if a property is nullable
public
static isNullable(string $property) : bool
Parameters
- $property : string
Return values
bool —isNullableSetToNull()
Checks if a nullable property is set to null.
public
isNullableSetToNull(string $property) : bool
Parameters
- $property : string
Return values
bool —jsonSerialize()
Serializes the object to a value that can be serialized natively by json_encode().
public
jsonSerialize() : mixed
Tags
Return values
mixed —Returns data which can be serialized by json_encode(), which is a value of any type other than a resource.
listInvalidProperties()
Show all the invalid properties with reasons.
public
listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —invalid properties with reasons
offsetExists()
Returns true if offset exists. False otherwise.
public
offsetExists(int $offset) : bool
Parameters
- $offset : int
-
Offset
Return values
bool —offsetGet()
Gets offset.
public
offsetGet(int $offset) : mixed|null
Parameters
- $offset : int
-
Offset
Return values
mixed|null —offsetSet()
Sets value based on offset.
public
offsetSet(int|null $offset, mixed $value) : void
Parameters
- $offset : int|null
-
Offset
- $value : mixed
-
Value to be set
Return values
void —offsetUnset()
Unsets offset.
public
offsetUnset(int $offset) : void
Parameters
- $offset : int
-
Offset
Return values
void —openAPIFormats()
Array of property to format mappings. Used for (de)serialization
public
static openAPIFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —openAPITypes()
Array of property to type mappings. Used for (de)serialization
public
static openAPITypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —setBenefits()
Sets benefits
public
setBenefits(array<string|int, string> $benefits) : self
Parameters
- $benefits : array<string|int, string>
-
List of membership plan perks.
Return values
self —setCurrency()
Sets currency
public
setCurrency(string $currency) : self
Parameters
- $currency : string
-
The currency of membership.price.
Return values
self —setDescription()
Sets description
public
setDescription(string $description) : self
Parameters
- $description : string
-
Membership plan description.
Return values
self —setIsInAppPurchase()
Sets isInAppPurchase
public
setIsInAppPurchase(bool $isInAppPurchase) : self
Parameters
- $isInAppPurchase : bool
-
Payment method for users who subscribe to a membership plan.
Return values
self —setIsPublished()
Sets isPublished
public
setIsPublished(bool $isPublished) : self
Parameters
- $isPublished : bool
-
Membership plan status.
Return values
self —setMemberCount()
Sets memberCount
public
setMemberCount(int $memberCount) : self
Parameters
- $memberCount : int
-
Number of members subscribed to the membership plan.
Return values
self —setMemberLimit()
Sets memberLimit
public
setMemberLimit(int $memberLimit) : self
Parameters
- $memberLimit : int
-
The upper limit of members who can subscribe. If no upper limit is set, it will be null.
Return values
self —setMembershipId()
Sets membershipId
public
setMembershipId(int $membershipId) : self
Parameters
- $membershipId : int
-
Membership plan ID.
Return values
self —setPrice()
Sets price
public
setPrice(float $price) : self
Parameters
- $price : float
-
Monthly fee for membership plan. (e.g. 1500.00)
Return values
self —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —setTitle()
Sets title
public
setTitle(string $title) : self
Parameters
- $title : string
-
Membership plan name.
Return values
self —toHeaderValue()
Gets a header-safe presentation of the object
public
toHeaderValue() : string
Return values
string —valid()
Validate all the properties in the model return true if all passed
public
valid() : bool
Return values
bool —True if all properties are valid
openAPINullables()
Array of nullable properties
protected
static openAPINullables() : array<string|int, mixed>
Return values
array<string|int, mixed> —getOpenAPINullablesSetToNull()
Array of nullable field names deliberately set to null
private
getOpenAPINullablesSetToNull() : array<string|int, bool>
Return values
array<string|int, bool> —setIfExists()
Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
private
setIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void
Parameters
- $variableName : string
- $fields : array<string|int, mixed>
- $defaultValue : mixed
Return values
void —setOpenAPINullablesSetToNull()
Setter - Array of nullable field names deliberately set to null
private
setOpenAPINullablesSetToNull(array<string|int, bool> $openAPINullablesSetToNull) : void
Parameters
- $openAPINullablesSetToNull : array<string|int, bool>