Docs For Class JUcmBase

Description

Implements interfaces:

JUcm

Base class for implementing UCM

since: 3.1

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

Direct descendents

Class	Description
JUcmContent	Base class for implementing UCM

Variable Summary

string $alias

JUcmType $type

Method Summary

JUcmBase __construct ([string $alias = null], [JUcmType $type = null])

object The getType ()

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

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

Variables

string $alias (line 35)

The alias for the content table

since: 3.1
access: protected

Redefined in descendants as:

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

JUcmType $type (line 27)

The UCM type object

since: 3.1
access: protected

Redefined in descendants as:

JUcmContent::$type : The UCM type object

Methods

Constructor __construct (line 45)

Instantiate the UcmBase.

since: 3.1
access: public

JUcmBase __construct ([string $alias = null], [JUcmType $type = null])

string $alias: The alias string
JUcmType $type: The type object

Redefined in descendants as:

JUcmContent::__construct() : Instantiate JUcmContent.

getType (line 109)

Get the UCM Content type.

return: UCM content type
since: 3.1
access: public

object The getType ()

mapBase (line 126)

Method to map the base ucm fields

return: Data array of UCM mappings
since: 3.1
access: public

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

array $original: Data array
JUcmType $type: UCM Content Type

store (line 66)

Store data to the appropriate table

return: True on success
since: 3.1
throws: Exception
access: protected

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

array $data: Data to be stored
JTable $table: JTable Object
string $primaryKey: The primary key name

Redefined in descendants as:

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