UCMContent
Extends UCMBaseBase class for implementing UCM
| since |
3.1 |
|---|---|
| deprecated |
5.4.0 will be removed in 7.0 without replacement |
| package |
Joomla CMS |
Methods
__construct
Instantiate UCMContent.
__construct(\Joomla\CMS\Table\TableInterface table = null, alias = null, \Joomla\CMS\UCM\UCMType type = null) :
| since |
3.1 |
|---|---|
| deprecated |
5.4.0 will be removed in 7.0 without replacement |
Arguments
- table
TableInterface|nullThe table object- alias
stringThe type alias- type
UCMType|nullThe type object
Response
mixed
delete
Delete content from the Core Content table
delete( pk, \Joomla\CMS\UCM\UCMType type = null) :
| since |
3.1 |
|---|---|
| deprecated |
5.4.0 will be removed in 7.0 without replacement |
Arguments
- pk
mixedArray or comma-separated string of ids to delete- type
UCMType|nullThe content type object
Response
boolTrue if success
getPrimaryKey
Get the value of the primary key from #__ucm_base
getPrimaryKey( typeId, contentItemId) :
| since |
3.1 |
|---|---|
| deprecated |
5.4.0 will be removed in 7.0 without replacement |
Arguments
- typeId
intThe ID for the type- contentItemId
intValue of the primary key in the legacy or secondary table
Response
intThe integer of the primary key
getType
Get the UCM Content type.
getType() : \Joomla\CMS\UCM\UCMType
| since |
3.1 |
|---|---|
| deprecated |
5.4.0 will be removed in 7.0 without replacement |
Response
UCMTypeThe UCM content type
mapBase
Method to map the base ucm fields
mapBase(mixed||string|int original, \Joomla\CMS\UCM\UCMType type = null) : mixed||string|int
| since |
3.1 |
|---|---|
| deprecated |
5.4.0 will be removed in 7.0 without replacement |
Arguments
- original
array<string|int, mixed>Data array- type
UCMType|nullUCM Content Type
Response
array<string|int, mixed>Data array of UCM mappings
mapData
Map the original content to the Core Content fields
mapData(mixed||string|int original, \Joomla\CMS\UCM\UCMType type = null) : array||string|int
| since |
3.1 |
|---|---|
| deprecated |
5.4.0 will be removed in 7.0 without replacement |
Arguments
- original
array<string|int, mixed>The original data array- type
UCMType|nullType object for this data
Response
array<string|int, array<string|int, mixed>>$ucmData The mapped UCM data
save
Method to save the data
save(mixed||string|int original = null, \Joomla\CMS\UCM\UCMType type = null) :
| since |
3.1 |
|---|---|
| deprecated |
5.4.0 will be removed in 7.0 without replacement |
Arguments
- original
array<string|int, mixed>The original data to be saved- type
UCMType|nullThe UCM Type object
Response
booltrue
store
Store data to the appropriate table
store(mixed||string|int data, \Joomla\CMS\Table\TableInterface table = null, primaryKey = null) :
| since |
3.1 |
|---|---|
| deprecated |
5.4.0 will be removed in 7.0 without replacement |
Arguments
- data
array<string|int, mixed>Data to be stored- table
TableInterface|nullTable Object- primaryKey
boolFlag that is true for data that are using #__ucm_content as their primary table
Response
booltrue on success
Properties
type
The UCM type object
alias
The alias for the content table
| since |
3.1 |
|---|---|
| deprecated |
5.4.0 will be removed in 7.0 without replacement |
Type(s)
string
table
The related table object
ucmData
The UCM data array
| since |
3.1 |
|---|---|
| deprecated |
5.4.0 will be removed in 7.0 without replacement |
Type(s)
array<string|int, array<string|int, mixed>>