Domain extends AbstractDescription
Retrieves item descriptions for domains
Table of Contents
Properties
| $date | |
| $options |
Methods
| __construct() | Init |
| get() | Constructs a description from the given meta item |
| _() | Shortcut for Language::_() |
| getProrateFields() | Retrieves a set of proration meta fields used in the descriptions |
| getBaseFields() | Retrieves a set of meta fields used in the descriptions |
| getCancel() | Generates a description from the service meta data for the cancel fee |
| getPackage() | Generates a description from the service meta data for the package |
| getService() | Generates a description from the service meta data for the service item |
| getSetup() | Generates a description from the service meta data for the setup fee |
Methods
__construct()
Init
public
__construct(Date $date[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $date : Date
- $options : array<string|int, mixed> = []
get()
Constructs a description from the given meta item
public
get(array<string|int, mixed> $meta[, array<string|int, mixed> $oldMeta = null ]) : string
Parameters
- $meta : array<string|int, mixed>
-
An array of meta information representing the item
- $oldMeta : array<string|int, mixed> = null
-
An array of old meta information representing the item (optional, only used to combine the two sets of meta data into a single description)
Return values
string —The description
_()
Shortcut for Language::_()
protected
_(string $name) : mixed
Parameters
- $name : string
-
The name of the language key to fetch
getProrateFields()
Retrieves a set of proration meta fields used in the descriptions
protected
getProrateFields(array<string|int, mixed> $meta) : array<string|int, mixed>
Parameters
- $meta : array<string|int, mixed>
-
An array of meta information
Return values
array<string|int, mixed> —An array of prorate fields
getBaseFields()
Retrieves a set of meta fields used in the descriptions
private
getBaseFields(array<string|int, mixed> $meta) : array<string|int, mixed>
Parameters
- $meta : array<string|int, mixed>
-
An array of meta information
Return values
array<string|int, mixed> —An array containing the service and package name
getCancel()
Generates a description from the service meta data for the cancel fee
private
getCancel(array<string|int, mixed> $meta[, array<string|int, mixed> $oldMeta = null ]) : string
Parameters
- $meta : array<string|int, mixed>
-
An array of meta information
- $oldMeta : array<string|int, mixed> = null
-
An array of old meta information representing the item (optional, only used to combine the two sets of meta data into a single description)
Return values
string —The description
getPackage()
Generates a description from the service meta data for the package
private
getPackage(array<string|int, mixed> $meta[, array<string|int, mixed> $oldMeta = null ]) : string
Parameters
- $meta : array<string|int, mixed>
-
An array of meta information
- $oldMeta : array<string|int, mixed> = null
-
An array of old meta information representing the item (optional, only used to combine the two sets of meta data into a single description)
Return values
string —The description
getService()
Generates a description from the service meta data for the service item
private
getService(array<string|int, mixed> $meta[, array<string|int, mixed> $oldMeta = null ]) : string
Parameters
- $meta : array<string|int, mixed>
-
An array of meta information
- $oldMeta : array<string|int, mixed> = null
-
An array of old meta information representing the item (optional, only used to combine the two sets of meta data into a single description)
Return values
string —The description
getSetup()
Generates a description from the service meta data for the setup fee
private
getSetup(array<string|int, mixed> $meta[, array<string|int, mixed> $oldMeta = null ]) : string
Parameters
- $meta : array<string|int, mixed>
-
An array of meta information
- $oldMeta : array<string|int, mixed> = null
-
An array of old meta information representing the item (optional, only used to combine the two sets of meta data into a single description)
Return values
string —The description