Class defining an AJAX API for supplying file information. More...
Public Member Functions | |
| downloadAllFiles ($args, &$request) | |
| downloadFile ($args, &$request) | |
| downloadLibraryFile ($args, &$request) | |
| enableLinkAction ($args, &$request) | |
| FileApiHandler () | |
| recordDownload ($args, &$request) | |
| viewFile ($args, &$request) | |
Detailed Description
Class defining an AJAX API for supplying file information.
Definition at line 22 of file FileApiHandler.inc.php.
Member Function Documentation
| FileApiHandler.downloadAllFiles | ( | $ | args, | |
| &$ | request | |||
| ) |
Download all passed files.
- Parameters:
-
$args array $request Request
Definition at line 142 of file FileApiHandler.inc.php.
| FileApiHandler.downloadFile | ( | $ | args, | |
| &$ | request | |||
| ) |
Download a file.
- Parameters:
-
$args array $request Request
Definition at line 73 of file FileApiHandler.inc.php.
| FileApiHandler.downloadLibraryFile | ( | $ | args, | |
| &$ | request | |||
| ) |
Download a library file.
- Parameters:
-
$args array $request Request
Definition at line 87 of file FileApiHandler.inc.php.
| FileApiHandler.enableLinkAction | ( | $ | args, | |
| &$ | request | |||
| ) |
Returns a data changd event to re-enable the link action. Refactored out of recordDownload since library files do not have downloads recorded and are in a different context.
- Parameters:
-
$args aray $request Request
- Returns:
- string
Definition at line 208 of file FileApiHandler.inc.php.
Referenced by recordDownload().
| FileApiHandler.FileApiHandler | ( | ) |
Constructor.
Definition at line 27 of file FileApiHandler.inc.php.
| FileApiHandler.recordDownload | ( | $ | args, | |
| &$ | request | |||
| ) |
Record file download and return js event to update grid rows.
- Parameters:
-
$args array $request Request
- Returns:
- string
Definition at line 182 of file FileApiHandler.inc.php.
References enableLinkAction(), and MonographFileManager.recordView().
| FileApiHandler.viewFile | ( | $ | args, | |
| &$ | request | |||
| ) |
View a file.
- Parameters:
-
$args array $request Request
Definition at line 128 of file FileApiHandler.inc.php.
The documentation for this class was generated from the following file:
- controllers/api/file/FileApiHandler.inc.php
Generated on Mon Sep 17 2012 13:58:57 for Open Monograph Press by
1.7.1