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

Fonctions membres publiques

 displayList ()
 
 displayItem ($path='')
 
 add ()
 
 edit ()
 
 delete ($id=null)
 
- Fonctions membres publiques hérités de ApiController
 __construct ($config=array(), MVCFactoryInterface $factory=null, ?CMSApplication $app=null, ?Input $input=null)
 
 add ()
 
- Fonctions membres publiques hérités de BaseController
 __construct ($config=array(), MVCFactoryInterface $factory=null, ?CMSApplication $app=null, ?Input $input=null)
 
 addViewPath ($path)
 
 execute ($task)
 
 getModel ($name='', $prefix='', $config=array())
 
 getName ()
 
 getTask ()
 
 getTasks ()
 
 getView ($name='', $type='', $prefix='', $config=array())
 
 redirect ()
 
 registerDefaultTask ($method)
 
 registerTask ($task, $method)
 
 unregisterTask ($task)
 
 setMessage ($text, $type='message')
 
 checkToken ($method='post', $redirect=true)
 
 setRedirect ($url, $msg=null, $type=null)
 
- Fonctions membres publiques hérités de DispatcherAwareInterface
 setDispatcher (DispatcherInterface $dispatcher)
 

Fonctions membres protégées

 allowAdd ($data=array())
 
 allowEdit ($data=array(), $key='id')
 
 allowDelete ()
 
- Fonctions membres protégées hérités de ApiController
 allowEdit ($data=array(), $key='id')
 
 allowAdd ($data=array())
 
 preprocessSaveData (array $data)
 
- Fonctions membres protégées hérités de BaseController
 addPath ($type, $path)
 
 checkEditId ($context, $id)
 
 createModel ($name, $prefix='', $config=array())
 
 createView ($name, $prefix='', $type='', $config=array())
 
 holdEditId ($context, $id)
 
 releaseEditId ($context, $id)
 
 setPath ($type, $path)
 

Attributs protégés

 $contentType = 'media'
 
 $default_view = 'media'
 
- Attributs protégés hérités de ApiController
 $contentType
 
 $option
 
 $text_prefix
 
 $context
 
 $itemsPerPage = 20
 
 $modelState
 
- Attributs protégés hérités de BaseController
 $basePath
 
 $default_view
 
 $doTask
 
 $message
 
 $messageType
 
 $methods
 
 $name
 
 $model_prefix
 
 $paths
 
 $redirect
 
 $task
 
 $taskMap
 
 $input
 
 $factory
 
 $app
 

Fonctions membres privées

 setModelState (array $mappings)
 
 checkContent ()
 

Attributs privés statiques

static $listQueryModelStateMap
 
static $itemQueryModelStateMap
 

Membres hérités additionnels

- Fonctions membres publiques statiques hérités de BaseController
static addModelPath ($path, $prefix='')
 
static createFileName ($type, $parts=array())
 
static getInstance ($prefix, $config=array())
 
- Attributs protégés statiques hérités de BaseController
static $instance
 
static $views
 

Description détaillée

Media web service controller.

Depuis
4.1.0

Documentation des fonctions membres

◆ add()

add ( )

Method to add a new file or folder.

Renvoie
void
Depuis
4.1.0
Exceptions
FileExistsException
InvalidPathException
InvalidParameterException

Références $content, $path, et Text\sprintf().

◆ allowAdd()

allowAdd (   $data = array())
protected

Method to check if it's allowed to add a new file or folder

Paramètres
array$dataAn array of input data.
Renvoie
boolean
Depuis
4.1.0

Références $user.

◆ allowDelete()

allowDelete ( )
protected

Method to check if it's allowed to delete an existing file or folder.

Renvoie
boolean
Depuis
4.1.0

Références $user.

◆ allowEdit()

allowEdit (   $data = array(),
  $key = 'id' 
)
protected

Method to check if it's allowed to modify an existing file or folder.

Paramètres
array$dataAn array of input data.
Renvoie
boolean
Depuis
4.1.0

Références $user.

◆ checkContent()

checkContent ( )
private

Performs various checks to see if it is allowed to save the content.

Renvoie
void
Depuis
4.1.0
Exceptions

Références $helper, $params, Text\_(), et ComponentHelper\getParams().

◆ delete()

delete (   $id = null)

Method to delete an existing file or folder.

Renvoie
void
Depuis
4.1.0
Exceptions
InvalidPathException

Références $model, et Inflector\singularize().

◆ displayItem()

displayItem (   $path = '')

Display one specific file or folder.

Paramètres
string$pathThe path of the file to display. Leave empty if you want to retrieve data from the request.
Renvoie
static A object to support chaining.
Depuis
4.1.0
Exceptions
InvalidPathException

Références $path.

◆ displayList()

displayList ( )

Display a list of files and/or folders.

Renvoie
static A object to support chaining.
Depuis
4.1.0
Exceptions

Références InputFilter\getInstance().

◆ edit()

edit ( )

Method to modify an existing file or folder.

Renvoie
void
Depuis
4.1.0
Exceptions
FileExistsException
InvalidPathException

Références $content, $path, $recordId, et Text\sprintf().

◆ setModelState()

setModelState ( array  $mappings)
private

Set model state using a list of mappings between query parameters and model state names.

Paramètres
array$mappingsA list of mappings between query parameters and model state names.
Renvoie
void
Depuis
4.1.0

Documentation des champs

◆ $contentType

$contentType = 'media'
protected

◆ $default_view

$default_view = 'media'
protected

◆ $itemQueryModelStateMap

$itemQueryModelStateMap
staticprivate
Valeur initiale :
= [
'path' => [
'name' => 'path'

◆ $listQueryModelStateMap

$listQueryModelStateMap
staticprivate
Valeur initiale :
= [
'path' => [
'name' => 'path'

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