API / Minn\Http / RevisionArgs

RevisionArgs final class

Minn\Http\RevisionArgs · public/minn/src/Minn/Http/RevisionArgs.php · 66 lines

The parameters the revisions and autosaves routes accept, as the reference's REST index describes them (captured from it, in its order). The path's own captures are declared too, as the reference declares them, so a query value of the same name stands in for the capture (the router's override) and is judged first. Each set names the code that reads it.

Uses 1

Http

Used by 3

Rest\GlobalStylesController Rest\RevisionsController Rest\TemplateRevisionsController

Constants and properties

const	`PARENT` = `array ( 'parent' => array ( 'description' => 'The ID for the parent of the revision.', 'type' => 'integer', 'required' => false, ), )`	Read by the router's override: a revision's parent post, by id.
const	`ID` = `array ( 'id' => array ( 'description' => 'Unique identifier for the revision.', 'type' => 'integer', 'required' => false, ), )`	Read by the router's override: the revision itself, by id.
const	`AUTOSAVE_PARENT` = `array ( 'parent' => array ( 'description' => 'The ID for the parent of the autosave.', 'type' => 'integer', 'required' => false, ), )`	Read by the router's override on an autosave's own route; on the autosaves list it is judged and nothing more, as on the reference.
const	`AUTOSAVE_ID` = `array ( 'id' => array ( 'description' => 'The ID for the autosave.', 'type' => 'integer', 'required' => false, ), )`	Read by the router's override: the autosave asked for, by id.
const	`STYLES_PARENT` = `array ( 'parent' => array ( 'description' => 'The ID for the parent of the global styles revision.', 'type' => 'integer', 'required' => false, ), )`	Read by the router's override: a global styles post that owns the revisions.
const	`STYLES_ID` = `array ( 'id' => array ( 'description' => 'Unique identifier for the global styles revision.', 'type' => 'integer', 'required' => false, ), )`	Read by the router's override: one global styles revision.
const	`TEMPLATE_PARENT` = `array ( 'parent' => array ( 'description' => 'The id of a template', 'type' => 'string', 'required' => false, ), )`	Read by the router's override: a template (or part) that owns the revisions, by its theme//slug id.
const	`TEMPLATE_ID` = `array ( 'id' => array ( 'description' => 'The id of a template', 'type' => 'string', 'required' => false, ), )`	Read by the router's override: a template (or part) whose autosaves are listed or written.
const	`COLLECTION` = array ( 'page' => array ( 'description' => 'Current page of the collection.', 'type' => 'integer', 'default' => 1, 'minimum' => 1, 'required' => false, ), 'per_page' => array ( 'description' => 'Maximum number of items to be returned in result set.', 'type' => 'integer', 'minimum' => 1, 'maximum' => 100, 'required' => false, ), 'search' => array ( 'description' => 'Limit results to those matching a string.', 'type' => 'string', 'required' => false, ), 'exclude' => array ( 'description' => 'Ensure result set excludes specific IDs.', 'type' => 'array', 'items' => array ( 'type' => 'integer', ), 'default' => array ( ), 'required' => false, ), 'include' => array ( 'description' => 'Limit result set to specific IDs.', 'type' => 'array', 'items' => array ( 'type' => 'integer', ), 'default' => array ( ), 'required' => false, ), 'offset' => array ( 'description' => 'Offset the result set by a specific number of items.', 'type' => 'integer', 'required' => false, ), 'order' => array ( 'description' => 'Order sort attribute ascending or descending.', 'type' => 'string', 'default' => 'desc', 'enum' => array ( 0 => 'asc', 1 => 'desc', ), 'required' => false, ), 'orderby' => array ( 'description' => 'Sort collection by object attribute.', 'type' => 'string', 'default' => 'date', 'enum' => array ( 0 => 'date', 1 => 'id', 2 => 'include', 3 => 'relevance', 4 => 'slug', 5 => 'include_slugs', 6 => 'title', ), 'required' => false, ), )	Read by Rest\RevisionCollection: a revisions list's paging, search, filters and order.
const	`STYLES_COLLECTION` = array ( 'page' => array ( 'description' => 'Current page of the collection.', 'type' => 'integer', 'default' => 1, 'minimum' => 1, 'required' => false, ), 'per_page' => array ( 'description' => 'Maximum number of items to be returned in result set.', 'type' => 'integer', 'minimum' => 1, 'maximum' => 100, 'required' => false, ), 'offset' => array ( 'description' => 'Offset the result set by a specific number of items.', 'type' => 'integer', 'required' => false, ), )	Read by Rest\RevisionCollection::paged(): the global styles revisions list pages and offsets, and filters nothing.
const	`FORCE` = `array ( 'force' => array ( 'type' => 'boolean', 'default' => false, 'description' => 'Required to be true, as revisions do not support trashing.', 'required' => false, ), )`	Read by the revision deletes: a revision is never trashed, so force must be true.