Designs
Use this API to create, update and delete website designs.
Methods
Invoke via
Click a method name to copy it.
\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
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
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)