 |
Joomla CMS
4.2.2
Documentation des API du CMS Joomla en version 4.2.2
|
|
Joomla CMS
4.2.2
Documentation des API du CMS Joomla en version 4.2.2
|
Graphe d'héritage de ApiController:Fonctions membres publiques | |
| execute ($task) | |
| getFiles () | |
| deleteFiles () | |
| postFiles () | |
| putFiles () | |
| getModel ($name='Api', $prefix='Administrator', $config=[]) | |
| 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 privées | |
| sendResponse ($data=null, int $responseCode=200) | |
| checkContent () | |
| getAdapter () | |
| getPath () | |
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()) |
| 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 hérités de BaseController | |
| $basePath | |
| $default_view | |
| $doTask | |
| $message | |
| $messageType | |
| $methods | |
| $name | |
| $model_prefix | |
| $paths | |
| $redirect | |
| $task | |
| $taskMap | |
| $input | |
| $factory | |
| $app | |
| Attributs protégés statiques hérités de BaseController | |
| static | $instance |
| static | $views |
This is NO public api controller, it is internal for the com_media component only!
|
private |
Performs various checks if it is allowed to save the content.
Références $helper, $params, Text\_(), et ComponentHelper\getParams().
| deleteFiles | ( | ) |
Files delete Method
Examples:
Références Text\_(), Joomla\Component\Media\Administrator\Provider\getAdapter(), et null.
| execute | ( | $task | ) |
Execute a task by triggering a method in the derived class.
| string | $task | The task to perform. If no matching task is found, the '__default' task is executed, if defined. |
Implémente ControllerInterface.
Références $data, $method, $task, Text\_(), Session\checkToken(), method, et Text\sprintf().
| getFiles | ( | ) |
Files Get Method
Examples:
Références $options, et Joomla\Component\Media\Administrator\Provider\getAdapter().
| getModel | ( | $name = 'Api', |
|
$prefix = 'Administrator', |
|||
$config = [] |
|||
| ) |
Method to get a model object, loading it if required.
| string | $name | The model name. Optional. |
| string | $prefix | The class prefix. Optional. |
| array | $config | Configuration array for model. Optional. |
| postFiles | ( | ) |
Files Post Method
Examples:
POST a new file or folder into a specific folder, the file or folder information is returned: index.php?option=com_media&task=api.files&format=json&path=/sampledata/cassiopeia /api/files/sampledata/cassiopeia
New file body: { "name": "test.jpg", "content":"base64 encoded image" } New folder body: { "name": "test", }
Références $content, $name, $options, $path, Text\_(), et Joomla\Component\Media\Administrator\Provider\getAdapter().
| putFiles | ( | ) |
Files Put method
Examples:
PUT a media file, the file or folder information is returned: index.php?option=com_media&task=api.files&format=json&path=/sampledata/cassiopeia/test.jpg /api/files/sampledata/cassiopeia/test.jpg
Update file body: { "content":"base64 encoded image" }
PUT move a file, folder to another one path : will be taken as the source index.php?option=com_media&task=api.files&format=json&path=/sampledata/cassiopeia/test.jpg /api/files/sampledata/cassiopeia/test.jpg
JSON body: { "newPath" : "/path/to/destination", "move" : "1" }
PUT copy a file, folder to another one path : will be taken as the source index.php?option=com_media&task=api.files&format=json&path=/sampledata/cassiopeia/test.jpg /api/files/sampledata/cassiopeia/test.jpg
JSON body: { "newPath" : "/path/to/destination", "move" : "0" }
Références $content, $name, $path, Text\_(), Joomla\Component\Media\Administrator\Provider\getAdapter(), et null.
|
private |
Send the given data as JSON response in the following format:
{"success":true,"message":"ok","messages":null,"data":[{"type":"dir","name":"banners","path":"//"}]}
| mixed | $data | The data to send |
| integer | $responseCode | The response code |
Références $data.
