Templating
Global Functions
Website
\Components\Website\Designs \Components\Website\Media \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\Categories \Components\Marketing\Events\Locations
Commerce
\Components\Commerce\Carts \Components\Commerce\Carts\Current \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\CustomFields \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 \Framework\Data\Util \Framework\HTML\Bleacher \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
Description
Methods
delete()
currentIsAdministrator()
get()
getAll()
getColumn()
getCount()
getRoleIdForAdministrator()
save()
saveColumn()
search()
Fields

\Components\Settings\Administrators::

Manage people who have access to the administration console.

Methods

Invoke via \Components\Settings\Administrators::method()
Click a method name to copy it.
bool delete($iContactId, $bDeleteMedia)
Deletes a record from the database
Parameters
$iContactId
int unsigned
A record's contact_id
$bDeleteMedia
bool
Return
Returns true if record existed and was deleted, otherwise false
bool currentIsAdministrator($bRequiresLogin)
Returns whether or not the current contact is an administrator of any type
Parameters
$bRequiresLogin
mixed
Return
bool
array get($iContactId)
Gets a record from the database
Parameters
$iContactId
int unsigned
A record's contact_id
Return
Administrators
array getAll($arrQuery)
Return a set of records from the database
Parameters
$arrQuery
array|null
Query Array
Return
Array of Administrators
mixed getColumn($iContactId, $strColumn)
Gets a single field from a record
Parameters
$iContactId
int unsigned
A record's contact_id
$strColumn
string
Return
mixed
int getCount($arrFilter)
Returns the number of records in the database (matching the filter if specified)
Parameters
$arrFilter
array|null
Filter Array
Return
int
int getRoleIdForAdministrator($iContactId)
Returns the role id for a particular administrator
Parameters
$iContactId
int
Return
int
string|int save($arrEntity)
Saves a record into the database
Parameters
$arrEntity
mixed
Return
string|int
void saveColumn($iContactId, $strColumn, $strValue)
Saves a specific column of a row into a database
Parameters
$iContactId
int unsigned
A record's contact_id
$strColumn
string
$strValue
string
array search($strSearch, $arrQuery)
Performs a search
Parameters
$strSearch
string
Search query
$arrQuery
array|null
Query Array
Return
Array of Administrators that match the search query.

Database Fields

The following fields are used when retrieving and saving entities.
contact_id
int unsigned (10)
administrator_role_id
string (31)
administrator_verification_code
string (10)
administrator_verification_code_email_datetime
datetime