\Website\Posts
Templating
Global Functions
Website
\Components\Website\Designs \Components\Website\Media \Components\Website\Pages \Components\Website\Pages\Forms \Components\Website\Posts
METHODS
\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 \Components\Marketing\Events\Recurring \Components\Marketing\Events\Recurring\Rules \Components\Marketing\SMSMarketing
Commerce
\Components\Commerce\Carts \Components\Commerce\Carts\Current \Components\Commerce\Discounts \Components\Commerce\Products \Components\Commerce\Products\Brands \Components\Commerce\Products\Categories \Components\Commerce\Products\Inventory \Components\Commerce\RecurringSales\Items \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\DOM\CurrentContext \Framework\HTML\Converters \Framework\HTTP\Cookies \Framework\HTTP\Redirection \Framework\HTTP\Request \Framework\HTTP\Session \Framework\HTTP\TabState \Framework\HTTP\UserAgent \Framework\I18N\CompanyTypes \Framework\I18N\Countries \Framework\I18N\Languages

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.
- ` \Iterator dbGetAllIterable($arrQuery) `
Returns the raw rows dbGetAll() would return as an iterator, without building them all into an array

The dbGetAll() counterpart of getAllIterable(), for scans over every stored row of a large table (eg: the site-wide content scans in \Framework\Developer\Refactoring). Rows are as stored - JSON fields are not decoded - and are not entity-cached. Because it bypasses getAll(), components that override getAll() are iterated; search queries and components overriding dbGetAll() are refused.
Parameters:
- $arrQuery
mixed
Return
Yields Posts
- ` array fieldsGetAll($bCached) `
Returns all the columns this component supports
Parameters:
- $bCached
mixed
Return
array
- ` 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
mixed
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
mixed
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
mixed
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
- ` array getAll($arrQuery) `
Return a set of records from the database
Parameters:
- $arrQuery
mixed
Return
Array of Posts
- ` array getAllForCategory($arrCategoryIds, $arrQuery) `
Returns all posts for a single given category, or in any array of categories
Parameters:
- $arrCategoryIds
mixed
- $arrQuery
mixed
Return
Array of Posts
- ` array getAllInEveryCategory($arrCategoryIds, $arrQuery) `
Returns all posts that must belong to every category specified
Parameters:
- $arrCategoryIds
mixed
- $arrQuery
mixed
Return
Array of Posts
- ` \Iterator getAllIterable($arrQuery) `
Returns the entities getAll() would return as an iterator, without building them all into an array

For result sets too large to hold as arrays (eg: every recipient of a marketing send) - only the database driver's compact buffer of the result is held, a fraction of getAll()'s memory. Runs the same SQL as getAll(), and runs it now, as getAll() would; rows are decoded as you iterate.
Search queries are not supported, rows are not entity-cached, and components that override getAll() or dbGetAll() (eg: merging in defaults) are refused rather than iterated without their extra rows.
Parameters:
- $arrQuery
mixed
Return
Yields Posts
- ` array getAllLinkingToPage($strPageId, $arrQuery) `
Returns all posts linking to a page
Parameters:
- $strPageId
mixed
- $arrQuery
mixed
Return
Array of Posts
- ` mixed getColumn($iPostId, $strColumn) `
Gets a single field from a record
Parameters:
- $iPostId
int
A record's post_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
- ` int getCountForCategory($iCategoryId, $arrFilter) `
Returns the number of posts for a given category
Parameters:
- $iCategoryId
mixed
- $arrFilter
mixed
Return
int
- ` array|null getForCurrentPage() `
Returns the most recent post linking to the current page
Return
- ` array|null 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|null 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
- ` 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
mixed
- $strValue
mixed
- ` array search($strSearch, $arrQuery) `
Performs a search
Parameters:
- $strSearch
mixed
- $arrQuery
mixed
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: current_timestamp()
- `post_is_offline`
0 or 1
- `post_category_id`
int unsigned (10)
- `contact_id`
string (16)