Index | WHMCS Internal Class Documentation

A

Announcement — Class in namespace WHMCS\Announcement: A client-facing general announcement.
$Announcement — Property in class Announcement: Content of the announcement, in HTML.
$Invoice — Property in class Invoice
Invoice::addPayment() — Method in class Invoice
$Item — Property in class Item: Total amount due for this line item.
$Item — Property in class Item: The related model for the addon invoice item
Item::addon() — Method in class Item
$Transaction — Property in class Transaction: Gross amount paid by the client in this transaction.
$Transaction — Property in class Transaction: Gross amount returned to the client via this transaction.
$Quote — Property in class Quote: First address line of the prospective client requesting the quote.
$Quote — Property in class Quote: Second address line of the prospective client requesting the quote.
$Quote — Property in class Quote: Freeform notes provided by the admin which should not be displayed to the client or on the quote.
Setting::allDefaults() — Method in class Setting: Retrieve a collection of models that each have a default value assigned
Setting::allAsArray() — Method in class Setting: Retrieve all settings as a key value pair array.
$CustomField — Property in class CustomField: Is the field only visible for Admins
$CustomField — Property in class CustomField: The product addon a custom field belongs to
CustomField::addon() — Method in class CustomField: A custom field can belong to a single product addon.
$CustomFieldValue — Property in class CustomFieldValue
CustomFieldValue::addon() — Method in class CustomFieldValue
AdditionalField — Class in namespace WHMCS\Domain: Domain additional fields.
$Domain — Property in class Domain
$Domain — Property in class Domain: Additional notes provided by the admin. Should not be displayed to the client.
$Domain — Property in class Domain: All additional fields belonging to this domain's registration.
Domain::additionalFields() — Method in class Domain: Every domain can have one or more additional registrar-specific fields.
Download::asLink() — Method in class Download: Represent a download as a file download link.
$Template — Property in class Template: Comma delimited list of filenames for files that should be attached to the outgoing email, with it's root at /downloads/
AbstractWidget — Class in namespace WHMCS\Module: Abstract Widget.
$AbstractWidget — Property in class AbstractWidget
$Queue — Property in class Queue: The related domain
Queue::add() — Method in class Queue: Add module queue entry.
Queue::addon() — Method in class Queue
$NetworkIssue — Property in class NetworkIssue: An English language internal name for the type of network issue: 'server' (affects a hosting server), 'system' (affects the billing or support systems), 'other' (user defined)
$NetworkIssue — Property in class NetworkIssue: A string which is displayed as the network issue type if "other" is the affectedType.
$NetworkIssue — Property in class NetworkIssue: The Unique ID number of the server affected, if "server" is the affectedType.
NotificationInterface::addAttribute() — Method in class NotificationInterface
Addon — Class in namespace WHMCS\Product: tbladdons model class
$Addon — Property in class Addon: Whether or not tax should be applied to an addon.
$Addon — Property in class Addon: When provisioning of an addon should take place, either "order", "payment", "on", or "".
$Addon — Property in class Addon: An array of criterias for choosing products to auto-assign this addon to if allowed by admin
$Product — Property in class Product
$Product — Property in class Product: Whether or not customers may specify if they want more than one of this item when purchasing.
$Product — Property in class Product: When provisioning a product should take place, either "order", "payment", "on", or "".
$Product — Property in class Product: The id of the email to send to a client when a product is automatically terminated.
$Product — Property in class Product: Whether or not a product's configurable options can be upgraded and downgraded.
$Product — Property in class Product: Whether or not tax should be applied to a product.
$Product — Property in class Product: Whether or not affiliates should only be paid on a product once, even if it's a recurring product.
$Product — Property in class Product: The type of payment available for affiliates that successfully promote a product, either "percentage", "fixed", "none", or "" (the default payout method).
$Product — Property in class Product: The percent or fixed amount which should be paid to affiliates.
$Product — Property in class Product: The email to send to a client when a product is automatically terminated.
Product::autoTerminationEmailTemplate() — Method in class Product: A product has one auto termination email template.
Product::assignMatchingMarketConnectAddons() — Method in class Product
AbstractTask — Class in namespace WHMCS\Scheduling\Task: AbstractTask
$AbstractTask — Property in class AbstractTask
AbstractTask::anticipatedNextRun() — Method in class AbstractTask
AbstractTask::anticipatedNextMonthlyRun() — Method in class AbstractTask
Addon — Class in namespace WHMCS\Service: Service addons
$Addon — Property in class Addon
$Addon — Property in class Addon: ID of addon that this object is an instance of.
$Addon — Property in class Addon: True if tax is charged when purchasing/paying for this addon.
$Service — Property in class Service
$Service — Property in class Service: If the service is assigned to IP addresses, those addresses will appear as comma delimited strings here.
$Service — Property in class Service: Addons purchased alongside this service.
Service::addons() — Method in class Service: Each service can have many addons
Admin — Class in namespace WHMCS\User: An administrative user
$Admin — Property in class Admin
Admin::authenticationDevices() — Method in class Admin
AdminLog — Class in namespace WHMCS\User: An administrative user login
AdminLog::admin() — Method in class AdminLog: An admin log entry belongs to an admin user.
Alert — Class in namespace WHMCS\User: A user level alert
$Client — Property in class Client
$Client — Property in class Client: The first line of the address a client resides at.
$Client — Property in class Client: The second line of the address a client resides at.
$Client — Property in class Client: Determines if Single Sign-On is permitted for this client user.
$Client — Property in class Client: The addons a client has purchased.
$Client — Property in class Client: A client's affiliate record, if activated as an affiliate.
Client::addons() — Method in class Client: A client can have many add-on services.
Client::affiliate() — Method in class Client: A client can have an associated affiliate record.
Affiliate — Class in namespace WHMCS\User\Client: Client affiliate information
$Affiliate — Property in class Affiliate: The total balance withdrawn by an affiliate.
$Contact — Property in class Contact
$Contact — Property in class Contact: All contact permissions.
$Contact — Property in class Contact: The first line of the address a client contact resides at.
$Contact — Property in class Contact: The second line of the address a client contact resides at.
Item::addChild() — Method in class Item: Add a child menu item.

B

$Announcement — Property in class Announcement
Announcement::boot() — Method in class Announcement
Announcement::bestTranslation() — Method in class Announcement
Invoice::boot() — Method in class Invoice
$Item — Property in class Item
$Item — Property in class Item
$Setting — Property in class Setting: The following settings have boolean values.
Setting::boot() — Method in class Setting: Load events around settings.
CustomField::boot() — Method in class CustomField
$Domain — Property in class Domain
Premium::boot() — Method in class Premium
$Category — Property in class Category
$Download — Property in class Download
Download::boot() — Method in class Download: Bind events to download objects.
$Template — Property in class Template
$Template — Property in class Template: Comma delimited list of email addresses that should be BCC: on the outgoing email.
Template::boot() — Method in class Template
NetworkIssue::boot() — Method in class NetworkIssue
$Addon — Property in class Addon
$Addon — Property in class Addon: The billing cycle of an addon
Addon::boot() — Method in class Addon
$Group — Property in class Group
Group::boot() — Method in class Group
Price::breakdown() — Method in class Price: Return breakdown pricing info
Price::breakdownPrice() — Method in class Price: Get best available breakdown price
Price::breakdownPriceNumeric() — Method in class Price: Get best available breakdown price as a number
$Product — Property in class Product
Product::boot() — Method in class Product
AbstractTask::boot() — Method in class AbstractTask
$Addon — Property in class Addon: English language internal name for billing cycle from this set: 'Free Account', 'One Time', 'Monthly', 'Quarterly', 'Semi-Annually', 'Annually', 'Biennially', 'Triennially'
Addon::boot() — Method in class Addon
$Service — Property in class Service
$Service — Property in class Service: English language internal name of this service's billing cycle from this set: 'Free Account', 'One Time', 'Monthly', 'Quarterly', 'Semi-Annually', 'Annually', 'Biennially', 'Triennially'
$Service — Property in class Service: If the service's module provides bandwidth usage telemetry, that value is stored here.
$Service — Property in class Service: If the service was purchased with a disk usage limit, that limit is stored here.
$Client — Property in class Client
$Client — Property in class Client: The id number of a client's associated billing contact.
$Client — Property in class Client: A client's associated billing contact.
Client::billingContact() — Method in class Client
$Affiliate — Property in class Affiliate: The total balance of unclaimed commission belonging to an affiliate.
$Contact — Property in class Contact
$Item — Property in class Item: An optional badge displayed to the right of a menu item's label.
$Item — Property in class Item: Raw HTML to be rendered in a menu item's body area.

C

