Олег Давидович: 1 версия импортирована

2024-10-21T08:53:26Z

1 версия импортирована

← Предыдущая версия	Версия от 08:53, 21 октября 2024
(нет различий)

1>Dongsheng в 07:50, 9 июля 2010

2010-07-09T07:50:40Z

Новая страница

These APIs will be used to browse Moodle files by Moodle Web Services.

===class moodle_file_external()===

This class implements the interface to moodle files, for browsing, downloading and uploading files. It is defined in files/externals.php.

We cannot return the whole files tree by web service API, because to make sure the web services working in every language and platform, we need to define a fixed data structure of return value, but the files tree can change all the time. See more information about web services at: [[Development:External_services_description]].

The class contains following methods:

====get_files====
This function is used to browse files.

It takes 5 parameters, all of them are optional, if you provide no parameters, it will return the top level content of moodle repository.

* contextid
* component
* filearea
* itemid
* filename
* filepath

It will return an array, can be described as PHP array:
<pre>
$files = array(
'path' => array(array('name'=>'root', 'path=>'/'), array('name'=>'subdir', 'path=>'/sub/')),
'files' => array(
array('filename'=>'readme', 'filepath'=>'/', 'filearea'=>'forum', 'itemid'=>110, 'contextid'=>1, 'isdir'=>true),
array('filename'=>'changes', 'filepath'=>'/', 'filearea'=>'forum', 'itemid'=>112, 'contextid'=>1, 'isdir'=>false),
)
);
</pre>

The service name is "moodle_file_get_files", defined in lib/db/services.php.

====upload====
This function is used to upload a file to user private area.

It takes 7 parameters, all of them are mandatory:

* contextid
* component
* filearea
* itemid
* filepath
* filename
* filecontent

It will return a boolean value, true/false.

The service name is "moodle_file_upload", defined in lib/db/services.php

Sample code (using Zend Framework):
<code php>
$url = MOODLE_WSROOT. '?wstoken=xxxxxxxxxxxxxxxxxxxxxx';
$zend = new Zend_XmlRpc_Client($url);
$srv = $zend->getProxy();
$files = $srv->moodle_file_get_files($contextid, $component, $filearea, $itemid, $filepath, $filename);
$file = $srv->moodle_file_upload($contextid, 'user', 'private', 0, '/', 'info.txt', base64_encode('this is file content'));
</code>

Development:Web services:Files - История изменений

Олег Давидович: 1 версия импортирована

1>Dongsheng в 07:50, 9 июля 2010