Class ContentModelArticle

Description

Item Model for an Article.

  • since: 1.6

Located in /administrator/components/com_content/models/article.php (line 24)

JObject
   |
   --JModel
      |
      --JModelForm
         |
         --JModelAdmin
            |
            --ContentModelArticle
Direct descendents
Class Description
ContentModelFeature Feature model.
Variable Summary
string $text_prefix
Method Summary
mixed batchCopy (integer $value, array $pks, array $contexts)
boolean canDelete (object $record)
boolean canEditState (object $record)
void cleanCache ([ $group = null], [ $client_id = 0])
boolean featured (array $pks, [int $value = 0])
mixed getForm ([array $data = array()], [boolean $loadData = true])
mixed getItem ([integer $pk = null])
array getReorderConditions (object A $table)
JTable getTable ([type $type = 'Content'], [string $prefix = 'JTable'], [array $config = array()])
mixed loadFormData ()
void prepareTable (JTable &$table)
boolean save (array $data)
Variables
string $text_prefix = 'COM_CONTENT' (line 30)
  • var: The prefix to use with controller messages.
  • since: 1.6
  • access: protected

Redefinition of:
JModelAdmin::$text_prefix
The prefix to use with controller messages.

Inherited Variables

Inherited from JModelAdmin

JModelAdmin::$event_after_delete
JModelAdmin::$event_after_save
JModelAdmin::$event_before_delete
JModelAdmin::$event_before_save
JModelAdmin::$event_change_state

Inherited from JModelForm

JModelForm::$_forms

Inherited from JModel

JModel::$event_clean_cache
JModel::$name
JModel::$option
JModel::$state
JModel::$_db
JModel::$__state_set

Inherited from JObject

JObject::$_errors
Methods
batchCopy (line 43)

Batch copy items to a new category or current.

  • return: An array of new IDs on success, boolean false on failure.
  • since: 11.1
  • access: protected
mixed batchCopy (integer $value, array $pks, array $contexts)
  • integer $value: The new category.
  • array $pks: An array of row IDs.
  • array $contexts: An array of item contexts.

Redefinition of:
JModelAdmin::batchCopy()
Batch copy items to a new category or current.
canDelete (line 174)

Method to test whether a record can be deleted.

  • return: True if allowed to delete the record. Defaults to the permission set in the component.
  • since: 1.6
  • access: protected
boolean canDelete (object $record)
  • object $record: A record object.

Redefinition of:
JModelAdmin::canDelete()
Method to test whether a record can be deleted.
canEditState (line 193)

Method to test whether a record can have its state edited.

  • return: True if allowed to change the state of the record. Defaults to the permission set in the component.
  • since: 1.6
  • access: protected
boolean canEditState (object $record)
  • object $record: A record object.

Redefinition of:
JModelAdmin::canEditState()
Method to test whether a record can be deleted.
cleanCache (line 535)

Custom clean the cache of com_content and content modules

  • since: 1.6
  • access: protected
void cleanCache ([ $group = null], [ $client_id = 0])
  • $group
  • $client_id

Redefinition of:
JModel::cleanCache()
Clean the cache
featured (line 435)

Method to toggle the featured setting of articles.

  • return: True on success.
  • access: public
boolean featured (array $pks, [int $value = 0])
  • array $pks: The ids of the items to toggle.
  • int $value: The value to toggle to.
getForm (line 297)

Method to get the record form.

  • return: A JForm object on success, false on failure
  • since: 1.6
  • access: public
mixed getForm ([array $data = array()], [boolean $loadData = true])
  • array $data: Data for the form.
  • boolean $loadData: True if the form is to load its own data (default case), false if not.

Redefinition of:
JModelForm::getForm()
Abstract method for getting the form from the model.
getItem (line 257)

Method to get a single record.

  • return: Object on success, false on failure.
  • access: public
mixed getItem ([integer $pk = null])
  • integer $pk: The id of the primary key.

Redefinition of:
JModelAdmin::getItem()
Method to get a single record.
getReorderConditions (line 523)

A protected method to get a set of ordering conditions.

  • return: An array of conditions to add to add to ordering queries.
  • since: 1.6
  • access: protected
array getReorderConditions (object A $table)
  • object A $table: record object.

Redefinition of:
JModelAdmin::getReorderConditions()
A protected method to get a set of ordering conditions.

Redefined in descendants as:
getTable (line 245)

Returns a Table object, always creating it.

  • return: A database object
  • access: public
JTable getTable ([type $type = 'Content'], [string $prefix = 'JTable'], [array $config = array()])
  • type $type: The table type to instantiate
  • string $prefix: A prefix for the table class name. Optional.
  • array $config: Configuration array for model. Optional.

Redefinition of:
JModel::getTable()
Method to get a table object, load it if necessary.

Redefined in descendants as:
loadFormData (line 365)

Method to get the data that should be injected in the form.

  • return: The data for the form.
  • since: 1.6
  • access: protected
mixed loadFormData ()

Redefinition of:
JModelForm::loadFormData()
Method to get the data that should be injected in the form.
prepareTable (line 219)

Prepare and sanitise the table data prior to saving.

  • since: 1.6
  • access: protected
void prepareTable (JTable &$table)
  • JTable &$table: A JTable object.

Redefinition of:
JModelAdmin::prepareTable()
Prepare and sanitise the table data prior to saving.
save (line 391)

Method to save the form data.

  • return: True on success.
  • since: 1.6
  • access: public
boolean save (array $data)
  • array $data: The form data.

Redefinition of:
JModelAdmin::save()
Method to save the form data.

Inherited Methods

Inherited From JModelAdmin

JModelAdmin::__construct()
JModelAdmin::batch()
JModelAdmin::batchAccess()
JModelAdmin::batchCopy()
JModelAdmin::batchLanguage()
JModelAdmin::batchMove()
JModelAdmin::canDelete()
JModelAdmin::canEditState()
JModelAdmin::checkin()
JModelAdmin::checkout()
JModelAdmin::delete()
JModelAdmin::generateNewTitle()
JModelAdmin::getItem()
JModelAdmin::getReorderConditions()
JModelAdmin::populateState()
JModelAdmin::prepareTable()
JModelAdmin::publish()
JModelAdmin::reorder()
JModelAdmin::save()
JModelAdmin::saveorder()

Inherited From JModelForm

JModelForm::checkin()
JModelForm::checkout()
JModelForm::getForm()
JModelForm::loadForm()
JModelForm::loadFormData()
JModelForm::preprocessForm()
JModelForm::validate()

Inherited From JModel

JModel::__construct()
JModel::addIncludePath()
JModel::addTablePath()
JModel::cleanCache()
JModel::getDbo()
JModel::getInstance()
JModel::getName()
JModel::getState()
JModel::getTable()
JModel::populateState()
JModel::setDbo()
JModel::setState()
JModel::_createFileName()
JModel::_createTable()
JModel::_getList()
JModel::_getListCount()

Inherited From JObject

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

Documentation generated on Mon, 25 Jun 2012 13:52:20 -0500 by phpDocumentor 1.4.4