UCMContent

Extends UCMBase

Base class for implementing UCM

since

3.1

package

Application

Methods

__construct

Instantiate the UCMBase.

__construct(string alias = null, \Joomla\CMS\UCM\UCMType type = null) : mixed
inherited
since

3.1

Arguments

alias

stringThe alias string

type

\Joomla\CMS\UCM\UCMTypeThe 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

mixedArray or comma-separated string of ids to delete

type

\Joomla\CMS\UCM\UCMTypeThe content type object

Response

boolTrue if success

getPrimaryKey

Get the value of the primary key from #__ucm_base

getPrimaryKey(int typeId, int contentItemId) : int
since

3.1

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
inherited
since

3.1

Response

\Joomla\CMS\UCM\UCMTypeThe UCM content type

mapBase

Method to map the base ucm fields

mapBase(array original, \Joomla\CMS\UCM\UCMType type = null) : array
inherited
since

3.1

Arguments

original

arrayData array

type

\Joomla\CMS\UCM\UCMTypeUCM Content Type

Response

arrayData 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

arrayThe original data array

type

\Joomla\CMS\UCM\UCMTypeType 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

arrayThe original data to be saved

type

\Joomla\CMS\UCM\UCMTypeThe UCM Type object

Response

booltrue

store

Store data to the appropriate table

store(array data, \Joomla\CMS\Table\TableInterface table = null, string primaryKey = null) : bool
inherited
since

3.1

throws

\Exception

Arguments

data

arrayData to be stored

table

\Joomla\CMS\Table\TableInterfaceTable Object

primaryKey

stringThe primary key name

Response

boolTrue on success

Properties

table

The related table object

since

3.1

Type(s)

Table

ucmData

The UCM data array

since

3.1

Type(s)

array

type

The UCM type object

inherited
since

3.1

Type(s)

UCMType

alias

The alias for the content table

inherited
since

3.1

Type(s)

string