\Website\Designs
Templating
Global Functions
Website
\Components\Website\Designs
DESCRIPTION
METHODS
delete()
get()
getAll()
getAllDeleted()
getColumn()
getCount()
getIncludingDeleted()
save()
saveColumn()
search()
\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\DOM\CurrentContext \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

Designs

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

Methods

Invoke via \Components\Website\Designs::method()
Click a method name to copy it.
- ` bool delete($iDesignId, $bDeleteMedia) `
Deletes a record from the database
Parameters:
- $iDesignId
int
A record's design_id
- $bDeleteMedia
mixed
Return
Returns true if record existed and was deleted, otherwise false
- ` array get($iDesignId) `
Gets a record from the database
Parameters:
- $iDesignId
int
A record's design_id
Return
Designs
- ` array getAll($arrQuery) `
Return a set of records from the database
Parameters:
- $arrQuery
mixed
Return
Array of Designs
- ` array getAllDeleted($arrQuery) `
Return all soft deleted records in the database.
Parameters:
- $arrQuery
mixed
Return
Array of Designs
- ` mixed getColumn($iDesignId, $strColumn) `
Gets a single field from a record
Parameters:
- $iDesignId
int
A record's design_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
- ` array getIncludingDeleted($iDesignId) `
Returns a record, regardless of whether or not it has been deleted
Parameters:
- $iDesignId
int
A record's design_id
Return
Designs
- ` string|int save($arrEntity) `
Saves a record into the database
Parameters:
- $arrEntity
mixed
Return
string|int
- ` void saveColumn($iDesignId, $strColumn, $strValue) `
Saves a specific column of a row into a database
Parameters:
- $iDesignId
int
A record's design_id
- $strColumn
mixed
- $strValue
mixed
- ` array search($strSearch, $arrQuery) `
Performs a search
Parameters:
- $strSearch
mixed
- $arrQuery
mixed
Return
Array of Designs that match the search query.

Database Fields

The following fields are used when retrieving and saving entities:
- `design_id`
int (11)
- `design_created_datetime`
datetime
Default value: current_timestamp()
- `design_modified_datetime`
datetime
Default value: current_timestamp()
- `design_deleted_datetime`
datetime
- `design_type`
Default value: web
- `design_title`
string (63)
- `design_html`
string (4294967295)
- `design_css`
string (4294967295)
- `design_js`
string (4294967295)
- `design_php_source`
string (4294967295)
- `design_mobile_function`
Default value: none
- `design_mobile_value`
string (16777215)