$Announcement — Property in class Announcement
$Announcement — Property in class Announcement: Date this announcement was originally created.
Currency — Class in namespace WHMCS\Billing: A currency.
$Currency — Property in class Currency
$Invoice — Property in class Invoice
Invoice::client() — Method in class Invoice: Each invoice belongs to one client.
Invoice::convertLocalCardToRemote() — Method in class Invoice
Invoice::convertLocalBankAccountToRemote() — Method in class Invoice
$Item — Property in class Item
$Transaction — Property in class Transaction
$Transaction — Property in class Transaction: ID of client which made this transaction.
$Transaction — Property in class Transaction: ID number of currency for which this invoice is calculated.
$Transaction — Property in class Transaction: The client this transaction item belongs to.
Transaction::client() — Method in class Transaction: A transaction can belong to a client.
$Quote — Property in class Quote
$Quote — Property in class Quote: ID of client this quote is assigned to, if the quote belongs to a pre-existing client.
$Quote — Property in class Quote: Company name of the prospective client requesting the quote.
$Quote — Property in class Quote: City of the prospective client requesting the quote.
$Quote — Property in class Quote: Country of the prospective client requesting the quote.
$Quote — Property in class Quote: ID of the currency this quote is generated in.
$Quote — Property in class Quote: Text block provided by the admin which is displayed at the footer of the quote generated by WHMCS.
$Quote — Property in class Quote: The Client to whom this quote belongs to, if the client is pre-existing.
Quote::client() — Method in class Quote: Each quote may belong to a client.
$Item — Property in class Item
$Item — Property in class Item: Date this line item was created.
$Setting — Property in class Setting
CustomField — Class in namespace WHMCS: Custom Fields model class
$CustomField — Property in class CustomField
$CustomField — Property in class CustomField
$CustomField — Property in class CustomField: The date a custom field was created.
$CustomField — Property in class CustomField: The custom field values for this custom field
CustomField::customFieldValues() — Method in class CustomField
CustomFieldValue — Class in namespace WHMCS\CustomField: Custom Fields Values model class
$CustomFieldValue — Property in class CustomFieldValue
$CustomFieldValue — Property in class CustomFieldValue
$CustomFieldValue — Property in class CustomFieldValue: The custom field this value belongs to
CustomFieldValue::customField() — Method in class CustomFieldValue: A custom field value belongs to a single custom field.
CustomFieldValue::client() — Method in class CustomFieldValue
$AdditionalField — Property in class AdditionalField: Date this additional field was added to the domain.
$Domain — Property in class Domain
$Domain — Property in class Domain
$Domain — Property in class Domain: ID of client who owns this domain.
$Domain — Property in class Domain: Date this domain was created.
$Domain — Property in class Domain: Client to whom this domain belongs to.
Domain::client() — Method in class Domain: Each domain belongs to one client.
Extra::createTable() — Method in class Extra: Create table schema
SearchResult::calculatePremiumPricing() — Method in class SearchResult: Calculate Premium Pricing with Markup.
Premium::createTable() — Method in class Premium: Create table schema
Category — Class in namespace WHMCS\Download: A download category
$Category — Property in class Category
$Category — Property in class Category: The date this category was created.
$Category — Property in class Category: Array of Category objects which are subcategories of this one, if they exist.
Category::childCategories() — Method in class Category: A category may have many child categories.
$Download — Property in class Download
$Download — Property in class Download: If true, this download should only be available to clients.
$Download — Property in class Download: The date when this specific download was created.
$Register — Property in class Register
Register::createTable() — Method in class Register
$Template — Property in class Template
$Template — Property in class Template: False if the email template is a WHMCS built-in. True otherwise.
$Template — Property in class Template: Comma delimited list of email addresses that should be CC: on the outgoing email.
$Template — Property in class Template
$AbstractWidget — Property in class AbstractWidget
$AbstractWidget — Property in class AbstractWidget
$AbstractWidget — Property in class AbstractWidget
$AbstractWidget — Property in class AbstractWidget
$Queue — Property in class Queue
$Queue — Property in class Queue
Queue::createTable() — Method in class Queue: Create table schema
$NetworkIssue — Property in class NetworkIssue
$NetworkIssue — Property in class NetworkIssue: The date this network issue was originally created.
$Addon — Property in class Addon
$Addon — Property in class Addon
$Addon — Property in class Addon
$Addon — Property in class Addon: The custom fields for an addon.
Addon::customFields() — Method in class Addon
$Group — Property in class Group
$Group — Property in class Group
$Group — Property in class Group: The date a product group was created.
Price::cycle() — Method in class Price: Return billing cycle
Price::cycleInYears() — Method in class Price: Get billing cycle in year(s)
Price::cycleInMonths() — Method in class Price: Get billing cycle in month(s)
$Product — Property in class Product
$Product — Property in class Product
$Product — Property in class Product: The date a product was created.
$Product — Property in class Product: The custom fields for a product.
Product::customFields() — Method in class Product
$AbstractTask — Property in class AbstractTask
$AbstractTask — Property in class AbstractTask
AbstractTask::createTable() — Method in class AbstractTask
$Addon — Property in class Addon
$Addon — Property in class Addon: Id of client that this addon is on
$Addon — Property in class Addon: The date this addon was created.
$Addon — Property in class Addon: Client object which owns this service.
$Addon — Property in class Addon
Addon::client() — Method in class Addon: Each addon belongs to one client.
Addon::customFieldValues() — Method in class Addon
Addon::canBeUpgraded() — Method in class Addon: Determine if addon can be upgraded.
CancellationRequest — Class in namespace WHMCS\Service: A service cancellation request
$CancellationRequest — Property in class CancellationRequest
$CancellationRequest — Property in class CancellationRequest: Timestamp of when this cancellation request was created.
$Service — Property in class Service
$Service — Property in class Service: ID of client who owns this service.
$Service — Property in class Service: Date the service was Completed.
$Service — Property in class Service: Date this service was created.
$Service — Property in class Service: Client object which owns this service.
$Service — Property in class Service: Any cancellation requests related to this service.
$Service — Property in class Service
Service::client() — Method in class Service: Each service belongs to one client.
Service::cancellationRequests() — Method in class Service: Each service can have many cancellation requests
Service::customFieldValues() — Method in class Service
Service::canBeUpgraded() — Method in class Service: Determine if service can be upgraded.
$Admin — Property in class Admin
$Admin — Property in class Admin
$AdminLog — Property in class AdminLog
Client — Class in namespace WHMCS\User: A client user.
$Client — Property in class Client
$Client — Property in class Client: The name of the company employing a client.
$Client — Property in class Client: The city a client resides in.
$Client — Property in class Client: The two-letter ISO code of the country a client resides in.
$Client — Property in class Client: The id number of a client's preferred currency.
$Client — Property in class Client: The amount of credit a client has available.
$Client — Property in class Client: The type of credit card a client has on file.
$Client — Property in class Client: The last four digits of a client's credit card on file.
$Client — Property in class Client: The encrypted expiration date of a client's card on file.
$Client — Property in class Client: The full name of the country a client resides in.
$Client — Property in class Client: A client's associated contacts.
$Client — Property in class Client
$Client — Property in class Client: A client's currency.
$Client — Property in class Client: Initial creation of the client data (or 0000-00-00 00:00:00 if created before 6.0.0).
Client::contacts() — Method in class Client: A client can have many contacts.
Client::currencyrel() — Method in class Client: A client has an associated currency.
Client::customFieldValues() — Method in class Client
$Affiliate — Property in class Affiliate
$Affiliate — Property in class Affiliate: The id of the client associated with an affiliate record.
$Affiliate — Property in class Affiliate: The type of commission payment made to an affiliate, either "percentage", "fixed", or null.
$Affiliate — Property in class Affiliate: The date an affiliate record was created.
$Affiliate — Property in class Affiliate: The client associated with an affiliate record.
Affiliate::client() — Method in class Affiliate: Each affiliate belongs to one client.
Contact — Class in namespace WHMCS\User\Client: A client contact
$Contact — Property in class Contact
$Contact — Property in class Contact
$Contact — Property in class Contact: The id of the client a client contact belongs to.
$Contact — Property in class Contact: The name of the company employing a client contact.
$Contact — Property in class Contact: The city a client contact resides in.
$Contact — Property in class Contact: The two-letter ISO code of the country a client contact resides in.
$Contact — Property in class Contact: The date a client contact was created.
$Contact — Property in class Contact: The full name of the country a client contact resides in.
$Contact — Property in class Contact: The client that a client contact belongs to.
Contact::client() — Method in class Contact: Each contact belongs to one client.
$SecurityQuestion — Property in class SecurityQuestion: The date a security question was created.
$SecurityQuestion — Property in class SecurityQuestion: The clients that must answer this security question upon login.
SecurityQuestion::clients() — Method in class SecurityQuestion: A security question may be in use by many clients.
$Price — Property in class Price
Item::copy() — Method in class Item: Make a copy of a menu item.

D

$Announcement — Property in class Announcement
$Currency — Property in class Currency
$Invoice — Property in class Invoice
Invoice::data() — Method in class Invoice: Each invoice can have one set of invoice data.
Invoice::deletePayMethod() — Method in class Invoice
$Item — Property in class Item
$Item — Property in class Item: A text description of this line item.
$Item — Property in class Item: Date this line item is due.
$Item — Property in class Item: The related model for the domain invoice item
Item::domain() — Method in class Item
$Transaction — Property in class Transaction
$Transaction — Property in class Transaction: Date upon which this transaction was made.
$Transaction — Property in class Transaction: Human readable description of this transaction.
$Quote — Property in class Quote
$Quote — Property in class Quote: Date this quote was generated.
$Quote — Property in class Quote: Date this quote was sent to the [prospective] client.
$Quote — Property in class Quote: Date the [prospective] client accepted this quote.
$Item — Property in class Item: Description attached to this line item.
$Item — Property in class Item: Percentage discount offered, if any.
$Setting — Property in class Setting: Inheriting classes may provide a default key/value list for allDefaults() collection return
Setting::deleteValue() — Method in class Setting: Delete a configuration value
$CustomField — Property in class CustomField: The description of the custom field
$AdditionalField — Property in class AdditionalField: ID number of domain to which this additional field is associated.
$AdditionalField — Property in class AdditionalField: Domain object to which this additional field is attached.
AdditionalField::domain() — Method in class AdditionalField: Each additional field belongs to one domain.
Domain — Class in namespace WHMCS\Domain: A customer's domain.
$Domain — Property in class Domain
$Domain — Property in class Domain: This domain name.
$Extra — Property in class Extra: related domain unique id
$Extra — Property in class Extra: The domain that the extra information belongs to.
Extra::domain() — Method in class Extra: Each extra record belongs to one domain.
Domain — Class in namespace WHMCS\Domain\Registrar: Store information regarding the domain that can be used within the product without requiring additional Registrar calls.
$Domain — Property in class Domain
$Domain — Property in class Domain
$Domain — Property in class Domain
$Domain — Property in class Domain
$Category — Property in class Category: A textual description of the contents of this category.
$Category — Property in class Category: Array of Download objects which belong in this category.
Category::downloads() — Method in class Category: A download category may have many downloads in it.
Download — Class in namespace WHMCS\Download: A downloadable file.
$Download — Property in class Download: ID number of category this download belongs to.
$Download — Property in class Download: Description displayed to the client for this file.
$Download — Property in class Download: Category object to which this download belongs.
Download::downloadCategory() — Method in class Download: A download exists within a category.
$Template — Property in class Template: If set to true, this email template will not be used for outgoing email.
$AbstractWidget — Property in class AbstractWidget
$AbstractWidget — Property in class AbstractWidget
DescriptionTrait — Class in namespace WHMCS\Module\Notification: Collection of behaviors common to all notification modules that help fulfill \WHMCS\Notification\Notification\NotificationModuleInterface
$DescriptionTrait — Property in class DescriptionTrait
$Queue — Property in class Queue
$Queue — Property in class Queue: The related domain
Queue::domain() — Method in class Queue
$NetworkIssue — Property in class NetworkIssue
$NetworkIssue — Property in class NetworkIssue: The text which should be displayed to clients, explaining the network issue. May contain HTML.
$Addon — Property in class Addon: The description of an addon
$Addon — Property in class Addon: The associated downloads
$Group — Property in class Group: Payment gateways which should NOT be displayed to the client when ordering products in a product group.
$Group — Property in class Group: The order in which a product group is displayed to clients.
$Product — Property in class Product: A product's description. Some order form templates may render structured data in a product's description.
$Product — Property in class Product: The number of days after sign up before a product is automatically terminated.
$Product — Property in class Product: The order in which to display a product in its group.
$AbstractTask — Property in class AbstractTask
$AbstractTask — Property in class AbstractTask
$AbstractTask — Property in class AbstractTask
$AbstractTask — Property in class AbstractTask
$AbstractTask — Property in class AbstractTask
$AbstractTask — Property in class AbstractTask
$Addon — Property in class Addon
$CancellationRequest — Property in class CancellationRequest
$CancellationRequest — Property in class CancellationRequest: The date this cancellation was originally created.
$Service — Property in class Service
$Service — Property in class Service: Domain name this service is registered under.
$Service — Property in class Service: English language internal name of status of this service, from this set: 'Pending', 'Active', 'Suspended', 'Terminated', 'Cancelled', 'Fraud' (Additionally custom status may exist)
$Service — Property in class Service: If the service provides a dedicated IP address, it is stored here.
$Service — Property in class Service: If the service's module provides disk usage telemetry, that value is stored here.
$Service — Property in class Service: If the service was purchased with a disk usage limit, that limit is stored here.
$Client — Property in class Client
$Client — Property in class Client: A client's default default payment gateway module.
$Client — Property in class Client: Whether or not a client's invoices should be automatically processed.
$Client — Property in class Client: The date a client was created.
$Client — Property in class Client: The domains a client has purchased.
$Client — Property in class Client
$Client — Property in class Client: The ssl statuses for the client
Client::domains() — Method in class Client: A client can have many domains.
Client::deleteEntireClient() — Method in class Client: Deletes a client and all associated data.
Client::defaultBillingContact() — Method in class Client: Return a model of the billing contact or the client itself
Client::domainSslStatuses() — Method in class Client
Client::deleteAllCreditCards() — Method in class Client
$Affiliate — Property in class Affiliate
$Affiliate — Property in class Affiliate: The date an affiliate record was added to a client.
$Contact — Property in class Contact
$Price — Property in class Price
$Price — Property in class Price
$Item — Property in class Item: Tracks if a menu item is disabled.
Item::disable() — Method in class Item: Set a menu item as disabled.

E

$Transaction — Property in class Transaction: The exchange rate between the currency paid by the client and the currency of the WHMCS install.
$Quote — Property in class Quote: Email address of the prospective client requesting the quote.
$Domain — Property in class Domain: Date the registration expires
$Domain — Property in class Domain: The record from tbldomainpricing for this domain.
$Domain — Property in class Domain: All extra fields belonging to this domain registration.
Domain::extra() — Method in class Domain: Every domain may have extra information fields
Extra — Class in namespace WHMCS\Domain: Used to store information related to the domain that is not an additional field.
$Domain — Property in class Domain
$Domain — Property in class Domain
$NetworkIssue — Property in class NetworkIssue: The date upon which the effects of this network issue ceased, or is scheduled to end.
$Product — Property in class Product: An array whose first value is true if overages are enabled. Its second value is the unit to use for a product's disk usage limits, either "MB", "GB", or "TB". Its third value is the unit to use for a product's bandwidth usage limits, either "MB", "GB", or "TB".
AbstractTask::execute() — Method in class AbstractTask
$Admin — Property in class Admin: An admin's email address.
$Client — Property in class Client: A client's email address.
$Client — Property in class Client: Whether or not to disable sending email to a client.
$Client — Property in class Client: Determines if the client's email address ownership has been verified.
$Contact — Property in class Contact: A client contact's email address.
Item::enable() — Method in class Item: Set a menu item as enabled.

