Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe ArticleModel
+ Graphe d'héritage de ArticleModel:

Fonctions membres publiques

 __construct ($config=array(), MVCFactoryInterface $factory=null, FormFactoryInterface $formFactory=null)
 
 publish (&$pks, $value=1)
 
 getItem ($pk=null)
 
 getForm ($data=array(), $loadData=true)
 
 validate ($form, $data, $group=null)
 
 featured ($pks, $value=0, $featuredUp=null, $featuredDown=null)
 
 hit ()
 
 delete (&$pks)
 
- Fonctions membres publiques hérités de AdminModel
 __construct ($config=array(), MVCFactoryInterface $factory=null, FormFactoryInterface $formFactory=null)
 
 batch ($commands, $pks, $contexts)
 
 checkin ($pks=array())
 
 checkout ($pk=null)
 
 delete (&$pks)
 
 getItem ($pk=null)
 
 publish (&$pks, $value=1)
 
 reorder ($pks, $delta=0)
 
 save ($data)
 
 saveorder ($pks=array(), $order=null)
 
 generateTitle ($categoryId, $table)
 
 initBatch ()
 
 editAssociations ($data)
 
- Fonctions membres publiques hérités de FormModel
 __construct ($config=array(), MVCFactoryInterface $factory=null, FormFactoryInterface $formFactory=null)
 
 checkin ($pk=null)
 
 checkout ($pk=null)
 
 validate ($form, $data, $group=null)
 
- Fonctions membres publiques hérités de BaseDatabaseModel
 __construct ($config=array(), MVCFactoryInterface $factory=null)
 
 getTable ($name='', $prefix='', $options=array())
 
 isCheckedOut ($item)
 
 getDbo ()
 
 setDbo (DatabaseInterface $db=null)
 
 __get ($name)
 
- Fonctions membres publiques hérités de BaseModel
 __construct ($config=array())
 
 getName ()
 
- Fonctions membres publiques hérités de CMSObject
 __construct ($properties=null)
 
 __toString ()
 
 def ($property, $default=null)
 
 get ($property, $default=null)
 
 getProperties ($public=true)
 
 getError ($i=null, $toString=true)
 
 getErrors ()
 
 set ($property, $value=null)
 
 setProperties ($properties)
 
 setError ($error)
 
- Fonctions membres publiques hérités de StatefulModelInterface
 getState ($property=null, $default=null)
 
 setState ($property, $value=null)
 
- Fonctions membres publiques hérités de DispatcherAwareInterface
 setDispatcher (DispatcherInterface $dispatcher)
 
- Fonctions membres publiques hérités de CurrentUserInterface
 setCurrentUser (User $currentUser)
 
- Fonctions membres publiques hérités de CacheControllerFactoryAwareInterface
 setCacheControllerFactory (CacheControllerFactoryInterface $factory)
 
- Fonctions membres publiques hérités de DatabaseAwareInterface
 setDatabase (DatabaseInterface $db)
 
- Fonctions membres publiques hérités de FormFactoryAwareInterface
 setFormFactory (FormFactoryInterface $factory)
 
- Fonctions membres publiques hérités de WorkflowModelInterface
 setUpWorkflow ($extension)
 
 workflowPreprocessForm (Form $form, $data)
 
 workflowBeforeStageChange ()
 
 workflowBeforeSave ()
 
 workflowAfterSave ($data)
 
 workflowCleanupBatchMove ($oldId, $newId)
 
 executeTransition (array $pks, int $transitionId)
 
 getState ($property=null, $default=null)
 
 getName ()
 
 getTable ($name='', $prefix='', $options=array())
 

Champs de données

 $typeAlias = 'com_content.article'
 
- Champs de données hérités de AdminModel
 $typeAlias
 

Fonctions membres protégées

 cleanupPostBatchCopy (TableInterface $table, $newId, $oldId)
 
 batchMove ($value, $pks, $contexts)
 
 canDelete ($record)
 
 canEditState ($record)
 
 prepareTable ($table)
 
 loadFormData ()
 
 getReorderConditions ($table)
 
 preprocessForm (Form $form, $data, $group='content')
 
 cleanCache ($group=null, $clientId=0)
 
- Fonctions membres protégées hérités de AdminModel
 batchAccess ($value, $pks, $contexts)
 
 batchCopy ($value, $pks, $contexts)
 
 cleanupPostBatchCopy (TableInterface $table, $newId, $oldId)
 
 batchLanguage ($value, $pks, $contexts)
 
 batchMove ($value, $pks, $contexts)
 
 batchTag ($value, $pks, $contexts)
 
 canDelete ($record)
 
 canEditState ($record)
 
 generateNewTitle ($categoryId, $alias, $title)
 
 getReorderConditions ($table)
 
 populateState ()
 
 prepareTable ($table)
 
 checkCategoryId ($categoryId)
 
 redirectToAssociations ($data)
 
