Docs For Class ContentModelArticle

Description

Item Model for an Article.

since: 1.6

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

JObject
   |
   --JModelLegacy
      |
      --JModelForm
         |
         --JModelAdmin
            |
            --ContentModelArticle

Direct descendents

Class	Description
ContentModelFeature	Feature model.

Variable Summary

string $text_prefix

string $typeAlias

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, [integer $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)

void preprocessForm (JForm $form, $data, [ $group = 'content'])

boolean save (array $data)

Variables

string $text_prefix = 'COM_CONTENT' (line 27)

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.

string $typeAlias = 'com_content.article' (line 35)

The type alias for this content type (for example, 'com_content.article').

since: 3.2
access: public

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 JModelLegacy

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

Inherited from JObject

JObject::$_errors

Methods

batchCopy (line 48)

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 151)

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.

canEditState (line 172)

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.

cleanCache (line 695)

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:

JModelLegacy::cleanCache(): Clean the cache

featured (line 543)

Method to toggle the featured setting of articles.

return: True on success.
access: public

boolean featured (array $pks, [integer $value = 0])

array $pks: The ids of the items to toggle.
integer $value: The value to toggle to.

getForm (line 310)

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 246)

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.

getReorderConditions (line 632)

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.

Redefined in descendants as:

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

getTable (line 234)

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:

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

Redefined in descendants as:

ContentModelFeature::getTable() : Returns a Table object, always creating it.

loadFormData (line 390)

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 201)

Prepare and sanitise the table data prior to saving.

since: 1.6
access: protected

void prepareTable (JTable $table)

JTable $table: A JTable object.

preprocessForm (line 647)

Auto-populate the model state.

Note. Calling getState in this method will result in recursion.

since: 3.0
access: protected

void preprocessForm (JForm $form, $data, [ $group = 'content'])

JForm $form
$data
$group

Redefinition of:

JModelForm::preprocessForm(): Method to allow derived classes to preprocess the form.

save (line 420)

Method to save the form data.

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

boolean save (array $data)

array $data: The form data.

Inherited Methods

Inherited From JModelAdmin

JModelAdmin::__construct()
JModelAdmin::batch()
JModelAdmin::batchAccess()
JModelAdmin::batchCopy()

Inherited From JModelForm

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

Inherited From JModelLegacy

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

Inherited From JObject

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