Docs For Class JUcmType

Description

Implements interfaces:

JUcm

UCM Class for handling content types

since: 3.1

Located in /libraries/cms/ucm/type.php (line 53)

Variable Summary

string $alias

JDatabaseDriver $db

JUcmType $type

Method Summary

JUcmType __construct ([string $alias = null], [JDatabaseDriver $database = null], [JApplicationBase $application = null])

mixed fieldmapExpand ([boolean $assoc = false])

object The getType ([integer $pk = null])

object The getTypeByAlias ([string $typeAlias = null])

mixed getTypeByTable (string $tableName)

mixed getTypeId ([string $alias = null])

string __get (string $ucmField)

Variables

string $alias (line 77)

The alias for the content type

since: 3.1
access: protected

JDatabaseDriver $db (line 69)

The Database object

since: 3.1
access: protected

JUcmType $type (line 61)

The UCM Type

since: 3.1
access: public

Methods

Constructor __construct (line 88)

Class constructor

since: 3.1
access: public

JUcmType __construct ([string $alias = null], [JDatabaseDriver $database = null], [JApplicationBase $application = null])

string $alias: The alias for the item
JDatabaseDriver $database: The database object
JApplicationBase $application: The application object

fieldmapExpand (line 226)

Method to expand the field mapping

return: Array or object with field mappings. Defaults to object.
since: 3.2
access: public

mixed fieldmapExpand ([boolean $assoc = false])

boolean $assoc: True to return an associative array.

getType (line 107)

Get the Content Type

return: UCM Type data
since: 3.1
access: public

object The getType ([integer $pk = null])

integer $pk: The primary key of the alias type

getTypeByAlias (line 135)

Get the Content Type from the alias

return: UCM Type data
since: 3.2
access: public

object The getTypeByAlias ([string $typeAlias = null])

string $typeAlias: The alias for the type

getTypeByTable (line 158)

Get the Content Type from the table class name

return: The UCM Type data if found, false if no match is found
since: 3.2
access: public

mixed getTypeByTable (string $tableName)

string $tableName: The table for the type

getTypeId (line 193)

Retrieves the UCM type ID

return: The ID of the requested type or false if type is not found
since: 3.1
access: public

mixed getTypeId ([string $alias = null])

string $alias: The string of the type alias

__get (line 247)

Magic method to get the name of the field mapped to a ucm field (core_something).

return: The name mapped to the $ucmField for a given content type
since: 3.2
access: public

string __get (string $ucmField)

string $ucmField: The name of the field in JTableCorecontent