F

$Currency — Property in class Currency
$Transaction — Property in class Transaction: Merchant fees charged against this transaction.
$Quote — Property in class Quote: First name of the prospective client requesting the quote.
$Setting — Property in class Setting: Allow mass assignment of setting values.
$CustomField — Property in class CustomField: Define the fields that can be hydrated by a firstOrNew call.
$CustomField — Property in class CustomField: The name of the custom field
$CustomField — Property in class CustomField: The type of the custom field dropdown|link|text|textarea|tickbox|password
$CustomField — Property in class CustomField: The options available for the dropdown type
$CustomFieldValue — Property in class CustomFieldValue: Define the fields that can be hydrated by a firstOrNew call.
$CustomFieldValue — Property in class CustomFieldValue: The unique id of the field in tblcustomfields
$AdditionalField — Property in class AdditionalField
$Domain — Property in class Domain: Initial payment made to purchase this domain.
$Domain — Property in class Domain: Any failed actions related to this domain.
Domain::failedActions() — Method in class Domain
$Extra — Property in class Extra: Fields that can be 'hydrated' by a find or new call.
SearchResult::factoryFromDomain() — Method in class SearchResult: Factory a SearchResult from a regular domain instance
$Download — Property in class Download: Name of the file on the filesystem with it's root in /downloads/
$Template — Property in class Template: Name which should be used as the "From" name displayed in the recipient's email client. If set to null, WHMCS uses the default.
$Template — Property in class Template: Email address which should be used as the "From" address in the recipient's email client. If set to null, WHMCS uses the default.
AbstractWidget::fetchData() — Method in class AbstractWidget: Fetch data.
$Setting — Property in class Setting
$Queue — Property in class Queue
$Group — Property in class Group: The products that belong to a product group.
Group::features() — Method in class Group: A product group can have many features.
$Product — Property in class Product: The domains a client can select for a free sub-domain.
$Product — Property in class Product: Whether purchasing a product provisions a free domain name, either "once", "on", or "".
$Product — Property in class Product: The payment terms a product must be purchased with to be provisioned with a free domain name, anything from the set "onetime", "monthly", "quarterly", "semiannually", "annually", "biennially", and "triennially".
$Product — Property in class Product: The top-level domains that are available for use with a product's free domain.
$Product — Property in class Product
AbstractTask::firstOfClassOrNew() — Method in class AbstractTask
$Service — Property in class Service: The first amount paid for this service.
$Service — Property in class Service: Any failed actions related to this service.
Service::failedActions() — Method in class Service
$Admin — Property in class Admin: An admin's first name.
$Admin — Property in class Admin
$Admin — Property in class Admin: An admin's first name and last name.
Admin::flaggedTickets() — Method in class Admin: An admin can have many flagged tickets.
$Client — Property in class Client
$Client — Property in class Client: A client's first name.
$Client — Property in class Client: A client's first name and last name.
$Contact — Property in class Contact: A client contact's first name.
$Contact — Property in class Contact: A client contact's first name and last name.
Price::format() — Method in class Price: Format a price in a given format.
$Item — Property in class Item: Raw HTML to be rendered in a menu item's footer area.

G

Announcement::getUniqueMonthsWithAnnouncements() — Method in class Announcement: Retrieve a list of the past months in which announcements were posted.
Invoice::getBalanceAttribute() — Method in class Invoice: Calculate balance remaining for the invoice.
Invoice::getPaymentGatewayNameAttribute() — Method in class Invoice
Invoice::getAmountPaidAttribute() — Method in class Invoice
Invoice::getBillingValues() — Method in class Invoice
Invoice::getPayMethodRemoteToken() — Method in class Invoice
$Setting — Property in class Setting: Once set, we cannot change a setting's 'setting' column.
Setting::getValue() — Method in class Setting: Retrieve a WHMCS setting value by setting key name.
Setting::getBooleanValues() — Method in class Setting: Return the setting names whose value should be boolean, but is stored as one of many boolean-ish strings
Setting::getCommaSeparatedValues() — Method in class Setting: Return the setting names whose value should be an array, but is stored as a csv
CustomField::getFieldNameAttribute() — Method in class CustomField: Get the custom field's name - this will override the output from the db value if set in Lang.
CustomField::getDescriptionAttribute() — Method in class CustomField: Get the custom field's name - this will override the output from the db value if set in Lang.
CustomField::getFieldName() — Method in class CustomField: Obtain the custom field name for the current language, passed language or fallback to the currently defined value for the product group.
CustomField::getDescription() — Method in class CustomField: Obtain the custom field description for the current language, passed language or fallback to the currently defined value for the product group.
$Domain — Property in class Domain
$Domain — Property in class Domain
Domain::getTldAttribute() — Method in class Domain: Get domain tld extension.
Domain::getAdditionalFields() — Method in class Domain: Get additional fields for the current domain.
Domain::getExtensionAttribute() — Method in class Domain
Domain::getGracePeriodAttribute() — Method in class Domain
Domain::getGracePeriodFeeAttribute() — Method in class Domain
Domain::getRedemptionGracePeriodAttribute() — Method in class Domain
Domain::getRedemptionGracePeriodFeeAttribute() — Method in class Domain
$Extra — Property in class Extra: Fields that cannot be updated once set.
Domain::getRegistrantEmailAddress() — Method in class Domain: Retrieve the stored value for the registrant email address.
Domain::getDomain() — Method in class Domain: Get the stored value for the domain.
Domain::getExpiryDate() — Method in class Domain: Retrieve the expiry date of the domain
Domain::getRegistrationStatus() — Method in class Domain: Retrieve the stored registration status
Domain::getRestorable() — Method in class Domain: Retrieve if the domain is restorable.
Domain::getRenewBeforeExpiration() — Method in class Domain: Check if the domain can be renewed before expiry
Domain::getIdProtectionStatus() — Method in class Domain: Get if the domain currently has an active ID Protection product on it.
Domain::getDnsManagementStatus() — Method in class Domain: Get if DNS Management (A, AAAA, CNAME, etc., records) is active on this domain at the registrar.
Domain::getEmailForwardingStatus() — Method in class Domain: Check if email forwarding is enabled on the domain at the registrar
Domain::getNameservers() — Method in class Domain: Retrieve the array of nameservers associated with the domain.
Domain::getTransferLock() — Method in class Domain: Check if the transfer lock is enabled on the domain.
Domain::getTransferLockExpiryDate() — Method in class Domain: Get the expiry date of the transfer lock.
Domain::getIrtpOptOutStatus() — Method in class Domain: Get if IRTP has been opted out.
Domain::getIrtpTransferLock() — Method in class Domain: Get the status of the irtp transfer lock.
Domain::getIrtpTransferLockExpiryDate() — Method in class Domain: Get the expiry date of the transfer lock.
Domain::getDomainContactChangeExpiryDate() — Method in class Domain: Get the date that the contact change is to be confirmed by.
Domain::getPendingSuspension() — Method in class Domain: Check if the domain is pending suspension.
Domain::getIsIrtpEnabled() — Method in class Domain: Check if this domain is an ICANN tld and subject to IRTP policies.
Domain::getIrtpVerificationTriggerFields() — Method in class Domain: Obtain the fields that trigger IRTP verification.
SearchResult::getScore() — Method in class SearchResult: The "score" of this domain compared to the original search query
SearchResult::getPremiumCostPricing() — Method in class SearchResult: Get Premium Cost Pricing.
SearchResult::getStatus() — Method in class SearchResult: Get availability status
SearchResult::getLegacyStatus() — Method in class SearchResult: Determine legacy status value (pre WHMCS 6.0 logic)
Register::getName() — Method in class Register
Register::getNamespaceId() — Method in class Register
Register::getNamespace() — Method in class Register
Register::getValue() — Method in class Register
$Template — Property in class Template
Template::getActiveLanguages() — Method in class Template: Retrieve a list of all of the languages used by all mail templates.
AbstractWidget::getId() — Method in class AbstractWidget: Get widget id.
AbstractWidget::getTitle() — Method in class AbstractWidget: Get title.
AbstractWidget::getDescription() — Method in class AbstractWidget: Get description.
AbstractWidget::getColumnSize() — Method in class AbstractWidget: Get column size.
AbstractWidget::getWeight() — Method in class AbstractWidget: Get display sort weighting.
AbstractWidget::getCacheExpiry() — Method in class AbstractWidget: Get cache expiry time.
AbstractWidget::getRequiredPermission() — Method in class AbstractWidget: Get required permission.
AbstractWidget::getData() — Method in class AbstractWidget: Get data method.
AbstractWidget::generateOutput() — Method in class AbstractWidget: Generate output.
NotificationModuleInterface::getName() — Method in class NotificationModuleInterface: Returns bare class name of the specific notification module.
NotificationModuleInterface::getDisplayName() — Method in class NotificationModuleInterface: Get display name for the notification module.
NotificationModuleInterface::getLogoPath() — Method in class NotificationModuleInterface: Logo of provider.
NotificationModuleInterface::getDynamicField() — Method in class NotificationModuleInterface: Retrieve option values used to populate a 'dynamic' Type notification setting
DescriptionTrait::getName() — Method in class DescriptionTrait: Returns bare class name of the specific notification module.
DescriptionTrait::getDisplayName() — Method in class DescriptionTrait: Get display name for the notification module.
DescriptionTrait::getLogoFileName() — Method in class DescriptionTrait: Get the logo filename
DescriptionTrait::getLogoPath() — Method in class DescriptionTrait: Logo of provider.
Queue::getLastAttemptErrorAttribute() — Method in class Queue: Ensure the Last Attempt Error is populated on display when empty.
NotificationAttributeInterface::getLabel() — Method in class NotificationAttributeInterface
NotificationAttributeInterface::getValue() — Method in class NotificationAttributeInterface
NotificationAttributeInterface::getUrl() — Method in class NotificationAttributeInterface
NotificationAttributeInterface::getStyle() — Method in class NotificationAttributeInterface
NotificationAttributeInterface::getIcon() — Method in class NotificationAttributeInterface
NotificationInterface::getTitle() — Method in class NotificationInterface
NotificationInterface::getMessage() — Method in class NotificationInterface
NotificationInterface::getUrl() — Method in class NotificationInterface
NotificationInterface::getAttributes() — Method in class NotificationInterface
Addon::getNameAttribute() — Method in class Addon: Get the addon name - this will override the output from the db value if set in Lang.
Addon::getDescriptionAttribute() — Method in class Addon: Get the addon description - this will override the output from the db value if set in Lang.
Addon::getAddonName() — Method in class Addon: Obtain the addon name for the current language, passed language or fallback to the currently defined value for the product.
Addon::getAddonDescription() — Method in class Addon: Obtain the addon description for the current language, passed language or fallback to the currently defined value for the product.
Addon::getProductKeyAttribute() — Method in class Addon: Get product key attribute for the current product addon entity.
Addon::getServiceKeyAttribute() — Method in class Addon: Get service key attribute for the current product addon entity.
Addon::getAddonDropdownValues() — Method in class Addon: Get an array of id => name addons that should appear in an addon dropdown.
Group — Class in namespace WHMCS\Product: A product group
Group::getAvailableBillingCycles() — Method in class Group: Get available billing cycles for product.
Group::getNameAttribute() — Method in class Group: Get the group's name - this will override the output from the db value if set in Lang.
Group::getHeadlineAttribute() — Method in class Group: Get the group's headline - this will override the output from the db value if set in Lang.
Group::getTaglineAttribute() — Method in class Group: Get the group's tagline - this will override the output from the db value if set in Lang.
Group::getGroupName() — Method in class Group: Obtain the product group name for the current language, passed language or fallback to the currently defined value for the product group.
Group::getHeadline() — Method in class Group: Obtain the product headline for the current language, passed language or fallback to the currently defined value for the product group.
Group::getTagline() — Method in class Group: Obtain the product tagline for the current language, passed language or fallback to the currently defined value for the product group.
Price::getShortCycle() — Method in class Price: Get short two-letter version of billing cycle
Product::getDownloadIds() — Method in class Product: Retrieve a list of the ids of the downloads associated with a product.
Product::getUpgradeProductIds() — Method in class Product: Retrieve a list of the ids of the upgrade products associated with a product.
Product::getAvailableBillingCycles() — Method in class Product: Get available billing cycles for product.
Product::getNameAttribute() — Method in class Product: Get the product name - this will override the output from the db value if set in Lang.
Product::getDescriptionAttribute() — Method in class Product: Get the product description - this will override the output from the db value if set in Lang.
Product::getProductName() — Method in class Product: Obtain the product name for the current language, passed language or fallback to the currently defined value for the product.
Product::getProductDescription() — Method in class Product: Obtain the product description for the current language, passed language or fallback to the currently defined value for the product.
Product::getProductKeyAttribute() — Method in class Product: Get product key attribute for the current product entity.
Product::getServiceKeyAttribute() — Method in class Product: Get service key attribute for the current product entity.
Product::getFormattedProductFeaturesAttribute() — Method in class Product
$AbstractTask — Property in class AbstractTask
AbstractTask::getDefaultAttributes() — Method in class AbstractTask
AbstractTask::getName() — Method in class AbstractTask
AbstractTask::getPriority() — Method in class AbstractTask
AbstractTask::getDescription() — Method in class AbstractTask
AbstractTask::getFrequencyMinutes() — Method in class AbstractTask
AbstractTask::getStatus() — Method in class AbstractTask
AbstractTask::getStatusAttribute() — Method in class AbstractTask
AbstractTask::getSystemName() — Method in class AbstractTask
AbstractTask::getAccessLevel() — Method in class AbstractTask
AbstractTask::getOutputKeys() — Method in class AbstractTask
Addon::getCustomFieldType() — Method in class Addon
Addon::getCustomFieldRelId() — Method in class Addon
Addon::getServicePropertiesAttribute() — Method in class Addon
Service::getCustomFieldType() — Method in class Service
Service::getCustomFieldRelId() — Method in class Service
Service::getServicePropertiesAttribute() — Method in class Service
$Admin — Property in class Admin: The hash for the gravatar url
Admin::getFullNameAttribute() — Method in class Admin: "fullName" is the concatenation of first and last name.
Admin::getGravatarHashAttribute() — Method in class Admin: Get gravatar email address hash.
Admin::getUsernameAttribute() — Method in class Admin: Return the username
Admin::getRolePermissions() — Method in class Admin: Array of permission names available to this admin user
Admin::getModulePermissions() — Method in class Admin
Admin::getTemplateThemeNameAttribute() — Method in class Admin
Admin::getAuthenticatedUser() — Method in class Admin: Get the currently authenticated admin user.
Alert::getMessage() — Method in class Alert: Retrieve an alert's message.
Alert::getSeverity() — Method in class Alert: Retrieve an alert's severity.
Alert::getLink() — Method in class Alert: Retrieve an optional link target to provide along with an alert.
Alert::getLinkText() — Method in class Alert: Retrieve an optional link text to provide along with an alert.
$Client — Property in class Client: The id number of the group that a client belongs to.
$Client — Property in class Client: The nam of the group a client belongs to.
Client::getStatuses() — Method in class Client: Get client status values.
Client::generateCreditCardEncryptionKey() — Method in class Client: Generate the AES key used to encrypt a user's credit card information.
Client::getAlerts() — Method in class Client: Retrieve a client's alerts.
Client::getFullNameAttribute() — Method in class Client: "fullName" is the concatenation of first and last name.
Client::getCountryNameAttribute() — Method in class Client: Returns the human readable name for the clients country.
Client::getSecurityQuestionAnswerAttribute() — Method in class Client: Decrypt security question answers from storage.
Client::generateCreditCardEncryptedField() — Method in class Client: Generate an AES Encrypted string from the passed value.
Client::getUsernameAttribute() — Method in class Client
Client::getEmailVerificationId() — Method in class Client: Returns the email verification id to verify email ownership.
Client::generateEmailVerificationKey() — Method in class Client: Returns a key used to verify ownership of an email account.
Client::getCustomFieldType() — Method in class Client
Client::getCustomFieldRelId() — Method in class Client
Client::getGroups() — Method in class Client
Client::getGroupNameAttribute() — Method in class Client
Client::generateUniquePlaceholderEmail() — Method in class Client
Client::getUsedCardTypes() — Method in class Client: Get the card types currently used.
Contact::getFullNameAttribute() — Method in class Contact: "FullName" is the concatenation of first and last name.
Contact::getCountryNameAttribute() — Method in class Contact: Returns the human readable name for the contacts country.
Contact::getLanguageAttribute() — Method in class Contact
Contact::getTwoFactorAuthModuleAttribute() — Method in class Contact
SecurityQuestion::getQuestionAttribute() — Method in class SecurityQuestion: Decrypt security questions from storage.
Price::getCurrency() — Method in class Price
Item::getName() — Method in class Item: Retrieve a menu item's name.
Item::getUri() — Method in class Item: Retrieve a menu item's link target.
Item::getLabel() — Method in class Item: Retrieve a menu item's label.
Item::getChild() — Method in class Item: Retrieve a menu item's child item by name.
Item::getLevel() — Method in class Item: Retrieve a menu item's level in the menu tree.
Item::getRoot() — Method in class Item: Retrieve the root menu item.
Item::getParent() — Method in class Item: Retrieve a menu item's parent item.
Item::getChildren() — Method in class Item: Retrieve a menu item's child items.
Item::getBadge() — Method in class Item: Retrieve a menu item's badge, or false if the badge isn't set.
Item::getOrder() — Method in class Item: Retrieve a menu item's sort order.
Item::getClass() — Method in class Item: Retrieve a menu item's css class definitions.
Item::getExtras() — Method in class Item: Retrieve a key/value pair of menu item extras.
Item::getExtra() — Method in class Item: Retrieve a menu item extra by name.
Item::getIcon() — Method in class Item: Retrieve full CSS classes of the icon displayed next to a menu item.
Item::getBodyHtml() — Method in class Item: Retrieve a menu item's body HTML content.
Item::getFooterHtml() — Method in class Item: Retrieve a menu item's footer HTML content.
Item::getHeadingHtml() — Method in class Item: Retrieve a menu item's heading HTML content.
Item::getId() — Method in class Item: Build a menu item's CSS id.

