Function RevisionEngineDatabase->find_revisions

Definitions

sources/revisions_engine_database.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
$resource_types ?array No No Null N/A N/A Allowed resource types (null: no filter)
$resource_id ?string No No Null N/A N/A Resource ID (null: no filter)
$category_id ?string No No Null N/A N/A Category ID (null: no filter)
$member_id ?MEMBER No No Null N/A N/A Member ID (null: no filter)
$revision_id ?AUTO_LINK No No Null N/A N/A The ID 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  ?array $resource_types Allowed resource types (null: no filter)
 * @param  ?string $resource_id Resource ID (null: no filter)
 * @param  ?string $category_id Category ID (null: no filter)
 * @param  ?MEMBER $member_id Member ID (null: no filter)
 * @param  ?AUTO_LINK $revision_id The ID 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(?array $resource_types = null, ?string $resource_id = null, ?string $category_id = null, ?int $member_id = null, ?int $revision_id = null, ?int $max = 100, int $start = 0, bool $limited_data = false) : array