- Fonctions membres protégées hérités de BaseDatabaseModel
 _getList ($query, $limitstart=0, $limit=0)
 
 _getListCount ($query)
 
 _createTable ($name, $prefix='Table', $config=array())
 
 bootComponent ($component)
 
 dispatchEvent (EventInterface $event)
 

Attributs protégés

 $text_prefix = 'COM_CONTENT'
 
 $associationsContext = 'com_content.item'
 
 $event_before_change_featured = null
 
 $event_after_change_featured = null
 
- Attributs protégés hérités de AdminModel
 $text_prefix = null
 
 $event_after_delete = null
 
 $event_after_save = null
 
 $event_before_delete = null
 
 $event_before_save = null
 
 $event_before_change_state = null
 
 $event_change_state = null
 
 $event_before_batch = null
 
 $batch_copymove = 'category_id'
 
 $batch_commands
 
 $associationsContext = null
 
 $batchSet = null
 
 $user = null
 
 $table = null
 
 $tableClassName = null
 
 $contentType = null
 
 $type = null
 
- Attributs protégés hérités de FormModel
 $events_map = null
 
- Attributs protégés hérités de BaseDatabaseModel
 $option = null
 
 $event_clean_cache = null
 
- Attributs protégés hérités de BaseModel
 $name
 
- Attributs protégés hérités de CMSObject
 $_errors = array()
 

Fonctions membres privées

 canCreateCategory ()
 

Membres hérités additionnels

- Fonctions membres publiques statiques hérités de BaseModel
static addIncludePath ($path='', $prefix='')
 
- Attributs protégés statiques hérités de BaseModel
static $paths
 

Description détaillée

Item Model for an Article.

Depuis
1.6

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $config = array(),
MVCFactoryInterface  $factory = null,
FormFactoryInterface  $formFactory = null 
)

Constructor.

Paramètres
array$configAn array of configuration options (name, state, dbo, table_path, ignore_request).
MVCFactoryInterface$factoryThe factory.
FormFactoryInterface$formFactoryThe form factory.
Depuis
1.6
Exceptions

Références $config, Symfony\Contracts\Service\__construct(), et Joomla\CMS\MVC\Model\setUpWorkflow().

Documentation des fonctions membres

◆ batchMove()

batchMove (   $value,
  $pks,
  $contexts 
)
protected

Batch move categories to a new category.

Paramètres
integer$valueThe new category ID.
array$pksAn array of row IDs.
array$contextsAn array of item contexts.
Renvoie
boolean True on success.
Depuis
3.8.6

Références $field, $fields, $value, Text\_(), Factory\getApplication(), FieldsHelper\getFields(), Factory\getUser(), PluginHelper\importPlugin(), et Text\sprintf().

◆ canCreateCategory()

canCreateCategory ( )
private

Is the user allowed to create an on the fly category?

Renvoie
boolean
Depuis
3.6.1

Références Factory\getUser().

◆ canDelete()

canDelete (   $record)
protected

Method to test whether a record can be deleted.

Paramètres
object$recordA record object.
Renvoie
boolean True if allowed to delete the record. Defaults to the permission set in the component.
Depuis
1.6

Références Factory\getUser().

◆ canEditState()

canEditState (   $record)
protected

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

Paramètres
object$recordA record object.
Renvoie
boolean True if allowed to change the state of the record. Defaults to the permission set in the component.
Depuis
1.6

Références $user, et Factory\getUser().

◆ cleanCache()

cleanCache (   $group = null,
  $clientId = 0 
)
protected

Custom clean the cache of com_content and content modules

Paramètres
string$groupThe cache group
integer$clientId

◆ cleanupPostBatchCopy()

cleanupPostBatchCopy ( TableInterface  $table,
  $newId,
  $oldId 
)
protected

Function that can be overridden to do any data cleanup after batch copying data

Paramètres
TableInterface$tableThe table object containing the newly created item
integer$newIdThe id of the new item
integer$oldIdThe original item id
Renvoie
void
Depuis
3.8.12

Références $db, $field, $fields, $query, Factory\getApplication(), Joomla\Database\getDatabase(), FieldsHelper\getFields(), ParameterType\INTEGER, ParameterType\NULL, ParameterType\STRING, et Joomla\CMS\MVC\Model\workflowCleanupBatchMove().

◆ delete()

delete ( $pks)

