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
get()
getAll()
delete()
getColumn()
getCount()
getRatingForPage()
save()
saveColumn()
search()
Fields

\Components\Website\Comments::

Use this API to create, update and delete website comments.

Methods

Invoke via \Components\Website\Comments::method()
Click a method name to copy it.
array get($iCommentId)
Gets a record from the database
Parameters
$iCommentId
int unsigned
A record's comment_id
Return
Comments
array getAll($arrQuery)
Return a set of records from the database
Parameters
$arrQuery
mixed
Return
Array of Comments
bool delete($iCommentId, $bDeleteMedia)
Deletes a record from the database
Parameters
$iCommentId
int unsigned
A record's comment_id
$bDeleteMedia
mixed
Return
Returns true if record existed and was deleted, otherwise false
mixed getColumn($iCommentId, $strColumn)
Gets a single field from a record
Parameters
$iCommentId
int unsigned
A record's comment_id
$strColumn
mixed
Return
mixed
int getCount($arrFilter)
Returns the number of records in the database (matching the filter if specified)
Parameters
$arrFilter
mixed
Return
int
float getRatingForPage($strPageId)
Returns a score out of 5 for the ratings left on the page specified
Parameters
$strPageId
mixed
Return
float
string|int save($arrEntity)
Saves a record into the database
Parameters
$arrEntity
mixed
Return
string|int
void saveColumn($iCommentId, $strColumn, $strValue)
Saves a specific column of a row into a database
Parameters
$iCommentId
int unsigned
A record's comment_id
$strColumn
mixed
$strValue
mixed
array search($strSearch, $arrQuery)
Performs a search
Parameters
$strSearch
mixed
$arrQuery
mixed
Return
Array of Comments that match the search query.

Database Fields

The following fields are used when retrieving and saving entities.