H

$Domain — Property in class Domain: True if the customer purchased DNS management as part of this domain purchase.
$Domain — Property in class Domain: True if customer purchased Email Forwarding as part of this domain purchase.
$Domain — Property in class Domain: True if customer purchased ID Protection (anonymous WHOIS) as part of this domain purchase.
$Domain — Property in class Domain: True if "Disable Auto Renew" is activated for this domain.
Domain::hasNameservers() — Method in class Domain: Checks if the domain has more than zero nameservers associated with it that have been added using setNameservers
Domain::hasTransferLock() — Method in class Domain: Check if the transfer lock state has been set on the domain.
$Group — Property in class Group: A product group's headline.
$Service — Property in class Service
Service::hasAvailableUpgrades() — Method in class Service: Determine if a service has available upgrades.
$Admin — Property in class Admin
$Admin — Property in class Admin: A comma delimited list of legacy admin area home page widgets and their configuration, separated by colons. For instance, widget_name:true/false
$Admin — Property in class Admin: The widgets hidden for the Admin user
Admin::hasPermission() — Method in class Admin: Has a given permission within their assigned role group
$Client — Property in class Client
Client::hasDomain() — Method in class Client: Determines if client has a given domain name.
Client::hasSingleSignOnPermission() — Method in class Client: Returns if the client has Single Sign-On Enabled for their account.
Client::hasPermission() — Method in class Client: This fulfills the UserInterface
$Contact — Property in class Contact
$Item — Property in class Item: Raw HTML to be rendered in a menu body's heading area.
Item::hasChildren() — Method in class Item: Determine if a menu item has child items.
Item::hasBadge() — Method in class Item: Determine if a menu item has a badge.
Item::hasIcon() — Method in class Item: Determine if a menu item has an icon.
Item::hasFontAwesomeIcon() — Method in class Item: Determine if a menu item's icon is a Font Awesome icon.
Item::hasGlyphicon() — Method in class Item: Determine if a menu item's icon is a Glyphicon.
Item::hasBodyHtml() — Method in class Item: Determine if a menu item has body HTML.
Item::hasFooterHtml() — Method in class Item: Determine if a menu item has footer HTML.
Item::hasHeadingHtml() — Method in class Item: Determine if a menu item has heading HTML.

I

$Announcement — Property in class Announcement: Unique ID number for this announcement.
$Announcement — Property in class Announcement: State of the "Published" checkbox. On true, the announcement is displayed to clients.
$Currency — Property in class Currency
Invoice — Class in namespace WHMCS\Billing
Invoice::items() — Method in class Invoice: Each invoice can have many line items.
Item — Class in namespace WHMCS\Billing\Invoice: Invoice line items
$Item — Property in class Item: Unique id number for this line item.
$Item — Property in class Item: Invoice ID for the invoice this line item belongs to.
$Item — Property in class Item: The invoice this line item belongs to.
Item::invoice() — Method in class Item: Each invoice item belongs to an invoice.
$Transaction — Property in class Transaction: Unique ID number of this transaction.
$Transaction — Property in class Transaction: Internal Invoice ID number to which this transaction applies.
$Transaction — Property in class Transaction: The invoice this transaction item belongs to.
Transaction::invoice() — Method in class Transaction: A transaction can belong to an invoice.
$Quote — Property in class Quote: Unique ID number for this quote.
$Quote — Property in class Quote: Items associated with this quote.
Quote::items() — Method in class Quote: A quote has many quote items for.
Item — Class in namespace WHMCS\Billing\Quote: Quote line items
$Item — Property in class Item: Unique ID number for this quote line item.
$Item — Property in class Item: True if this item should be calculated with taxes.
$Setting — Property in class Setting: Settings don't have an auto-incrementing key.
$CustomField — Property in class CustomField: A custom fields unique identifier
$CustomFieldValue — Property in class CustomFieldValue: The unique id of the custom field value
$AdditionalField — Property in class AdditionalField: Unique ID for this domain registration additional field.
$Domain — Property in class Domain: Unique ID for this domain object.
$Domain — Property in class Domain: True if the domain is considered premium at registry.
$Domain — Property in class Domain: True if the registrar's data on this domain is fully synced with WHMCS.
$Domain — Property in class Domain: Any invoice items related to this domain
Domain::invoiceItems() — Method in class Domain: A domain can have many invoice items
Domain::isConfiguredTld() — Method in class Domain: Returns true if tld is configured for sale.
$Extra — Property in class Extra: Autoincrement id for table row
$Domain — Property in class Domain
$Domain — Property in class Domain
$Domain — Property in class Domain
$Domain — Property in class Domain
$Domain — Property in class Domain
$Domain — Property in class Domain
Domain::isContactChangePending() — Method in class Domain: Check if a contact change is pending on the domain.
Domain::isIrtpEnabled() — Method in class Domain: Check if this domain is an ICANN tld and subject to IRTP policies.
SearchResult::isAvailableForPurchase() — Method in class SearchResult: Whether the domain is generally available for purchase
SearchResult::isMatchingLengthRequirements() — Method in class SearchResult: Checks whether the domain matches length requirements
$Category — Property in class Category: Unique ID number for this category.
$Category — Property in class Category: If true, do not display this category to clients.
$Download — Property in class Download: Unique ID number for this download.
$Download — Property in class Download: If true, this download should not be displayed to clients, only to admins.
$Download — Property in class Download: If true, this download is associated with a specific product.
$Register — Property in class Register
$Template — Property in class Template: Unique ID number for this mail template.
AbstractWidget::isCachable() — Method in class AbstractWidget: Get if widget allows caching.
AbstractWidget::isCachedPerUser() — Method in class AbstractWidget: Get if widget requires caching per user.
AbstractWidget::isDraggable() — Method in class AbstractWidget
$Setting — Property in class Setting
NotificationModuleInterface::isActive() — Method in class NotificationModuleInterface: Is this notification provider active?
DescriptionTrait::isActive() — Method in class DescriptionTrait: Is this notification provider active?
$NetworkIssue — Property in class NetworkIssue: Unique ID Number for this specific network issue announcement.
$Addon — Property in class Addon: An addon's unique id number.
$Addon — Property in class Addon: Whether an addon is hidden from order in the client area
Addon::isFree() — Method in class Addon: Is product a free product.
Addon::isOneTime() — Method in class Addon: Is product a one time product.
Addon::isMarketConnectAddon() — Method in class Addon: Is this a MarketConnect addon?
Addon::isValidForUpgrade() — Method in class Addon: Validate a given addon is a valid upgrade candidate.
Addon::isVisibleOnOrderForm() — Method in class Addon: Check if the addon should be visible on the orderform.
$Group — Property in class Group: A product group's unique identifier.
$Group — Property in class Group: Whether or not a product group is displayed to clients in the shopping cart.
Price::isFree() — Method in class Price: Is the billing cycle one time?
Price::isOneTime() — Method in class Price: Is the billing cycle one time?
Price::isRecurring() — Method in class Price: Is the billing cycle recurring?
Price::isYearly() — Method in class Price: Returns true if the price is a yearly price
$Product — Property in class Product
$Product — Property in class Product: A product's unique id number.
$Product — Property in class Product: Whether or not to display a product in shopping cart modules.
$Product — Property in class Product: Whether or not a product is retired and should no longer be sold.
$Product — Property in class Product: Whether or not a product is displayed more prominently in its product group.
Product::isFree() — Method in class Product: Is product a free product.
Product::isOneTime() — Method in class Product: Is product a one time product.
Product::isMarketConnectProduct() — Method in class Product: Is this a MarketConnect product?
Product::isValidForUpgrade() — Method in class Product: Validate a given product is a valid upgrade candidate.
AbstractTask::isEnabled() — Method in class AbstractTask
AbstractTask::isPeriodic() — Method in class AbstractTask
AbstractTask::isDailyTask() — Method in class AbstractTask
AbstractTask::isSkipDailyCron() — Method in class AbstractTask
$Addon — Property in class Addon: Unique ID number for this addon instance.
Addon::isService() — Method in class Addon: Is this entity a service?
Addon::isAddon() — Method in class Addon: Is this entity an addon?
$CancellationRequest — Property in class CancellationRequest: Unique ID Number for this cancellation request.
$Service — Property in class Service: Unique ID for this service.
Service::isService() — Method in class Service: Is this entity a service?
Service::isAddon() — Method in class Service: Is this entity an addon?
$Admin — Property in class Admin: An admin's unique id number.
$Admin — Property in class Admin: Whether or not an admin is disabled and cannot log in.
Admin::isAllowedToAuthenticate() — Method in class Admin: Should the user be allowed to authenticate
Admin::isAllowedToMasquerade() — Method in class Admin
$AdminLog — Property in class AdminLog: A log entry's unique id number.
$AdminLog — Property in class AdminLog: An admin's ip address.
$Client — Property in class Client: A client's unique id number.
$Client — Property in class Client
Client::invoices() — Method in class Client: A client can have many invoices.
Client::isCreditCardExpiring() — Method in class Client: Determine if a user's credit card is going to expire within a number of months.
Client::isAllowedToAuthenticate() — Method in class Client: Should the user be allowed to authenticate
Client::isEmailAddressVerified() — Method in class Client: Returns if the client's email address ownership has been verified.
Client::isOptedInToMarketingEmails() — Method in class Client: Determine if user is opted in to marketing emails.
$Affiliate — Property in class Affiliate: An affiliate record's unique id.
$Affiliate — Property in class Affiliate: Whether or not an affiliate is only paid commission on initial sale. Otherwise, an affiliate's commission applies to recurring payments.
$Contact — Property in class Contact: Unique A clients contact's unique id.
$Contact — Property in class Contact: Whether or not a client contact is a sub-account. Sub-accounts may log into the client area.
$SecurityQuestion — Property in class SecurityQuestion: A security question's unique id.
Item — Class in namespace WHMCS\View\Menu: An item in one of WHMCS's client area menus.
$Item — Property in class Item: An optional icon displayed next to a menu item.
Item::isRoot() — Method in class Item: Determine if a menu item is the root menu item.
Item::isDisabled() — Method in class Item: Retrieve if a menu item is disabled.
Item::isFontAwesomeIcon() — Method in class Item: Determine if a string describes a Font Awesome icon.
Item::isGlyphicon() — Method in class Item: Determine if a string describes a Glyphicon.

