Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
- Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
- PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
/lib/ -> boxlib.php (source)
Box.net client.
| Author: | James Levy <james@box.net> |
| Copyright: | copyright Box.net 2007 |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| Version: | 1.0 |
| File Size: | 268 lines (8 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 2 classes
boxnet_client:: (14 methods):
auth_url()
create_folder()
download_file()
get_file_info()
get_folder_items()
log_out()
make_url()
rename_file()
reset_state()
revoke_url()
share_file()
search()
token_url()
upload_file()
boxclient:: (1 method):
__construct()
Class: boxnet_client - X-Ref
Box.net client class.| auth_url() X-Ref |
| Return authorize URL. return: string |
| create_folder($foldername, $parentid = 0) X-Ref |
| Create a folder. param: string $foldername The folder name. param: int $parentid The ID of the parent folder. return: array Information about the new folder. |
| download_file($fileid, $path) X-Ref |
| Download the file. param: int $fileid File ID. param: string $path Path to download the file to. return: bool Success or not. |
| get_file_info($fileid) X-Ref |
| Get info of a file. param: int $fileid File ID. return: object |
| get_folder_items($folderid = 0) X-Ref |
| Get a folder content. param: int $folderid Folder ID. return: object |
| log_out() X-Ref |
| Log out. return: void |
| make_url($uri, $params = array() X-Ref |
| Build a request URL. param: string $uri The URI to request. param: array $params Query string parameters. param: bool $uploadapi Whether this works with the upload API or not. return: string |
| rename_file($fileid, $newname) X-Ref |
| Rename a file. param: int $fileid The file ID. param: string $newname The new file name. return: object Box.net file object. |
| reset_state() X-Ref |
| Resets curl for multiple requests. return: void |
| revoke_url() X-Ref |
| Return the revoke URL. return: string |
| share_file($fileid, $businesscheck = true) X-Ref |
| Share a file and return the link to it. param: string $fileid The file ID. param: bool $businesscheck Whether or not to check if the user can share files, has a business account. return: object |
| search($query) X-Ref |
| Search. return: object |
| token_url() X-Ref |
| Return token URL. return: string |
| upload_file(stored_file $storedfile, $parentid = 0) X-Ref |
| Upload a file. Please note that the file is named on Box.net using the path we are providing, and so the file has the name of the stored_file hash. param: stored_file $storedfile A stored_file. param: integer $parentid The ID of the parent folder. return: object Box.net file object. |
