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

Fonctions membres publiques

 __construct ($config=[])
 
 getItems ()
 
 getPagination ()
 
 getStart ()
 
 getTotal ()
 
- 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)
 

Attributs privés

 $mediaApiModel
 
 $total = 0
 

Membres hérités additionnels

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

Description détaillée

Media web service model supporting lists of media items.

Depuis
4.1.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $config = [])

Documentation des fonctions membres

◆ getItems()

getItems ( )

Method to get a list of files and/or folders.

Renvoie
array An array of data items.
Depuis
4.1.0

A hacky way to enable the standard jsonapiView::displayList() to create a Pagination object. Because com_media's ApiModel does not support pagination as we know from regular ListModel derived models, we always return all retrieved items.

Implémente ListModelInterface.

Références $options, $path, Joomla\CMS\MVC\Model\getState(), Joomla\Component\Media\Administrator\Provider\resolveAdapterAndPath(), et Text\sprintf().

◆ getPagination()

getPagination ( )

Method to get a object for the data set.

Renvoie
Pagination A Pagination object for the data set.
Depuis
4.1.0

◆ getStart()

getStart ( )

Method to get the starting number of items for the data set. Because com_media's ApiModel does not support pagination as we know from regular ListModel derived models, we always start at the top.

Renvoie
int The starting number of items available in the data set.
Depuis
4.1.0

◆ getTotal()

getTotal ( )

Method to get the total number of items for the data set.

Renvoie
int The total number of items available in the data set.
Depuis
4.1.0

Références $total.

Documentation des champs

◆ $mediaApiModel

$mediaApiModel
private

◆ $total

$total = 0
private

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