L

$Announcement — Property in class Announcement: English language internal name of the language used in this translation.
$Quote — Property in class Quote: Last name of the prospective client requesting the quote.
$Quote — Property in class Quote: Last date this quote was modified.
Register::latestByNamespaces() — Method in class Register
$Template — Property in class Template: English language internal name identifying the language of this email template translation.
$DescriptionTrait — Property in class DescriptionTrait
$NetworkIssue — Property in class NetworkIssue: The date and time of the last update of the network issue via the Admin panel.
$Service — Property in class Service: Date this service was last modified.
$Admin — Property in class Admin: An admin's last name.
$Admin — Property in class Admin: An admin's preferred display language.
$Admin — Property in class Admin: The number of times an admin has failed to log into the WHMCS admin area.
$AdminLog — Property in class AdminLog: An admin's login time.
$AdminLog — Property in class AdminLog: An admin's logout time.
$AdminLog — Property in class AdminLog: An admin's last visit time.
$Alert — Property in class Alert: An optional link target to provide along with an alert.
$Alert — Property in class Alert: An optional link text to provide along with an alert.
$Client — Property in class Client: A client's last name.
$Client — Property in class Client: The last date a client logged into the client area.
$Client — Property in class Client: The IP address a client used the last time they logged into the client area.
$Client — Property in class Client: The resolved hostname of the IP address used the last time a client logged into the client area.
$Client — Property in class Client: A client's preferred display language.
Client::logActivity() — Method in class Client: Log activity.
$Contact — Property in class Contact: A client contact's last name.

M

Premium::markupForCost() — Method in class Premium: Obtain the markup for the supplied cost
$Template — Property in class Template: The message template used for the body of the outgoing email.
$Setting — Property in class Setting
$Addon — Property in class Addon: The module for an addon for module automation
$Addon — Property in class Addon: The module configuration for an addon.
Addon::moduleConfiguration() — Method in class Addon
Price::monthlyPrice() — Method in class Price: Get per month price
$Product — Property in class Product: The name of the module used to provision a product.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
$Product — Property in class Product: Modules may use this field to store module specific configuration.
AbstractTask::monthlyDayOfExecution() — Method in class AbstractTask
$Alert — Property in class Alert: An alert's message.
$Client — Property in class Client: Has the client opted in to marketing emails.
Client::marketingConsent() — Method in class Client
Client::marketingEmailOptIn() — Method in class Client: Opt in to email marketing.
Client::marketingEmailOptOut() — Method in class Client: Opt out of email marketing.
Client::migratePaymentDetailsIfRequired() — Method in class Client
Client::markCardDetailsAsMigrated() — Method in class Client
Client::markBankDetailsAsMigrated() — Method in class Client
Client::markPaymentTokenMigrated() — Method in class Client
Item::moveUp() — Method in class Item: Move a menu item up in sorting order.
Item::moveDown() — Method in class Item: Move a menu item down in sorting order.
Item::moveToFront() — Method in class Item: Move a menu item to the beginning of the sorting order.
Item::moveToBack() — Method in class Item: Move a menu item to the end of the sorting order.

N

Invoice::newInvoice() — Method in class Invoice: Create a new invoice in Draft and return the instance to be updated and saved.
$Item — Property in class Item: Any admin supplied notes for this line item. (This property is not used internally by WHMCS, but is left in place for legacy purposes.)
$Setting — Property in class Setting: The following settings may not be null or empty.
Setting::newCollection() — Method in class Setting: Get a collection of models
$AdditionalField — Property in class AdditionalField: Name of this additional field.
$Domain — Property in class Domain: The date the next payment is due on.
$Domain — Property in class Domain: The date the next invoice will be generated on.
$Extra — Property in class Extra: the type of information stored in the value
$Domain — Property in class Domain
$Category — Property in class Category: Name of this category.
$Template — Property in class Template: Name by which the template is known in the Admin interface.
NotificationModuleInterface — Class in namespace WHMCS\Module\Contracts: Notification Module Interface
NotificationModuleInterface::notificationSettings() — Method in class NotificationModuleInterface: List of settings relevant to the delivery of a notification
NetworkIssue — Class in namespace WHMCS\Network: A network issue.
NotificationAttributeInterface — Class in namespace WHMCS\Notification\Contracts: Interface that describes attributes of a notification
NotificationInterface — Class in namespace WHMCS\Notification\Contracts: Interface that describes a notification
$Addon — Property in class Addon: The name of an addon
$Group — Property in class Group: A product group's name.
$Product — Property in class Product: A product's name.
AbstractTask::newCollection() — Method in class AbstractTask
$Addon — Property in class Addon: Name of this addon. This will either be the name assigned to the master addon, or a custom name assigned by an admin.
$Addon — Property in class Addon: The next date this addon's billing cycle is due.
$Addon — Property in class Addon: The date the next invoice will be generated for this addon.
$Addon — Property in class Addon: Admin provided notes on this addon that should not be displayed to clients.
$Service — Property in class Service: Date next payment is due.
$Service — Property in class Service: Date next invoice will be generated.
$Service — Property in class Service: Admin custom notes, with expectation that client will not see them.
$Service — Property in class Service: If the service requires a nameserver (such as a domain name), the first nameserver is stored here.
$Service — Property in class Service: If the service requires a second nameserver, that nameserver is stored here.
$Admin — Property in class Admin: An internal note available for an admin's general use.
$Client — Property in class Client: Internal admin-provided notes about a client. These notes are not visible to the client.
Client::needsCardDetailsMigrated() — Method in class Client
Client::needsBankDetailsMigrated() — Method in class Client
Client::needsNonCardPaymentTokenMigrated() — Method in class Client
Client::needsAnyPaymentDetailsMigrated() — Method in class Client

O

Invoice::order() — Method in class Invoice: An invoice can belong to a single order.
$Domain — Property in class Domain: ID of order where this domain was purchased.
$Domain — Property in class Domain
Domain::order() — Method in class Domain: A domain belongs to a single order.
$Group — Property in class Group: The order form template a product group should display on the order form, or null to use the default shopping cart template.
Group::orderFormTemplate() — Method in class Group: Retrieve a product group's associated order form
$Product — Property in class Product: The soft limit of a product's allowed disk usage to this number of units configured in enableOverageBillingAndUnits.
$Product — Property in class Product: The soft limit of a product's allowed bandwidth usage to this number of units configured in enableOverageBillingAndUnits.
$Product — Property in class Product: The price to charge per unit configured in enableOverageBillingAndUnits for a product's disk usage above the soft limit configured in overageDiskLimit.
$Product — Property in class Product: The price to charge per unit configured in enableOverageBillingAndUnits for a product's bandwidth usage above the soft limit configured in overageBandwidthLimit.
$AbstractTask — Property in class AbstractTask: [['name' => 'Foo Bar', 'defaultValue' => 'baz', 'identifier' => 'foo'],]
$Addon — Property in class Addon: ID of order in which this addon was purchased.
$Addon — Property in class Addon
Addon::order() — Method in class Addon: An addon belongs to a single order.
$Service — Property in class Service: ID of order used to purchase this service.
$Service — Property in class Service: If true, WHMCS will not attempt to automatically suspend this service.
$Service — Property in class Service: If Auto Suspend is not overridden, on this date the service will be automatically suspended.
$Service — Property in class Service
Service::order() — Method in class Service: A domain belongs to a single order.
$Client — Property in class Client: Whether or not a client should be charged late payment fees.
$Client — Property in class Client: Whether or not a client should receive overdue invoice notices.
$Client — Property in class Client: If true, do not automatically set this client's account status to 'Closed.'
$Client — Property in class Client
Client::orders() — Method in class Client: A client can have many orders.
$Contact — Property in class Contact
Contact::orders() — Method in class Contact: An addon can have many orders.
$Item — Property in class Item: The order that a menu item appears in its hierarchy.

P

