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\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\Assets\CSS \Framework\Assets\JavaScript \Framework\Caching\FileBased \Framework\Data\Util \Framework\Date \Framework\DOM\Renderer \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
currentIsAdministrator()
get()
getAll()
getColumn()
getCount()
getRoleIdForAdministrator()
save()
saveColumn()
search()
delete()
Fields

\Components\Settings\Administrators::

Manage people who have access to the administration console.

Class Methods

The following methods are available on this class:
bool currentIsAdministrator($bRequiresLogin)
Description
Returns whether or not the current contact is an administrator of any type
Parameters
$bRequiresLogin
mixed
Return
bool
array get($strKey)
Description
Gets a record from the database
Parameters
$strKey
mixed
Value of the primary key
Return
Administrators
array getAll($arrProperties)
Description
Return a set of records from the database
Parameters
$arrProperties
array
Properties Array
Return
Array of Administrators
mixed getColumn($strKey, $strColumn)
Description
Gets a single field from a record
Parameters
$strKey
string
$strColumn
string
Return
mixed
int getCount($arrFilter)
Description
Returns the number of rows in the database
Parameters
$arrFilter
array
Return
int
int getRoleIdForAdministrator($iContactId)
Description
Returns the role id for a particular administrator
Parameters
$iContactId
int
Return
int
mixed save($arrEntity, $strReason)
Description
Saves a record into the database
Parameters
$arrEntity
array
$strReason
string
Return
mixed
mixed saveColumn($strKeyValue, $strColumn, $strValue, $strReason)
Description
Saves a specific column of a row into a database
Parameters
$strKeyValue
string
$strColumn
string
$strValue
string
$strReason
string
Return
Id
array search($strSearch, $arrProperties)
Description
Performs a search
Parameters
$strSearch
string
$arrProperties
mixed
Return
array
bool delete($strKeyValue, $bDeleteMedia, $strReason)
Description
Deletes a record from the database
Parameters
$strKeyValue
string|array
$bDeleteMedia
bool
$strReason
mixed
Return
bool

Database Fields

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