Function RevisionEngineFiles->find_revisions
Definitions
sources/revisions_engine_files.php
- Retrieve revisions of something.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $directory | PATH | No | No | required parameter | N/A | N/A | Directory where revisions are stored |
| $filename_id | string | No | No | required parameter | N/A | N/A | ID of what was revised (=base filename, no extension) |
| $ext | string | No | No | required parameter | N/A | N/A | File extension for revisable files |
| $action | ?string | No | No | Null | N/A | N/A | The action the revision is for, a language string (null: no filter) |
| $revision_time | ?TIME | No | No | Null | N/A | N/A | The creation timestamp for a particular revision to retrieve (null: no filter) |
| $max | ?integer | No | No | 100 | N/A | N/A | Maximum to return (null: no limit) |
| $start | integer | No | No | 0 | N/A | N/A | Start offset |
| $limited_data | boolean | No | No | False | N/A | N/A | Whether to only collect IDs and other simple low-bandwidth data |
Returns
- List of revision maps
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Retrieve revisions of something.
*
* @param PATH $directory Directory where revisions are stored
* @param string $filename_id ID of what was revised (=base filename, no extension)
* @param string $ext File extension for revisable files
* @param ?string $action The action the revision is for, a language string (null: no filter)
* @param ?TIME $revision_time The creation timestamp for a particular revision to retrieve (null: no filter)
* @param ?integer $max Maximum to return (null: no limit)
* @param integer $start Start offset
* @param boolean $limited_data Whether to only collect IDs and other simple low-bandwidth data
* @return array List of revision maps
*/
public function find_revisions(string $directory, string $filename_id, string $ext, ?string $action = null, ?int $revision_time = null, ?int $max = 100, int $start = 0, bool $limited_data = false) : array
* Retrieve revisions of something.
*
* @param PATH $directory Directory where revisions are stored
* @param string $filename_id ID of what was revised (=base filename, no extension)
* @param string $ext File extension for revisable files
* @param ?string $action The action the revision is for, a language string (null: no filter)
* @param ?TIME $revision_time The creation timestamp for a particular revision to retrieve (null: no filter)
* @param ?integer $max Maximum to return (null: no limit)
* @param integer $start Start offset
* @param boolean $limited_data Whether to only collect IDs and other simple low-bandwidth data
* @return array List of revision maps
*/
public function find_revisions(string $directory, string $filename_id, string $ext, ?string $action = null, ?int $revision_time = null, ?int $max = 100, int $start = 0, bool $limited_data = false) : array