$Announcement — Property in class Announcement: The most recent date the "Published" checkbox was set for this announcement (not necessarily the same as the creation date).
$Announcement — Property in class Announcement: If this announcement is a translation, this ID points to the source of the translation. Otherwise it's 0.
$Announcement — Property in class Announcement: If this is a translation of another announcement, this property points to the source Announcement object.
Announcement::parent() — Method in class Announcement: An announcement may have a parent announcement.
$Currency — Property in class Currency
Invoice::payMethod() — Method in class Invoice
$Item — Property in class Item: Internal name of payment gateway module selected for this line item.
$Transaction — Property in class Transaction: Internal name of payment gateway used to make this transaction.
$Quote — Property in class Quote: Post/Zip code of the prospective client requesting the quote.
$Quote — Property in class Quote: Phone Number of the prospective client requesting the quote.
$Quote — Property in class Quote: Text block provided by the admin which is displayed at the top of the quote generated by WHMCS.
$Setting — Property in class Setting: Configuration settings are keyed on the 'setting' column.
$CustomField — Property in class CustomField: The product a custom field belongs to
CustomField::product() — Method in class CustomField: A custom field can belong to a single product
$Domain — Property in class Domain: ID of promotion used to purchase this domain.
$Domain — Property in class Domain: Internal name of payment gateway used to purchase this domain name.
$SearchResult — Property in class SearchResult
SearchResult::pricing() — Method in class SearchResult
Premium — Class in namespace WHMCS\Domains\Pricing: Pricing markup for premium domains
$Category — Property in class Category: If this category is a sub-category, this is the unique ID number of it's parent.
$Category — Property in class Category: Category object of this category's parent, if this is a subcategory.
Category::parentCategory() — Method in class Category: A category may have a parent category.
$Download — Property in class Download: Array of all products this download is associated with.
Download::products() — Method in class Download: A download can be associated with one or more products.
$Template — Property in class Template: If set to true, this email will be sent without HTML body content, only plain text.
$Queue — Property in class Queue
$NetworkIssue — Property in class NetworkIssue: An English language name of the priority of this issue from this set: 'Low', 'Medium', 'High', 'Critical'
$Addon — Property in class Addon: The packages that an addon belongs to
Addon::pricing() — Method in class Addon: Get available cycles and pricing for product.
$Group — Property in class Group: The products that belong to a product group.
Group::products() — Method in class Group: A product group has many products in it.
Price — Class in namespace WHMCS\Product\Pricing: Price per cycle formatting helper
$Price — Property in class Price
Price::price() — Method in class Price: Return price
Product — Class in namespace WHMCS\Product: A product
$Product — Property in class Product: The id of group a product belongs to.
$Product — Property in class Product: Whether or not a product uses pro rata billing instead of standard month-to-month
$Product — Property in class Product: The day of the month upon which pro rata billing should charge on.
$Product — Property in class Product: The day of the month after which the following month will also be included on the first invoice.
$Product — Property in class Product: A product's payment type, either "recurring", "onetime", or "free".
$Product — Property in class Product: The group a product belongs to.
$Product — Property in class Product: A product's associated downloadable files.
Product::productGroup() — Method in class Product: A product belongs to a product group.
Product::productDownloads() — Method in class Product: A product has many downloads.
Product::pricing() — Method in class Product: Get available cycles and pricing for product.
$AbstractTask — Property in class AbstractTask
$AbstractTask — Property in class AbstractTask
$Addon — Property in class Addon: English language internal name for the gateway used to originally purchase this service.
$Addon — Property in class Addon
Addon::productAddon() — Method in class Addon: Each addon belongs to a single product addon.
$Service — Property in class Service: ID of package purchased in the order for this service.
$Service — Property in class Service: English language internal name for the gateway used to originally purchase this service.
$Service — Property in class Service: Password associated with this service.
$Service — Property in class Service: ID of promotion used when purchasing this service, or null otherwise.
$Service — Property in class Service: Product associated with this service.
Service::product() — Method in class Service: Each service is an instance of a product.
$Admin — Property in class Admin: An admin's stored password hash.
$Admin — Property in class Admin: The password reset key for an admin user when requested
$Admin — Property in class Admin: The password reset data for an admin user when requested
$Admin — Property in class Admin: The expiry for the password reset key for an admin user
$Client — Property in class Client: The post or zip code a client resides in.
$Client — Property in class Client: A client's phone number.
$Client — Property in class Client: A client's stored password hash.
$Client — Property in class Client: A client's payment gateway token, if required by the payment gateway.
$Client — Property in class Client: The auto-generated key from a client's last password reset attempt.
$Client — Property in class Client: The date that a client's most recent password reset key will expire
$Client — Property in class Client
Client::payMethods() — Method in class Client
$Affiliate — Property in class Affiliate: Either the percentage or fixed amount paid to an affiliate based on the commission type.
$Contact — Property in class Contact: The post or zip code a client contact resides in.
$Contact — Property in class Contact: A client contact's phone number.
$Contact — Property in class Contact: A client contact's stored password hash.
$Contact — Property in class Contact: The permissions associated with a client contact.
$Contact — Property in class Contact: The auto-generated key from a client contact's last password reset attempt.
$Contact — Property in class Contact: The date that a client contact's most recent password reset key will expire.
Price — Class in namespace WHMCS\View\Formatter: Price Formatter.
$Price — Property in class Price

Q

Quote — Class in namespace WHMCS\Billing: A quote for client services.
$Item — Property in class Item: ID of quote this line item belongs to.
$Item — Property in class Item: Quantity of this line item.
$Item — Property in class Item: Quote object to which this line item belongs.
Item::quote() — Method in class Item: Each quote item belongs to a quote.
Queue — Class in namespace WHMCS\Module: Module Queue
$Product — Property in class Product: A product's currently available quantity, if stock control is enabled.
$Client — Property in class Client: The quotes assigned to a client.
Client::quotes() — Method in class Client: A client can have many quotes for services.
$SecurityQuestion — Property in class SecurityQuestion: A security question's contents.

R

$Currency — Property in class Currency
$Item — Property in class Item: The related id of the corresponding entity type.
$Transaction — Property in class Transaction: Refund ID which is reflected in this invoice.
$CustomField — Property in class CustomField: The related id of the custom field type
$CustomField — Property in class CustomField: The Regular Expression Validation String
$CustomField — Property in class CustomField: Is the field required
$CustomFieldValue — Property in class CustomFieldValue: The related id of the field relationship. tblclients.id, tbltickets.id, tblhostingaddons.id, tblhosting.id
$Domain — Property in class Domain: Date this domain was registered.
$Domain — Property in class Domain: Recurring payment amount assigned to this domain name purchase.
$Domain — Property in class Domain: Internal name of registrar module used to register this domain.
$Domain — Property in class Domain: Purchased registration period, in years.
$Domain — Property in class Domain: Pipe delimited string of Email IDs.
$Domain — Property in class Domain
$Domain — Property in class Domain
$Domain — Property in class Domain
$Domain — Property in class Domain
$Domain — Property in class Domain
$Domain — Property in class Domain
ResultsList — Class in namespace WHMCS\Domains\DomainLookup: ResultsList from a domain
Register — Class in namespace WHMCS\Log: Register
$AbstractWidget — Property in class AbstractWidget
AbstractWidget::render() — Method in class AbstractWidget: Render widget.
Queue::resolve() — Method in class Queue: Resolve a module queue entry.
$Addon — Property in class Addon: Whether or not an addon is retired and should no longer be sold.
$Product — Property in class Product: The number of billing cycles a product may automatically renew.
AbstractTask::register() — Method in class AbstractTask
AbstractTask::run() — Method in class AbstractTask
$Addon — Property in class Addon: Recurring fee scheduled for this addon.
$Addon — Property in class Addon: Date when this addon was purchased.
$CancellationRequest — Property in class CancellationRequest: A customer provided reason for the cancellation.
$Service — Property in class Service: Date this service was purchased.
$Service — Property in class Service: The recurring payment amount for this service.
$Admin — Property in class Admin
$Admin — Property in class Admin: ID number of this admin's role. (Role based permissions)
$Admin — Property in class Admin: Whether or not an admin receives an email on new support ticket or support ticket reply creation.
$Client — Property in class Client
Client::remoteAccountLinks() — Method in class Client: A client can have many linked remote accounts.
$Contact — Property in class Contact: Whether or not a client contact receives domain related emails.
$Contact — Property in class Contact: Whether or not a client contact receives unrelated to specific systems.
$Contact — Property in class Contact: Whether or not a client contact receives invoice related emails.
$Contact — Property in class Contact: Whether or not a client contact receives product related emails.
$Contact — Property in class Contact: Whether or not a client contact receives support related emails.
$Contact — Property in class Contact: Whether or not a client contact receives emails from the client affiliate system.
$Contact — Property in class Contact
Contact::remoteAccountLinks() — Method in class Contact: A client can have many linked remote accounts.
Item::removeChild() — Method in class Item: Remove a menu item's child item.

S

