Templating
Global Functions
Website
\Components\Website\Designs \Components\Website\Pages \Components\Website\Pages\Forms \Components\Website\Posts \Components\Website\Posts\Categories
Customers
\Components\Customers\Contacts \Components\Customers\Contacts\Relationships \Components\Customers\Contacts\Relationships\Types \Components\Customers\Groups
Marketing
\Components\Marketing\EmailMarketing \Components\Marketing\Events \Components\Marketing\Events\Attendees \Components\Marketing\Events\Locations
Commerce
\Components\Commerce\Configuration\PaymentMethods \Components\Commerce\Configuration\ShippingMethods \Components\Commerce\Discounts \Components\Commerce\Products \Components\Commerce\Products\Brands \Components\Commerce\Products\Categories \Components\Commerce\Products\Inventory \Components\Commerce\Sales \Components\Commerce\Sales\Items \Components\Commerce\Sales\Receipts \Components\Commerce\Sales\Receipts\Allocations
Settings
\Components\Settings\Administrators \Components\Settings\Domains
Other Apps
\Components\Website\Comments \Components\Commerce\Affiliates \Components\Commerce\Affiliates\Administrators \Components\Commerce\Affiliates\Commissions \Components\Commerce\Affiliates\Payments \Components\Commerce\RecurringSales \Components\Commerce\RecurringSales\StoredCards
Framework
\Framework\Caching\FileBased \Framework\Data\Util \Framework\HTML\Converters \Framework\HTTP\Cookies \Framework\HTTP\Redirection \Framework\HTTP\Request \Framework\HTTP\Session \Framework\HTTP\UserAgent \Framework\I18N\CompanyTypes \Framework\I18N\Countries \Framework\I18N\Languages \Framework\Network\GeoIP
Methods

\Components\Settings\Domains::

Manage the domain names which are hooked up to your website.

Methods

Invoke via \Components\Settings\Domains::method()
Click a method name to copy it.
array get($strDomainName)
Gets a record from the database
Parameters
$strDomainName
string
A record's domain_name
Return
array getAll($arrQuery)
Return a set of records from the database
Parameters
$arrQuery
array|null
Return
Array of Domains
mixed getColumn($strDomainName, $strColumn)
Gets a single field from a record
Parameters
$strDomainName
string
A record's domain_name
$strColumn
string
Return
mixed
int getCount($arrFilter)
Returns the number of records in the database (matching the filter if specified)
Parameters
$arrFilter
array|null
Return
int
string getPrimary($bHostFallback)
Determines the primary domain by looking at the config value, then the host from the http request
Parameters
$bHostFallback
bool
If primary domain isn't configured, fall back to http host?
Return
Domain
string save($arrEntity)
Saves a record into the database
Parameters
$arrEntity
array
Return
The record's domain_name
void saveColumn($strDomainName, $strColumn, $strValue)
Saves a specific column of a row into a database
Parameters
$strDomainName
string
A record's domain_name
$strColumn
string
$strValue
string
array search($strSearch, $arrQuery)
Performs a search
Parameters
$strSearch
string
Search query
$arrQuery
array|null
Return
Array of Domains that match the search query.
bool delete($strDomainName, $bDeleteMedia)
Deletes a record from the database
Parameters
$strDomainName
string
A record's domain_name
$bDeleteMedia
bool
Return
Returns true if record existed and was deleted, otherwise false

Database Fields

The following fields are used when retrieving and saving entities.
domain_name
string (255)
domain_redirect_uri
string (255)
domain_redirect_301
0 or 1
Default value: 1
domain_mode
Default value: redirect_primary
domain_has_ssl_certificate
0 or 1
domain_is_system
int (1)