Delete #__content_frontpage items if the deleted articles was featured

Paramètres
object$pksThe primary key related to the contents that was deleted.
Renvoie
boolean
Depuis
3.7.0

Références $db, $query, $return, et Joomla\Database\getDatabase().

◆ featured()

featured (   $pks,
  $value = 0,
  $featuredUp = null,
  $featuredDown = null 
)

Method to toggle the featured setting of articles.

Paramètres
array$pksThe ids of the items to toggle.
integer$valueThe value to toggle to.
string | Date$featuredUpThe date which item featured up.
string | Date$featuredDownThe date which item featured down.
Renvoie
boolean True on success.

Références $context, $db, $name, $query, $this, $value, Text\_(), AbstractEvent\create(), Factory\getApplication(), Joomla\Database\getDatabase(), PluginHelper\importPlugin(), ParameterType\INTEGER, ParameterType\NULL, null, ParameterType\STRING, ArrayHelper\toInteger(), et Joomla\CMS\MVC\Model\workflowBeforeStageChange().

◆ getForm()

getForm (   $data = array(),
  $loadData = true 
)

Method to get the record form.

Paramètres
array$dataData for the form.
boolean$loadDataTrue if the form is to load its own data (default case), false if not.
Renvoie
Form|boolean A Form object on success, false on failure
Depuis
1.6

Implémente FormModelInterface.

Références $app, $data, $form, $id, Factory\getApplication(), Joomla\CMS\MVC\Model\getState(), Factory\getUser(), Joomla\CMS\MVC\Model\loadForm(), null, et value.

◆ getItem()

getItem (   $pk = null)

Method to get a single record.

Paramètres
integer$pkThe id of the primary key.
Renvoie
mixed Object on success, false on failure.

Références $assoc, $db, $item, $query, Associations\getAssociations(), Joomla\Database\getDatabase(), if, ParameterType\INTEGER, Associations\isEnabled(), et null.

◆ getReorderConditions()

getReorderConditions (   $table)
protected

A protected method to get a set of ordering conditions.

Paramètres
object$tableA record object.
Renvoie
array An array of conditions to add to ordering queries.
Depuis
1.6

Références Joomla\Database\getDatabase().

◆ hit()

hit ( )

Void hit function for pagebreak when editing content from frontend

Renvoie
void
Depuis
3.6.0

◆ loadFormData()

loadFormData ( )
protected

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

Renvoie
mixed The data for the form.
Depuis
1.6

Références $app, $data, $filters, Factory\getApplication(), Joomla\CMS\MVC\Model\getState(), null, et Joomla\CMS\MVC\Model\preprocessData().

◆ prepareTable()

prepareTable (   $table)
protected

Prepare and sanitise the table data prior to saving.

Paramètres
\Joomla\CMS\Table\Table$tableA Table object.
Renvoie
void
Depuis
1.6

Références Workflow\CONDITION_PUBLISHED, Factory\getDate(), et null.

◆ preprocessForm()

preprocessForm ( Form  $form,
  $data,
  $group = 'content' 
)
protected

Allows preprocessing of the Form object.

Paramètres
Form$formThe form object
array$dataThe data to be merged into the form object
string$groupThe plugin group to be executed
Renvoie
void
Depuis
3.0

Références $data, $field, $fields, $form, $language, $languages, Associations\isEnabled(), null, Joomla\CMS\MVC\Model\preprocessForm(), et Joomla\CMS\MVC\Model\workflowPreprocessForm().

◆ publish()

publish ( $pks,
  $value = 1 
)

Method to change the published state of one or more records.

Paramètres
array&$pksA list of the primary keys to change.
integer$valueThe value of the published state.
Renvoie
boolean True on success.
Depuis
4.0.0

Références $value, et Joomla\CMS\MVC\Model\workflowBeforeStageChange().

◆ validate()

validate (   $form,
  $data,
  $group = null 
)

Method to validate the form data.

Paramètres
Form$formThe form to validate against.
array$dataThe data to validate.
string$groupThe name of the field group to validate.
Renvoie
array|boolean Array of filtered data if valid, false otherwise.
Voir également
JFilterInput
Depuis
3.7.0

Références $data, $form, et Factory\getUser().

Documentation des champs

◆ $associationsContext

$associationsContext = 'com_content.item'
protected

◆ $event_after_change_featured

$event_after_change_featured = null
protected

◆ $event_before_change_featured

$event_before_change_featured = null
protected

◆ $text_prefix

$text_prefix = 'COM_CONTENT'
protected

◆ $typeAlias

$typeAlias = 'com_content.article'

La documentation de cette classe a été générée à partir du fichier suivant :