Components \ commerce \ affiliates administrators commissions payments \ configuration paymentmethods \ shippingmethods \ methods delivery discounts \ products brands categories \ recurringsales storedcards \ sales items \ receipts allocations \ customers \ contacts passwords referrertypes \ relationships types \ groups contacts \ marketing \ emailmarketing \ sends contacts unsubscribers \ events attendees locations \ reminders \ automation eventremindertrigger \ settings administrators components configurationitems cpanel customfields \ developer scheduledtasks threads domains \ website \ analytics sessions comments \ designs generator media pages \ posts categories Framework \ architecture publicassets \ assets css javascript \ caching filebased \ components textualids \ data util \ database mainconnection date \ dom currentcontext renderer \ html converters highlighter javascript \ http redirection request session useragent \ i18n companytypes countries languages \ network cidr dns geoip random \ reflection api \ system filenames filesystem toasts
.
.
.
quick access
\ methods

\Components\Website\Pages::

Class Methods

The following static methods are available on this class:
array analyticsGetSums($strColumn, $strDateStart, $strDateEnd, $strInterval, $arrProperties)
Description
Returns the sums of a column over a period
Parameters
$strColumn
string
$strDateStart
string
$strDateEnd
string
$strInterval
string
hour|day|month|year
$arrProperties
array
Return
array
string classGetFolder()
Description
Returns the folder where the class exists
Parameters
none
Return
string
string classGetFolderResources()
Description
Returns the folder where the class's resources exist
Parameters
none
Return
string
string configGetValue($strConfigId)
Description
Retrieves the value of a config item for the current component
Parameters
$strConfigId
string
Return
Config item value
array current()
Description
Returns the current page
Parameters
none
Return
Page row corresponding to the current page visited
string currentGetColumn($strColumn)
Description
Retreives an attribute for the current page
Parameters
$strColumn
string
Return
Value of the attribute
bool currentIsChildPageOf($strPageId, $bIncludePage)
Description
Returns whether or not the current page is a child page of $strPageId
Parameters
$strPageId
string
$bIncludePage
bool
If true, returns true if $strPageId == currentPageId()
Return
bool
string currentPageId()
Description
Returns the current page id

'/' when visiting the home page '/about/' when visiting about page etc.
Parameters
none
Return
Page id corresponding to the current page visited
string currentPageQuery()
Description
If the page is handling a child 404 request, the page query returns the child part
Parameters
none
Return
Query
bool delete($strKeyValue, $bDeleteMedia, $strReason)
Description
Deletes an entity and triggers the pre/post component events
Parameters
$strKeyValue
string
$bDeleteMedia
bool
$strReason
mixed
Return
bool
array fieldsCustomGetAll()
Description
Returns all the columns in the custom fields table
Parameters
none
Return
array
array fieldsCustomGetAllExt($bPublic, $bShowInLists, $bSearchable, $arrCustomFilter)
Description
Returns all the columns in the custom fields table
Parameters
$bPublic
mixed
$bShowInLists
mixed
$bSearchable
mixed
$arrCustomFilter
mixed
Return
array
array fieldsGetAll($bCached)
Description
Returns all the columns this component supports
Parameters
$bCached
mixed
Return
array
array get($strKey)
Description
Returns an entity
Parameters
$strKey
mixed
Value of the primary key
Return
Entity
{Array} getAll($arrProperties)
Description
Return all entities in the database.
Parameters
$arrProperties
mixed
Return
Array of Pages
void getAutoIncrementId($arrEntity)
Description
Returns the last inserted id
Parameters
$arrEntity
mixed
Return
void
array getChildren($strId, $arrProperties)
Description
Returns all pages nested directly underneath a page
Parameters
$strId
string
Page Id
$arrProperties
array
Return
array
int getChildrenCount($strPageId, $arrFilter)
Description
Returns the number of pages nested directly underneath a page
Parameters
$strPageId
string
Page Id
$arrFilter
array
Return
int
array getChildrenRecursive($strId, $arrProperties)
Description
Returns all pages nested directly underneath a page
Parameters
$strId
string
Page Id
$arrProperties
array
Return
array
void getChildrenWithRedirectors($strId, $arrProperties)
Description
Retrieves the children of a specific page, but includes redirectors which appear in navigation
Parameters
$strId
string
$arrProperties
array
Return
void
mixed getColumn($strKey, $strColumn)
Description
Returns a single column of an entity
Parameters
$strKey
string
$strColumn
string
Return
mixed
int getCount($arrFilter)
Description
Returns a count of all rows in the data adapter
Parameters
$arrFilter
array
Return
int
string mediaFolderGet($strKey)
Description
Returns the media folder for this data adapter
Parameters
$strKey
mixed
Return
Folder
mixed save($arrEntity, $strReason)
Description
Saves an entity and triggers the pre/post component events
Parameters
$arrEntity
array
$strReason
string
Return
mixed
mixed saveColumn($strKeyValue, $strColumn, $strValue, $strReason)
Description
Changes a column of an existing entity Supports primary keys spanning on several columns if passing $strKeyValue as an associative arry
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

Database Fields

The following fields are used when retrieving and saving entities.
contact_id
int (11)
design_id
int (11)
page_accept_child_404
tinyint unsigned (1)
page_api_class_link
text
page_content
mediumtext
page_content_additional
mediumtext
page_created
datetime
Default value: 0000-00-00 00:00:00
page_css
mediumtext
page_header_category
varchar (255)
page_header_functions
text
page_icon
varchar (127)
page_id
varchar (255)
page_is_domain
tinyint unsigned (1)
page_is_hidden_in_navigation
tinyint (1)
page_is_hidden_in_sitemap
tinyint unsigned (1)
page_is_offline
tinyint unsigned (1)
page_js
mediumtext
page_last_modified
datetime
Default value: 0000-00-00 00:00:00
page_order
int (11)
page_other_fields
text
page_parent_id
varchar (255)
page_php_source
mediumtext
page_search_change_frequency
varchar (16)
page_search_description
varchar (255)
page_search_description_inherited
varchar (255)
page_search_keywords
varchar (255)
page_search_keywords_inherited
varchar (255)
page_search_nofollow
tinyint unsigned (1)
page_search_noindex
tinyint unsigned (1)
page_search_priority
decimal unsigned (2,1)
Default value: 0.5
page_search_title
varchar (255)
page_search_title_prefix
varchar (255)
page_search_title_prefix_inherited
varchar (255)
page_security_condition_id
smallint unsigned (5)
page_security_contact_groups
text
page_security_contact_mode
enum ('contacts','group','conditions')
page_security_contact_require_login
tinyint (1)
page_security_contact_squeeze_viewlimit
smallint unsigned (5)
page_security_description
varchar (255)
page_security_heading
varchar (255)
page_security_new
tinyint unsigned (1)
page_title
varchar (127)
page_type_id
int (10)
page_visits_total
int unsigned (10)