Docs For Class JUcmContent

Description

Base class for implementing UCM

since: 3.1

Located in /libraries/cms/ucm/content.php (line 19)

JUcmBase
   |
   --JUcmContent

Variable Summary

string $alias

JTable $table

JUcmType $type

array $ucmData

Method Summary

JUcmContent __construct ([JTable $table = null], [sring $alias = null], [JUcmType $type = null])

boolean delete (mixed $pk, [JUcmType $type = null])

integer getPrimaryKey (string $typeId, integer $contentItemId)

object mapData (array $original, [JUcmType $type = null])

boolean save ([array $original = null], [JUcmType $type = null])

Boolean store (array $data, [JTable $table = null], [boolean $primaryKey = null])

Variables

string $alias (line 43)

The alias for the content table

since: 3.1
access: protected

Redefinition of:

JUcmBase::$alias: The alias for the content table

JTable $table (line 27)

The related table object

since: 3.1
access: protected

JUcmType $type (line 35)

The UCM type object

since: 3.1
access: public

Redefinition of:

JUcmBase::$type: The UCM type object

array $ucmData (line 51)

The UCM data array

since: 3.1
access: public

Methods

Constructor __construct (line 62)

Instantiate JUcmContent.

since: 3.1
access: public

JUcmContent __construct ([JTable $table = null], [sring $alias = null], [JUcmType $type = null])

JTable $table: The table object
sring $alias: The type alias
JUcmType $type: The type object

Redefinition of:

JUcmBase::__construct(): Instantiate the UcmBase.

delete (line 119)

Delete content from the Core Content table

return: True if success
since: 3.1
access: public

boolean delete (mixed $pk, [JUcmType $type = null])

mixed $pk: The string/array of id's to delete
JUcmType $type: The content type object

getPrimaryKey (line 239)

Get the value of the primary key from #__ucm_base

return: The integer of the primary key
since: 3.1
access: public

integer getPrimaryKey (string $typeId, integer $contentItemId)

string $typeId: The ID for the type
integer $contentItemId: Value of the primary key in the legacy or secondary table

mapData (line 150)

Map the original content to the Core Content fields

return: The mapped UCM data
since: 3.1
access: public

object mapData (array $original, [JUcmType $type = null])

array $original: The original data array
JUcmType $type: Type object for this data

save (line 91)

Method to save the data

return: true
since: 3.1
access: public

boolean save ([array $original = null], [JUcmType $type = null])

array $original: The original data to be saved
JUcmType $type: The UCM Type object

store (line 205)

Store data to the appropriate table

return: true on success
since: 3.1
access: protected

Boolean store (array $data, [JTable $table = null], [boolean $primaryKey = null])

array $data: Data to be stored
JTable $table: JTable Object
boolean $primaryKey: Flag that is true for data that are using #__ucm_content as their primary table

Redefinition of:

JUcmBase::store(): Store data to the appropriate table

Inherited Methods

Inherited From JUcmBase

JUcmBase::__construct()
JUcmBase::getType()
JUcmBase::mapBase()
JUcmBase::store()