Announcement::scopeTranslationsOf() — Method in class Announcement
Announcement::scopePublished() — Method in class Announcement
$Currency — Property in class Currency
Currency::scopeDefaultCurrency() — Method in class Currency
Currency::scopeDefaultSorting() — Method in class Currency: Show default currency first, and all other currencies sorted by currency code.
Invoice::snapshot() — Method in class Invoice: Each invoice can have one set of invoice snapshot data.
Invoice::scopeUnpaid() — Method in class Invoice: Where status is unpaid.
Invoice::scopeOverdue() — Method in class Invoice: Where status is overdue.
Invoice::scopePaid() — Method in class Invoice: Where status is paid.
Invoice::scopeCancelled() — Method in class Invoice: Where status is cancelled.
Invoice::scopeRefunded() — Method in class Invoice: Where status is refunded.
Invoice::scopeCollections() — Method in class Invoice: Where status is collections.
Invoice::scopePaymentPending() — Method in class Invoice: Where status is collections.
Invoice::scopeMassPay() — Method in class Invoice: Where the invoice does not contain a line item that is of type "Invoice".
Invoice::scopeWithLastCaptureAttempt() — Method in class Invoice: Where the last capture date is on a specific date
Invoice::shouldRenewRun() — Method in class Invoice: Checks if the module renewal should run for a provided related id, registration date and type of item.
Invoice::setStatusUnpaid() — Method in class Invoice: Set invoice status to unpaid.
Invoice::setPayMethodRemoteToken() — Method in class Invoice
Invoice::saveRemoteCard() — Method in class Invoice
Invoice::saveRemoteBankAccount() — Method in class Invoice
$Item — Property in class Item: The related model for the service invoice item
Item::service() — Method in class Item
$Quote — Property in class Quote: Subject line provided by the admin for this quote.
$Quote — Property in class Quote: English language internal name of this quote's status, from this set: 'Draft', 'Delivered', 'Accepted', 'Lost', 'Dead'
$Quote — Property in class Quote: State of the prospective client requesting the quote.
$Quote — Property in class Quote: Subtotal of this quote.
Setting — Class in namespace WHMCS\Config: An individual setting stored in the tblconfiguration table.
$Setting — Property in class Setting
Setting::scopeUpdater() — Method in class Setting: Retrieve all updater settings.
Setting::setValue() — Method in class Setting: Set a configuration value.
$CustomField — Property in class CustomField: Should the field show in the orderForm
$CustomField — Property in class CustomField: Should the field show on the invoice
$CustomField — Property in class CustomField: The order the field should be displayed
CustomField::scopeClientFields() — Method in class CustomField: Obtain all the client custom fields
CustomField::scopeProductFields() — Method in class CustomField: Obtain all the product custom fields for a specific product.
CustomField::scopeSupportFields() — Method in class CustomField: Obtain all the support custom fields for a specific support department.
CustomField::scopeAddonFields() — Method in class CustomField: Obtain all the addon custom fields for a specific addon id.
$CustomFieldValue — Property in class CustomFieldValue
CustomFieldValue::service() — Method in class CustomFieldValue
$Domain — Property in class Domain: See note above about the subscriptionId field
$Domain — Property in class Domain: English language internal name of the status of this domain registration from this set: 'Pending', 'Pending Registration', 'Pending Transfer', 'Active', 'Grace', 'Redemption', 'Expired', 'Cancelled', 'Fraud', 'Transferred Away'
Domain::scopeOfClient() — Method in class Domain: Retrieve domains for a specific user
Domain::scopeNextDueBefore() — Method in class Domain: Retrieve domains due before a given date.
Domain::scopeIsConsideredActive() — Method in class Domain
Domain::setRemindersAttribute() — Method in class Domain: Enforce business logic around domain reminders.
Domain::setRegistrantEmailAddress() — Method in class Domain: Set the registrant email address for the domain.
Domain::setDomain() — Method in class Domain: Set the domain name.
Domain::setExpiryDate() — Method in class Domain: Set the expiry date value of the domain using a carbon object.
Domain::setRegistrationStatus() — Method in class Domain: Set the registration status of the domain using the status constants within this class:
Domain::setRestorable() — Method in class Domain: Set if the domain is currently restorable if the expiry date has passed.
Domain::setRenewBeforeExpiration() — Method in class Domain: Set if the domain can be renewed before the expiry date.
Domain::setIdProtectionStatus() — Method in class Domain: Set if the domain currently has an active ID Protection poduct on it.
Domain::setDnsManagementStatus() — Method in class Domain: Set if DNS Management (A, AAAA, CNAME, etc., records) is active on this domain at the registrar.
Domain::setEmailForwardingStatus() — Method in class Domain: Set if email forwarding is enabled on the domain at the registrar.
Domain::setNameservers() — Method in class Domain: Set the currently active nameservers for the domain.
Domain::setTransferLock() — Method in class Domain: Set the transfer lock status on the domain.
Domain::setTransferLockExpiryDate() — Method in class Domain: Set the expiry date of the transfer lock using a Carbon object.
Domain::setIrtpOptOutStatus() — Method in class Domain: Set if IRTP has been opted out of.
Domain::setIrtpTransferLock() — Method in class Domain: Set the state of the irtp transfer lock.
Domain::setIrtpTransferLockExpiryDate() — Method in class Domain: Set the expiry date of the transfer lock using a Carbon object.
Domain::setDomainContactChangePending() — Method in class Domain: Set if a contact change is pending on the domain.
Domain::setDomainContactChangeExpiryDate() — Method in class Domain: Set the confirmation deadline that the contact change is to be confirmed by using a Carbon object.
Domain::setPendingSuspension() — Method in class Domain: Set if the domain is pending suspension.
Domain::setIsIrtpEnabled() — Method in class Domain: Set if this domain is subject to IRTP policies.
Domain::setIrtpVerificationTriggerFields() — Method in class Domain: Set the fields that trigger IRTP verification when changed.
SearchResult — Class in namespace WHMCS\Domains\DomainLookup: Search results from a domain lookup query
$SearchResult — Property in class SearchResult
$SearchResult — Property in class SearchResult
SearchResult::setScore() — Method in class SearchResult: Set the "score" of this domain compared to the original search query
SearchResult::setPremiumCostPricing() — Method in class SearchResult: Set Premium Cost Pricing.
SearchResult::setStatus() — Method in class SearchResult: Set availability status
Category::scopeOfParent() — Method in class Category: Scopes model for children categories for $parentId
Category::scopeVisible() — Method in class Category: Scopes model to return visible categories only
Download::scopeConsiderProductDownloads() — Method in class Download
Download::scopeTopDownloads() — Method in class Download: Look for "top" downloads.
Download::scopeInCategory() — Method in class Download
Download::scopeVisible() — Method in class Download: Scopes model to return visible downloads only
Download::scopeCategoryVisible() — Method in class Download
Download::scopeSearch() — Method in class Download
Register::setName() — Method in class Register
Register::setNamespaceId() — Method in class Register
Register::setNamespace() — Method in class Register
Register::setValue() — Method in class Register
Register::sinceByNamespace() — Method in class Register
$Template — Property in class Template: Subject line that will be set in the outgoing email that uses this template.
Template::scopeMaster() — Method in class Template: Retrieve "master" mail templates.
AbstractWidget::showWrapper() — Method in class AbstractWidget: Get if panel wrapper should be shown.
AbstractWidget::sanitizeData() — Method in class AbstractWidget
Setting — Class in namespace WHMCS\Module\Addon: Class Setting
$Setting — Property in class Setting
Setting::scopeModule() — Method in class Setting
NotificationModuleInterface::settings() — Method in class NotificationModuleInterface: List of settings required for module activation/configuration
NotificationModuleInterface::sendNotification() — Method in class NotificationModuleInterface: Deliver notification
DescriptionTrait::setDisplayName() — Method in class DescriptionTrait: Set the display name
DescriptionTrait::setLogoFileName() — Method in class DescriptionTrait: Set the logo filename
$Queue — Property in class Queue: The related service
Queue::scopeIncomplete() — Method in class Queue: Where status is unpaid.
Queue::setLastAttemptErrorAttribute() — Method in class Queue: Ensure the Last Attempt Error is populated on display when empty.
Queue::service() — Method in class Queue
$NetworkIssue — Property in class NetworkIssue: The date upon which the effects of this network issue began, or will begin.
$NetworkIssue — Property in class NetworkIssue: An English language internal name of the current state of this network issue from this set: 'Reported', 'Investigating', 'In Progress', 'Outage', 'Scheduled'
NotificationAttributeInterface::setLabel() — Method in class NotificationAttributeInterface
NotificationAttributeInterface::setValue() — Method in class NotificationAttributeInterface
NotificationAttributeInterface::setUrl() — Method in class NotificationAttributeInterface
NotificationAttributeInterface::setStyle() — Method in class NotificationAttributeInterface
NotificationAttributeInterface::setIcon() — Method in class NotificationAttributeInterface
NotificationInterface::setTitle() — Method in class NotificationInterface
NotificationInterface::setMessage() — Method in class NotificationInterface
NotificationInterface::setUrl() — Method in class NotificationInterface
NotificationInterface::setAttributes() — Method in class NotificationInterface
$Addon — Property in class Addon: Whether an addon will appear on order of a related product
$Addon — Property in class Addon: Should suspending the addon, suspend the parent product
$Addon — Property in class Addon: The id number of server group an addon should be provisioned to.
$Addon — Property in class Addon: The service addons utilising this addon.
Addon::scopeShowOnOrderForm() — Method in class Addon: A scope to show Addons available on OrderForm
Addon::scopeIsHidden() — Method in class Addon: A scope to show Addons hidden on OrderForm
Addon::scopeIsNotHidden() — Method in class Addon: A scope to show Addons not hidden on OrderForm
Addon::scopeIsRetired() — Method in class Addon: A scope to show Addons that should not be displayed on OrderForm
Addon::scopeIsNotRetired() — Method in class Addon: A scope to show Addons that may be displayed on OrderForm
Addon::scopeAvailableOnOrderForm() — Method in class Addon: A scope to show Addons available on OrderForm using hidden and show on order options.
Addon::scopeSorted() — Method in class Addon: Sort by display order.
Addon::serviceAddons() — Method in class Addon
Addon::scopeMarketConnect() — Method in class Addon: Quick filter for module = marketconnect.
Group::scopeNotHidden() — Method in class Group: Restrict to groups which are publicly visible.
Group::scopeSorted() — Method in class Group: Sort by display order.
Price::setup() — Method in class Price: Return setup fees
$Product — Property in class Product
$Product — Property in class Product: Whether or not the shopping cart should require a domain be purchased, transferred, or supplied (if already owned) to a product.
$Product — Property in class Product: Whether or not a product has limited stock which must be monitored.
$Product — Property in class Product: The id number of server group a product should be provisioned to.
$Product — Property in class Product: The services provisioned from a product.
Product::services() — Method in class Product: A product can have many service instances of that product.
Product::scopeVisible() — Method in class Product: Filter for only non-hidden products.
Product::scopeSorted() — Method in class Product: Sort by display order.
Product::scopeMarketConnect() — Method in class Product: Quick filter for module = marketconnect.
Product::scopeSsl() — Method in class Product: The following are scope helpers for MarketConnect products.
Product::scopeRapidssl() — Method in class Product
Product::scopeGeotrust() — Method in class Product
Product::scopeSymantec() — Method in class Product
Product::scopeWeebly() — Method in class Product
Product::scopeSpamexperts() — Method in class Product
Product::scopeSitelock() — Method in class Product
Product::scopeMarketConnectProducts() — Method in class Product
Product::scopeCodeguard() — Method in class Product
Product::scopeProductKey() — Method in class Product: Quick filter for a given MarketConnect product key.
$AbstractTask — Property in class AbstractTask
AbstractTask::setName() — Method in class AbstractTask
AbstractTask::setPriority() — Method in class AbstractTask
AbstractTask::setDescription() — Method in class AbstractTask
AbstractTask::setFrequencyMinutes() — Method in class AbstractTask
AbstractTask::setEnabled() — Method in class AbstractTask
AbstractTask::setPeriodic() — Method in class AbstractTask
AbstractTask::status() — Method in class AbstractTask
$Addon — Property in class Addon: ID of service which this addon is attached to.
$Addon — Property in class Addon: Id of server that this addon is on
$Addon — Property in class Addon: Setup fee paid for this addon.
$Addon — Property in class Addon: English language internal name of status of this service, from this set: 'Pending', 'Active', 'Suspended', 'Terminated', 'Cancelled', 'Fraud' (Additionally custom status may exist)
$Addon — Property in class Addon
$Addon — Property in class Addon
$Addon — Property in class Addon
Addon::scopeUserId() — Method in class Addon
Addon::scopeOfService() — Method in class Addon
Addon::scopeActive() — Method in class Addon
Addon::scopeMarketConnect() — Method in class Addon: Filter for only MarketConnect addon services.
Addon::scopeIsConsideredActive() — Method in class Addon
Addon::scopeIsNotRecurring() — Method in class Addon
Addon::service() — Method in class Addon: Each addon belongs to one service.
Addon::ssl() — Method in class Addon: Each addon could have many ssl records.
Addon::serverModel() — Method in class Addon
$CancellationRequest — Property in class CancellationRequest: Unique ID number of the service the client is requesting cancelled.
$CancellationRequest — Property in class CancellationRequest
CancellationRequest::service() — Method in class CancellationRequest: Each cancellation request belongs to one service.
Service — Class in namespace WHMCS\Service: A client-owned service.
$Service — Property in class Service: ID of server this service has been provisioned to.
$Service — Property in class Service: If the service is a recurring service, and a payment gateway which supports subscriptions have been used (such as PayPal), the subscription ID for the payment gateway is stored here.
$Service — Property in class Service: An admin provided string as to why a suspension was enacted on this service.
$Service — Property in class Service
$Service — Property in class Service
Service::scopeUserId() — Method in class Service
Service::scopeActive() — Method in class Service
Service::scopeMarketConnect() — Method in class Service: Filter for only MarketConnect services.
Service::scopeIsConsideredActive() — Method in class Service
Service::scopeIsNotRecurring() — Method in class Service
Service::ssl() — Method in class Service: Each service could have many ssl records.
Service::serverModel() — Method in class Service
$Admin — Property in class Admin: A message displayed at the bottom of an admin's support ticket responses.
$Admin — Property in class Admin: The id numbers of the support departments an admin is assigned to.
Admin::scopeActive() — Method in class Admin: Return only active Admin users
$AdminLog — Property in class AdminLog: An admin's login session id.
AdminLog::scopeOnline() — Method in class AdminLog: Retrieve all admin users who are online.
$Alert — Property in class Alert: An alert's severity.
Alert::setMessage() — Method in class Alert: Set an alert's message.
Alert::setSeverity() — Method in class Alert: Set an alert's severity.
Alert::setLink() — Method in class Alert: Set an optional link target to provide along with an alert.
Alert::setLinkText() — Method in class Alert: Set an optional link text to provide along with an alert.
$Client — Property in class Client: The state or province a client resides in.
$Client — Property in class Client: Whether or not a client should receive separate invoices for their purchased services.
$Client — Property in class Client: The id number of a client's configured security question.
$Client — Property in class Client: The encrypted answer to a client's configured security question.
$Client — Property in class Client: The encrypted name of a client's bank.
$Client — Property in class Client: A client's encrypted bank type.
$Client — Property in class Client: A client's encrypted bank code.
$Client — Property in class Client: A client's encrypted bank account number.
$Client — Property in class Client: A client's status, either "Active", "Inactive", or "Closed".
$Client — Property in class Client: The services a client has purchased.
$Client — Property in class Client: The security question a client has chosen for authentication.
Client::services() — Method in class Client: A client can have many services.
Client::securityQuestion() — Method in class Client: A client can have an associated security question.
Client::scopeLoggedIn() — Method in class Client: Apply filter for the currently authenticated user.
Client::setSecurityQuestionAnswerAttribute() — Method in class Client: Encrypt security question answers for storage.
Client::sendEmailAddressVerification() — Method in class Client: Sends the email address verification email to the client.
$Contact — Property in class Contact: The state or province a client contact resides in.
SecurityQuestion — Class in namespace WHMCS\User\Client: A user's security question.
SecurityQuestion::setQuestionAttribute() — Method in class SecurityQuestion: Encrypt security questions for storage.
Item::setName() — Method in class Item: Set a menu item's name.
Item::setUri() — Method in class Item: Set a menu item's link target.
Item::setLabel() — Method in class Item: Set a menu item's label.
Item::setChildren() — Method in class Item: Set a menu item's child items.
Item::setBadge() — Method in class Item: Set a menu item's badge.
Item::setOrder() — Method in class Item: Set a menu item's sort order.
Item::setClass() — Method in class Item: Set a menu item's css class definitions.
Item::setExtras() — Method in class Item: Set a menu item's extras.
Item::setExtra() — Method in class Item: Set a menu item extra.
Item::setIcon() — Method in class Item: Set the icon displayed next to a menu item.
Item::setBodyHtml() — Method in class Item: Set a menu item's body HTML content.
Item::setFooterHtml() — Method in class Item: Set a menu item's footer HTML content.
Item::setHeadingHtml() — Method in class Item: Set a menu item's heading HTML content.
Item::sort() — Method in class Item: Sort a menu item's children by their sort order then alphabetically by name.
Item::swapOrder() — Method in class Item: Swap the order of the current menu item with another menu item's order.

