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
filtersForMonths()
filtersForYears()
delete()
get()
getAll()
getAllForCategory()
getAllInEveryCategory()
getAllLinkingToPage()
getColumn()
getCount()
getCountForCategory()
getForCurrentPage()
getNextForCurrentPage()
getPreviousForCurrentPage()
save()
saveColumn()
search()
Fields

\Components\Website\Posts::

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

Methods

Invoke via \Components\Website\Posts::method()
Click a method name to copy it.
array filtersForMonths($iNumMonths)
Datasource for retreiving a list of months with a filter that can be applied to API calls for posts.

Useful for creating a list of months that can be clicked to view the posts for that month.
Parameters
$iNumMonths
int
Return
Array of ['date_start', 'date_end', 'filter', 'month']
array filtersForYears($iNumYears)
Datasource for retreiving a list of years with a filter that can be applied to API calls for posts.

Useful for creating a list of years that can be clicked to view the posts for that month.
Parameters
$iNumYears
int
Return
Array of ['date_start', 'date_end', 'filter', 'month']
bool delete($iPostId, $bDeleteMedia)
Deletes a record from the database
Parameters
$iPostId
int
A record's post_id
$bDeleteMedia
bool
Return
Returns true if record existed and was deleted, otherwise false
array get($iPostId)
Gets a record from the database
Parameters
$iPostId
int
A record's post_id
Return
Posts
array getAll($arrQuery)
Return a set of records from the database
Parameters
$arrQuery
array|null
Query Array
Return
Array of Posts
array getAllForCategory($arrCategoryIds, $arrQuery)
Returns all posts for a single given category, or in any array of categories
Parameters
$arrCategoryIds
array
OR int $iCategoryId Category Id
$arrQuery
array|null
Query Array
Return
Array of Posts
array getAllInEveryCategory($arrCategoryIds, $arrQuery)
Returns all posts that must belong to every category specified
Parameters
$arrCategoryIds
array
$arrQuery
array|null
Query Array
Return
Array of Posts
array getAllLinkingToPage($strPageId, $arrQuery)
Returns all posts linking to a page
Parameters
$strPageId
int
$arrQuery
array|null
Query Array
Return
array
mixed getColumn($iPostId, $strColumn)
Gets a single field from a record
Parameters
$iPostId
int
A record's post_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 getCountForCategory($iCategoryId, $arrFilter)
Returns the number of posts for a given category
Parameters
$iCategoryId
int
Category Id
$arrFilter
array
Return
int
array getForCurrentPage()
Returns the most recent post linking to the current page
Return
array
array getNextForCurrentPage()
Returns the post after the one linked to the current page

Useful for including in your design to add a [Next Post] button
Return
array
array getPreviousForCurrentPage()
Returns the post before the one linked to the current page

Useful for including in your design to add a [Previous Post] button
Return
array
string|int save($arrEntity)
Saves a record into the database
Parameters
$arrEntity
mixed
Return
string|int
void saveColumn($iPostId, $strColumn, $strValue)
Saves a specific column of a row into a database
Parameters
$iPostId
int
A record's post_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 Posts that match the search query.

Database Fields

The following fields are used when retrieving and saving entities.
post_id
int (11)
post_title
string (128)
post_content_short
string (16777215)
post_icon
string (255)
post_content_type
Default value: none
post_content_url
string (255)
post_created_page
0 or 1
post_date
datetime
Default value: 0000-00-00 00:00:00
post_is_offline
0 or 1
post_category_id
int unsigned (10)
contact_id
string (16)