Docs For Class JTableCorecontent

Description

Core content table

since: 3.1

Located in /libraries/cms/table/corecontent.php (line 19)

JObject
   |
   --JTable
      |
      --JTableCorecontent

Method Summary

JTableCorecontent __construct (JDatabaseDriver $db)

mixed bind (array $array, [mixed $ignore = ''])

boolean check ()

boolean delete ([integer $pk = null])

boolean deleteByContentId ([integer $contentItemId = null])

boolean publish ([mixed $pks = null], [integer $state = 1], [integer $userId = 0])

boolean store ([boolean $updateNulls = false])

boolean storeUcmBase ([boolean $updateNulls = false], [boolean $isNew = false])

Variables

Inherited Variables

Inherited from JTable

JTable::$_autoincrement
JTable::$_db
JTable::$_locked
JTable::$_observers
JTable::$_rules
JTable::$_tbl
JTable::$_tbl_key
JTable::$_tbl_keys
JTable::$_trackAssets

Inherited from JObject

JObject::$_errors

Methods

Constructor __construct (line 28)

Constructor

since: 3.1
access: public

JTableCorecontent __construct (JDatabaseDriver $db)

JDatabaseDriver $db: A database connector object

Redefinition of:

JTable::__construct(): Object constructor to set table and key fields. In most cases this will be overridden by child classes to explicitly set the table and key fields for a particular database table.

bind (line 45)

Overloaded bind function

return: Null if operation was satisfactory, otherwise returns an error string
see: JTable::bind()
since: 3.1
access: public

mixed bind (array $array, [mixed $ignore = ''])

array $array: Named array
mixed $ignore: An optional array or space separated list of properties to ignore while binding.

Redefinition of:

JTable::bind(): Method to bind an associative array or object to the JTable instance.This method only binds properties that are publicly accessible and optionally takes an array of properties to ignore when binding.

check (line 93)

Overloaded check function

return: True on success, false on failure
see: JTable::check()
since: 3.1
access: public

boolean check ()

Redefinition of:

JTable::check(): Method to perform sanity checks on the JTable instance properties to ensure they are safe to store in the database. Child classes should override this method to make sure the data they are storing in the database is safe and as expected before storage.

delete (line 164)

Override JTable delete method to include deleting corresponding row from #__ucm_base.

return: True on success.
since: 3.1
throws: UnexpectedValueException
access: public

boolean delete ([integer $pk = null])

integer $pk: primary key value to delete. Must be set or throws an exception.

Redefinition of:

JTable::delete(): Method to delete a row from the database table by primary key value.

deleteByContentId (line 180)

Method to delete a row from the #__ucm_content table by content_item_id.

return: True on success.
since: 3.1
throws: UnexpectedValueException
access: public

boolean deleteByContentId ([integer $contentItemId = null])

integer $contentItemId: value of the core_content_item_id to delete. Corresponds to the primary key of the content table.

publish (line 308)

Method to set the publishing state for a row or list of rows in the database table. The method respects checked out rows by other users and will attempt to checkin rows that it can after adjustments are made.

return: True on success.
since: 3.1
access: public

boolean publish ([mixed $pks = null], [integer $state = 1], [integer $userId = 0])

mixed $pks: An optional array of primary key values to update. If not set the instance property value is used.
integer $state: The publishing state. eg. [0 = unpublished, 1 = published]
integer $userId: The user id of the user performing the operation.

Redefinition of:

JTable::publish(): Method to set the publishing state for a row or list of rows in the database table. The method respects checked out rows by other users and will attempt to checkin rows that it can after adjustments are made.

store (line 212)

Overrides JTable::store to set modified data and user id.

return: True on success.
since: 3.1
access: public

boolean store ([boolean $updateNulls = false])

boolean $updateNulls: True to update fields even if they are null.

Redefinition of:

JTable::store(): Method to store a row in the database from the JTable instance properties.

storeUcmBase (line 263)

Insert or update row in ucm_base table

return: True on success.
since: 3.1
access: protected

boolean storeUcmBase ([boolean $updateNulls = false], [boolean $isNew = false])

boolean $updateNulls: True to update fields even if they are null.
boolean $isNew: if true, need to insert. Otherwise update.

Inherited Methods

Inherited From JTable

JTable::__construct()
JTable::addIncludePath()
JTable::appendPrimaryKeys()
JTable::attachObserver()
JTable::bind()
JTable::check()
JTable::checkIn()
JTable::checkOut()
JTable::delete()
JTable::getDbo()
JTable::getFields()
JTable::getInstance()
JTable::getKeyName()
JTable::getNextOrder()
JTable::getObserverOfClass()
JTable::getPrimaryKey()
JTable::getRules()
JTable::getTableName()
JTable::hasPrimaryKey()
JTable::hit()
JTable::isCheckedOut()
JTable::load()
JTable::move()
JTable::publish()
JTable::reorder()
JTable::reset()
JTable::save()
JTable::setDBO()
JTable::setRules()
JTable::store()
JTable::_getAssetName()
JTable::_getAssetParentId()
JTable::_getAssetTitle()
JTable::_lock()
JTable::_unlock()

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::__toString()