T

$Announcement — Property in class Announcement
$Announcement — Property in class Announcement: Title to display for the announcement.
$Announcement — Property in class Announcement: If this announcement has translations provided, this is an array of those Announcement objects.
Announcement::translations() — Method in class Announcement: An announcement may be a parent of many child announcements.
$Currency — Property in class Currency
$Currency — Property in class Currency
$Invoice — Property in class Invoice
$Invoice — Property in class Invoice
Invoice::transactions() — Method in class Invoice: Each invoice can have many transactions.
Invoice::transactionHistory() — Method in class Invoice
$Item — Property in class Item
$Item — Property in class Item
$Item — Property in class Item: The type of item to which this invoice line item relates. Empty for no relationship.
$Item — Property in class Item: True, if this items is taxable, otherwise false.
Transaction — Class in namespace WHMCS\Billing\Payment: A payment transaction.
$Transaction — Property in class Transaction
$Transaction — Property in class Transaction
$Transaction — Property in class Transaction: Descriptive name for this transaction. Not to be confused with the transaction's Unique ID number. Null if not set.
$Quote — Property in class Quote
$Quote — Property in class Quote
$Quote — Property in class Quote: Amount of tax due, based on lowest ID number "Level 1" Tax Rule applied to this quote.
$Quote — Property in class Quote: Amount of tax due, based on lowest ID number "Level 2" Tax Rule applied to this quote. Level 2 Rules may or may not be calculated as compound tax.
$Quote — Property in class Quote: Subtotal + Tax1 + Tax2. Use this total instead of calculating your own as Level 2 taxes may or may not be compounded.
$Item — Property in class Item
$Setting — Property in class Setting
$CustomField — Property in class CustomField
$CustomField — Property in class CustomField: The type of custom field client|product|support|addon
$CustomFieldValue — Property in class CustomFieldValue
$AdditionalField — Property in class AdditionalField
$Domain — Property in class Domain
$Domain — Property in class Domain: English language internal name of the type of registration used for this domain from this set: 'Register' and 'Transfer'
$Domain — Property in class Domain: The top level domain (extension).
$Extra — Property in class Extra
$Domain — Property in class Domain
$Domain — Property in class Domain
ResultsList::toArray() — Method in class ResultsList
SearchResult::toArray() — Method in class SearchResult
$Premium — Property in class Premium
$Category — Property in class Category
$Download — Property in class Download
$Download — Property in class Download: English internal name used to identify the download's type. One of this set: 'pdf', 'exe', 'zip'.
$Download — Property in class Download: Name the download will be listed as on the client side.
$Download — Property in class Download: This value should be incremented every time the file is downloaded. It is used to identify "Most Popular" downloads.
$Download — Property in class Download
$Download — Property in class Download
Download::translatedNames() — Method in class Download: Return the translated names for the specific download
Download::translatedDescriptions() — Method in class Download: Return the translated names for the specific download
$Register — Property in class Register
Template — Class in namespace WHMCS\Mail: Functionality related to mail templates.
$Template — Property in class Template
$Template — Property in class Template: English language internal name describing email type, from this set: 'general', 'product', 'support', 'invoice'
$AbstractWidget — Property in class AbstractWidget
$Setting — Property in class Setting
$Setting — Property in class Setting
NotificationModuleInterface::testConnection() — Method in class NotificationModuleInterface: Routine to validate settings for activation/configuration of notification provider
$Queue — Property in class Queue
$NetworkIssue — Property in class NetworkIssue
$NetworkIssue — Property in class NetworkIssue: The title which should be displayed to clients on the Network Issues page.
$Addon — Property in class Addon
$Addon — Property in class Addon: The type of addon for module automation (hostingaccount, reselleraccount, server, other)
$Addon — Property in class Addon
$Addon — Property in class Addon
Addon::translatedNames() — Method in class Addon: Return the translated names for the specific addon
Addon::translatedDescriptions() — Method in class Addon: Return the translated names for the specific addon
$Group — Property in class Group
$Group — Property in class Group: A product group's tagline.
$Group — Property in class Group
$Group — Property in class Group
$Group — Property in class Group
Group::translatedNames() — Method in class Group: Return the translated names for the specific product
Group::translatedHeadlines() — Method in class Group: Return the translated headlines for the specific product
Group::translatedTaglines() — Method in class Group: Return the translated taglines for the specific product
Price::toPrefixedString() — Method in class Price: Format price as a prefixed currency string
Price::toSuffixedString() — Method in class Price: Format price as a suffixed string
Price::toFullString() — Method in class Price: Format price as a full currency string (prefix, amount and suffix)
$Product — Property in class Product
$Product — Property in class Product: A product's type, either "hostingaccount", "reselleraccount", "server", or "other".
$Product — Property in class Product
$Product — Property in class Product
Product::translatedNames() — Method in class Product: Return the translated names for the specific product
Product::translatedDescriptions() — Method in class Product: Return the translated names for the specific product
$AbstractTask — Property in class AbstractTask
$Addon — Property in class Addon
$Addon — Property in class Addon: The date the addon was Terminated or Cancelled.
$CancellationRequest — Property in class CancellationRequest
$Service — Property in class Service
$Service — Property in class Service: Date the service was Terminated or Cancelled.
$Admin — Property in class Admin
$Admin — Property in class Admin: The name of an admin's two factor authentication module, if they are using one.
$Admin — Property in class Admin: An admin's two-factor authentication module's internal data, stored as a PHP serialized string.
$Admin — Property in class Admin: The name of the admin area view template WHMCS renders for an admin.
$Admin — Property in class Admin: alias for $template
$AdminLog — Property in class AdminLog
$AdminLog — Property in class AdminLog
$Client — Property in class Client
$Client — Property in class Client
$Client — Property in class Client: A client's tax id.
$Client — Property in class Client: The name of a client's two factor authentication module, if they are using one.
$Client — Property in class Client: A client's two-factor authentication module's internal data, stored as a PHP serialized string.
$Client — Property in class Client: Whether or not a client is exempt from paying taxes.
$Client — Property in class Client
Client::transactions() — Method in class Client: A client can have many transactions.
Client::tickets() — Method in class Client: A client can have many tickets.
$Affiliate — Property in class Affiliate
$Contact — Property in class Contact
$Contact — Property in class Contact: A client contact's tax id.
$Contact — Property in class Contact
Contact::tickets() — Method in class Contact: A contact can have many tickets.
$SecurityQuestion — Property in class SecurityQuestion
Price::toFull() — Method in class Price: Return price with prefix and suffix.
Price::toPrefixed() — Method in class Price: Return price with prefix only.
Price::toSuffixed() — Method in class Price: Return price with suffix only.
Price::toNumeric() — Method in class Price: Return numeric price only.

U

$Announcement — Property in class Announcement: Date this announcement was last updated.
$Item — Property in class Item: UserID of the invoice this line item belongs to.
$Item — Property in class Item: Individual unit price of this line item.
$Item — Property in class Item: Last date this line item was edited.
$Setting — Property in class Setting: 'setting' is a unique column.
$CustomField — Property in class CustomField: The date a custom field was last modified.
$AdditionalField — Property in class AdditionalField: Last date this additional field was edited.
$Domain — Property in class Domain: Date this domain was last edited.
$Category — Property in class Category: The date this category was first updated.
$Download — Property in class Download: The date this download was last updated.
$Register — Property in class Register
$Register — Property in class Register
$Template — Property in class Template
$Template — Property in class Template
$NetworkIssue — Property in class NetworkIssue: Same as lastUpdateDate.
$Group — Property in class Group: The date a product group was last modified.
$Product — Property in class Product: The id of the email to send to a client when a product's options are upgraded.
$Product — Property in class Product: The date a product was last updated.
$Product — Property in class Product: The email to send to a client when a product's options are upgraded.
$Product — Property in class Product: Products which a product can be upgraded or downgraded to.
Product::upgradeEmailTemplate() — Method in class Product: A product has one upgrade email template.
Product::upgradeProducts() — Method in class Product: A product has many upgrade packages.
$Addon — Property in class Addon: The date this addon was last updated.
$CancellationRequest — Property in class CancellationRequest: Timestamp of when this cancellation request was last modified.
$Service — Property in class Service: Username associated with this service (for external control panels, etc)
$Service — Property in class Service: Date this service was last modified.
$Admin — Property in class Admin
$Admin — Property in class Admin: An admin's username.
$AdminLog — Property in class AdminLog
$AdminLog — Property in class AdminLog: An admin's username.
$Client — Property in class Client
$Client — Property in class Client: A client's username (email).
$Client — Property in class Client: Last update of the client data (or 0000-00-00 00:00:00 if no updated since 6.0.0).
Client::updateLastLogin() — Method in class Client
$Affiliate — Property in class Affiliate: The date an affiliate record was last modified.
$Contact — Property in class Contact: The date a client contact was last updated.
Contact::updateLastLogin() — Method in class Contact
$SecurityQuestion — Property in class SecurityQuestion: The date a security question was last updated.

V

Invoice::vat() — Method in class Invoice
$Quote — Property in class Quote: Date upon which this quote is no longer valid.
$Setting — Property in class Setting
$CustomFieldValue — Property in class CustomFieldValue: The stored value of the custom field
$AdditionalField — Property in class AdditionalField: Value of this additional field.
$Extra — Property in class Extra: the value for the extra information
$Setting — Property in class Setting
Admin::validateUsername() — Method in class Admin: Validate admin username is valid.
$Affiliate — Property in class Affiliate: The number of visitors who have followed affiliate links belonging to an affiliate account.

W

$Domain — Property in class Domain
Register::write() — Method in class Register
$AbstractWidget — Property in class AbstractWidget
$AbstractWidget — Property in class AbstractWidget
$Addon — Property in class Addon: The welcome email template id
$Addon — Property in class Addon: The display order weighting
$Addon — Property in class Addon: The email to send to a client when a product is ordered.
Addon::welcomeEmailTemplate() — Method in class Addon: An addon has one welcome email template.
$Product — Property in class Product: ID number of welcome email template sent to customers when this product is activated.
$Product — Property in class Product: The email to send to a client when a product is ordered.
Product::welcomeEmailTemplate() — Method in class Product: A product has one welcome email template.
$CancellationRequest — Property in class CancellationRequest: English language internal name specifying when the cancellation should take place from this set: 'Immediately', 'End of Billing Cycle'
$Admin — Property in class Admin: The display order for widgets for the Admin user

Y

Price::yearlyPrice() — Method in class Price: Get per year price

_

SearchResult::__construct() — Method in class SearchResult: Construct an object which will express the response of a domain lookup
Template::__toString() — Method in class Template: Represent a mail template by its name.
Price::__construct() — Method in class Price: Initialise price object
Alert::__construct() — Method in class Alert: Build a new user alert.
Price::__construct() — Method in class Price: Construct price object.
Price::__toString() — Method in class Price: Return the default price format with prefix and suffix.