UCMContent
Extends UCMBaseBase class for implementing UCM
since |
3.1 |
---|---|
package |
Joomla CMS |
Methods
__construct
Instantiate the UCMBase.
__construct(string alias = null, \Joomla\CMS\UCM\UCMType type = null) : mixed
since |
3.1 |
---|
Arguments
- alias
string
The alias string- type
\Joomla\CMS\UCM\UCMType
The type object
Response
mixed
delete
Delete content from the Core Content table
delete(mixed pk, \Joomla\CMS\UCM\UCMType type = null) : bool
since |
3.1 |
---|
Arguments
- pk
mixed
Array or comma-separated string of ids to delete- type
\Joomla\CMS\UCM\UCMType
The content type object
Response
bool
True if success
getPrimaryKey
Get the value of the primary key from #__ucm_base
getPrimaryKey(int typeId, int contentItemId) : int
since |
3.1 |
---|
Arguments
- typeId
int
The ID for the type- contentItemId
int
Value of the primary key in the legacy or secondary table
Response
int
The integer of the primary key
getType
Get the UCM Content type.
getType() : \Joomla\CMS\UCM\UCMType
since |
3.1 |
---|
Response
\Joomla\CMS\UCM\UCMType
The UCM content type
mapBase
Method to map the base ucm fields
mapBase(array original, \Joomla\CMS\UCM\UCMType type = null) : array
since |
3.1 |
---|
Arguments
- original
array
Data array- type
\Joomla\CMS\UCM\UCMType
UCM Content Type
Response
array
Data array of UCM mappings
mapData
Map the original content to the Core Content fields
mapData(array original, \Joomla\CMS\UCM\UCMType type = null) : array
since |
3.1 |
---|
Arguments
- original
array
The original data array- type
\Joomla\CMS\UCM\UCMType
Type object for this data
Response
array
$ucmData The mapped UCM data
save
Method to save the data
save(array original = null, \Joomla\CMS\UCM\UCMType type = null) : bool
since |
3.1 |
---|
Arguments
- original
array
The original data to be saved- type
\Joomla\CMS\UCM\UCMType
The UCM Type object
Response
bool
true
store
Store data to the appropriate table
store(array data, \Joomla\CMS\Table\TableInterface table = null, string primaryKey = null) : bool
since |
3.1 |
---|---|
throws |
|
Arguments
- data
array
Data to be stored- table
\Joomla\CMS\Table\TableInterface
Table Object- primaryKey
string
The primary key name
Response
bool
True on success