YetiForceWebservicePremium
extends AbstractBaseProduct
in package
YetiForce shop YetiForce Webservice Premium class.
Table of Contents
- DEFAULT_CURRENCY = 'EUR'
- $active : bool
- Is the product active.
- $category : string
- Product category.
- $description : string
- Description.
- $disabled : bool
- $expirationDate : string|null
- Expiration date.
- $featured : bool
- Is the product featured.
- $id : string
- Product ID.
- $image : string|null
- Image.
- $introduction : string
- Introduction / short description.
- $label : string
- Product label.
- $name : string
- Product name.
- $package : Package
- Fit package.
- $packages : array<string|int, mixed>
- Price packages.
- $website : string
- Product website.
- $status : bool
- __construct() : mixed
- Constructor.
- analyzeConfiguration() : array<string|int, mixed>
- Analyze the configuration.
- fromArray() : static
- Construct.
- getAdditionalButtons() : array<string|int, Vtiger_Link_Model>
- Product modal additional buttons.
- getAlertMessage() : array<string|int, mixed>
- Show alert in marketplace.
- getCategory() : string
- Get category.
- getCurrencyCode() : string
- Get currency code.
- getDescription() : string
- Get product description.
- getExpirationDate() : string|null
- Get expiration date.
- getFitPackage() : Package|null
- Get fit package.
- getId() : string
- Get product ID.
- getImage() : string|null
- Get product image.
- getIntroduction() : string
- Get product description.
- getLabel() : string
- Get product label.
- getName() : string
- Get product name.
- getPackages() : array<string|int, Package>
- Price packages.
- getPaymentFrequency() : string
- The period for which the service is purchased.
- getPaymentFrequencyShort() : string
- Get short period name for which the service is purchased.
- getPrice() : int
- Get product price.
- getStatus() : bool
- Get subscription status.
- getSwitchButton() : Vtiger_Link_Model|null
- Switch button to activate/deactivate service.
- getVariable() : array<string|int, mixed>
- Get variable product.
- isActive() : bool
- Check if the service is active.
- isAvailable() : bool
- Check if product is available.
- isConfigured() : bool
- Check if the product is configured correctly.
- isExpired() : bool
Constants
DEFAULT_CURRENCY
private
mixed
DEFAULT_CURRENCY
= 'EUR'
Properties
$active
Is the product active.
protected
bool
$active
$category
Product category.
protected
string
$category
$description
Description.
protected
string
$description
$disabled
protected
bool
$disabled
= false
Disabled product
$expirationDate
Expiration date.
protected
string|null
$expirationDate
$featured
Is the product featured.
protected
bool
$featured
$id
Product ID.
protected
string
$id
$image
Image.
protected
string|null
$image
$introduction
Introduction / short description.
protected
string
$introduction
$label
Product label.
protected
string
$label
$name
Product name.
protected
string
$name
$package
Fit package.
protected
Package
$package
$packages
Price packages.
protected
array<string|int, mixed>
$packages
= []
$website
Product website.
protected
string
$website
$status
private
bool
$status
= false
Status
Methods
__construct()
Constructor.
public
__construct(string $productName) : mixed
Parameters
- $productName : string
Return values
mixed —analyzeConfiguration()
Analyze the configuration.
public
analyzeConfiguration() : array<string|int, mixed>
Return values
array<string|int, mixed> —fromArray()
Construct.
public
static fromArray(array<string|int, mixed> $data) : static
Parameters
- $data : array<string|int, mixed>
Return values
static —getAdditionalButtons()
Product modal additional buttons.
public
getAdditionalButtons() : array<string|int, Vtiger_Link_Model>
Return values
array<string|int, Vtiger_Link_Model> —getAlertMessage()
Show alert in marketplace.
public
getAlertMessage([bool $require = true ]) : array<string|int, mixed>
Parameters
- $require : bool = true
Return values
array<string|int, mixed> —getCategory()
Get category.
public
getCategory() : string
Return values
string —getCurrencyCode()
Get currency code.
public
getCurrencyCode() : string
Return values
string —getDescription()
Get product description.
public
getDescription() : string
Return values
string —getExpirationDate()
Get expiration date.
public
getExpirationDate() : string|null
Return values
string|null —getFitPackage()
Get fit package.
public
getFitPackage() : Package|null
Return values
Package|null —getId()
Get product ID.
public
getId() : string
Return values
string —getImage()
Get product image.
public
getImage() : string|null
Return values
string|null —getIntroduction()
Get product description.
public
getIntroduction() : string
Return values
string —getLabel()
Get product label.
public
getLabel() : string
Return values
string —getName()
Get product name.
public
getName() : string
Return values
string —getPackages()
Price packages.
public
getPackages() : array<string|int, Package>
Return values
array<string|int, Package> —getPaymentFrequency()
The period for which the service is purchased.
public
getPaymentFrequency() : string
Return values
string —getPaymentFrequencyShort()
Get short period name for which the service is purchased.
public
getPaymentFrequencyShort() : string
Return values
string —getPrice()
Get product price.
public
getPrice() : int
Return values
int —getStatus()
Get subscription status.
public
getStatus() : bool
Return values
bool —getSwitchButton()
Switch button to activate/deactivate service.
public
getSwitchButton() : Vtiger_Link_Model|null
Return values
Vtiger_Link_Model|null —getVariable()
Get variable product.
public
getVariable() : array<string|int, mixed>
Return values
array<string|int, mixed> —isActive()
Check if the service is active.
public
isActive() : bool
Return values
bool —isAvailable()
Check if product is available.
public
isAvailable() : bool
Return values
bool —isConfigured()
Check if the product is configured correctly.
public
isConfigured() : bool
Return values
bool —isExpired()
public
isExpired() : bool