\Marketing\Events\Categories
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
DESCRIPTION
METHODS
addEventToCategory()
dbGetAllIterable()
fieldsGetAll()
delete()
get()
getAll()
getAllForEvent()
getAllIterable()
getColumn()
getCount()
isEventInCategory()
save()
saveColumn()
search()
\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

Categories


Methods

Invoke via \Components\Marketing\Events\Categories::method()
Click a method name to copy it.
- ` void addEventToCategory($iEventId, $iCategoryId) `
Set an event as belonging to a category.
Parameters:
- $iEventId
mixed
- $iCategoryId
mixed
- ` \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 Categories
- ` array fieldsGetAll($bCached) `
Returns all the columns this component supports
Parameters:
- $bCached
mixed
Return
array
- ` bool delete($iEventCategoryId, $bDeleteMedia) `
Deletes a record from the database
Parameters:
- $iEventCategoryId
int
A record's event_category_id
- $bDeleteMedia
mixed
Return
Returns true if record existed and was deleted, otherwise false
- ` array get($iEventCategoryId) `
Gets a record from the database
Parameters:
- $iEventCategoryId
int
A record's event_category_id
Return
Categories
- ` array getAll($arrQuery) `
Return a set of records from the database
Parameters:
- $arrQuery
mixed
Return
Array of Categories
- ` array getAllForEvent($iEventId) `
Return all of the categories that an event belongs to.
Parameters:
- $iEventId
mixed
Return
Rows from the marketing_events_categories_events table with the column 'event_category_id'.
- ` \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 Categories
- ` mixed getColumn($iEventCategoryId, $strColumn) `
Gets a single field from a record
Parameters:
- $iEventCategoryId
int
A record's event_category_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
- ` bool isEventInCategory($iEventId, $iCategoryId) `
Is the event marked as belonging to a category.
Parameters:
- $iEventId
mixed
- $iCategoryId
mixed
Return
True if belongs, false otherwise.
- ` string|int save($arrEntity) `
Saves a record into the database
Parameters:
- $arrEntity
mixed
Return
string|int
- ` void saveColumn($iEventCategoryId, $strColumn, $strValue) `
Saves a specific column of a row into a database
Parameters:
- $iEventCategoryId
int
A record's event_category_id
- $strColumn
mixed
- $strValue
mixed
- ` array search($strSearch, $arrQuery) `
Performs a search
Parameters:
- $strSearch
mixed
- $arrQuery
mixed
Return
Array of Categories that match the search query.

Database Fields

The following fields are used when retrieving and saving entities:
- `event_category_id`
int (10)
- `event_category_title`
string (127)
- `event_category_description`
string (16777215)