API / Minn\Rest / FontArgs

FontArgs final class

Minn\Rest\FontArgs · public/minn/src/Minn/Rest/FontArgs.php · 70 lines

The font library's parameters as the reference's REST index lists them (font families, font faces, font collections), in its order, each read by Rest\FontsController or Rest\FontCollectionsController. A family's list and a face's list take the posts list's ids, offset, order and exact-search switch, ordered by id or by include alone, and only a family's list takes slugs. Neither takes a search, a status or an author: the reference ignores them. The ids a path names are listed as the reference lists them (a face's family and id required, which the path always carries). A write's settings and theme.json version are judged by Rest\FontSettings, in the reference's order, before the caller is.

Uses 1
Http\Args
Used by 3
FontCollectionsControllerFontWritesControllerFontsController

Constants and properties

privateCONTEXT = array ( 'description' => 'Scope under which the request is made; determines fields present in response.', 'type' => 'string', 'enum' => array ( 0 => 'view', 1 => 'embed', 2 => 'edit', ), 'default' => 'view', 'required' => false, )
privatePAGE = array ( 'description' => 'Current page of the collection.', 'type' => 'integer', 'default' => 1, 'minimum' => 1, 'required' => false, )
privatePER_PAGE = array ( 'description' => 'Maximum number of items to be returned in result set.', 'type' => 'integer', 'default' => 10, 'minimum' => 1, 'maximum' => 100, 'required' => false, )
privateFAMILY_ID = array ( 'description' => 'The ID for the parent font family of the font face.', 'type' => 'integer', 'required' => true, )
privateVERSION = array ( 'description' => 'Version of the theme.json schema used for the typography settings.', 'type' => 'integer', 'default' => 3, 'minimum' => 2, 'maximum' => 3, 'required' => false, 'handler_validates' => true, )
privatePOST_LIST = array ( '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, ), 'search_semantics' => array ( 'description' => 'How to interpret the search input.', 'type' => 'string', 'enum' => array ( 0 => 'exact', ), '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 post attribute.', 'type' => 'string', 'default' => 'id', 'enum' => array ( 0 => 'id', 1 => 'include', ), 'required' => false, ), )

A list of font families or font faces past the shared three, in the reference's order.

constFAMILIES = array ( 'context' => array ( 'description' => 'Scope under which the request is made; determines fields present in response.', 'type' => 'string', 'enum' => array ( 0 => 'view', 1 => 'embed', 2 => 'edit', ), 'default' => 'view', 'required' => false, ), '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', 'default' => 10, 'minimum' => 1, 'maximum' => 100, '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, ), 'search_semantics' => array ( 'description' => 'How to interpret the search input.', 'type' => 'string', 'enum' => array ( 0 => 'exact', ), '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 post attribute.', 'type' => 'string', 'default' => 'id', 'enum' => array ( 0 => 'id', 1 => 'include', ), 'required' => false, ), 'slug' => array ( 'description' => 'Limit result set to posts with one or more specific slugs.', 'type' => 'array', 'items' => array ( 'type' => 'string', ), 'required' => false, ), )

The font families list.

constFAMILY = array ( 'id' => array ( 'description' => 'Unique identifier for the post.', 'type' => 'integer', 'required' => false, ), 'context' => array ( 'description' => 'Scope under which the request is made; determines fields present in response.', 'type' => 'string', 'enum' => array ( 0 => 'view', 1 => 'embed', 2 => 'edit', ), 'default' => 'view', 'required' => false, ), )

One font family.

constFACES = array ( 'font_family_id' => array ( 'description' => 'The ID for the parent font family of the font face.', 'type' => 'integer', 'required' => true, ), 'context' => array ( 'description' => 'Scope under which the request is made; determines fields present in response.', 'type' => 'string', 'enum' => array ( 0 => 'view', 1 => 'embed', 2 => 'edit', ), 'default' => 'view', 'required' => false, ), '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', 'default' => 10, 'minimum' => 1, 'maximum' => 100, '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, ), 'search_semantics' => array ( 'description' => 'How to interpret the search input.', 'type' => 'string', 'enum' => array ( 0 => 'exact', ), '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 post attribute.', 'type' => 'string', 'default' => 'id', 'enum' => array ( 0 => 'id', 1 => 'include', ), 'required' => false, ), )

A font family's faces.

constFACE = array ( 'font_family_id' => array ( 'description' => 'The ID for the parent font family of the font face.', 'type' => 'integer', 'required' => true, ), 'id' => array ( 'description' => 'Unique identifier for the font face.', 'type' => 'integer', 'required' => true, ), 'context' => array ( 'description' => 'Scope under which the request is made; determines fields present in response.', 'type' => 'string', 'enum' => array ( 0 => 'view', 1 => 'embed', 2 => 'edit', ), 'default' => 'view', 'required' => false, ), )

One font face of a family.

constFAMILY_CREATE = array ( 'theme_json_version' => array ( 'description' => 'Version of the theme.json schema used for the typography settings.', 'type' => 'integer', 'default' => 3, 'minimum' => 2, 'maximum' => 3, 'required' => false, 'handler_validates' => true, ), 'font_family_settings' => array ( 'description' => 'font-family declaration in theme.json format, encoded as a string.', 'type' => 'string', 'required' => true, 'handler_validates' => true, ), )

A font family created.

constFAMILY_UPDATE = array ( 'id' => array ( 'description' => 'Unique identifier for the post.', 'type' => 'integer', 'required' => false, ), 'theme_json_version' => array ( 'description' => 'Version of the theme.json schema used for the typography settings.', 'type' => 'integer', 'default' => 3, 'minimum' => 2, 'maximum' => 3, 'required' => false, 'handler_validates' => true, ), 'font_family_settings' => array ( 'description' => 'font-family declaration in theme.json format, encoded as a string.', 'type' => 'string', 'required' => true, 'handler_validates' => true, ), )

A font family updated.

constFACE_CREATE = array ( 'font_family_id' => array ( 'description' => 'The ID for the parent font family of the font face.', 'type' => 'integer', 'required' => true, ), 'theme_json_version' => array ( 'description' => 'Version of the theme.json schema used for the typography settings.', 'type' => 'integer', 'default' => 3, 'minimum' => 2, 'maximum' => 3, 'required' => false, 'handler_validates' => true, ), 'font_face_settings' => array ( 'description' => 'font-face declaration in theme.json format, encoded as a string.', 'type' => 'string', 'required' => true, 'handler_validates' => true, ), )

A font face created under its family.

privateFORCE = array ( 'type' => 'boolean', 'default' => false, 'description' => 'Whether to bypass Trash and force deletion.', 'required' => false, )

Whether a delete bypasses the trash, as a font route lists it.

constFAMILY_DELETE = array ( 'id' => array ( 'description' => 'Unique identifier for the post.', 'type' => 'integer', 'required' => false, ), 'force' => array ( 'type' => 'boolean', 'default' => false, 'description' => 'Whether to bypass Trash and force deletion.', 'required' => false, ), )

A font family deleted.

constFACE_DELETE = array ( 'font_family_id' => array ( 'description' => 'The ID for the parent font family of the font face.', 'type' => 'integer', 'required' => true, ), 'id' => array ( 'description' => 'Unique identifier for the font face.', 'type' => 'integer', 'required' => true, ), 'force' => array ( 'type' => 'boolean', 'default' => false, 'description' => 'Whether to bypass Trash and force deletion.', 'required' => false, ), )

A font face deleted.

constCOLLECTIONS = array ( 'context' => array ( 'description' => 'Scope under which the request is made; determines fields present in response.', 'type' => 'string', 'enum' => array ( 0 => 'view', 1 => 'embed', 2 => 'edit', ), 'default' => 'view', 'required' => false, ), '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', 'default' => 10, 'minimum' => 1, 'maximum' => 100, 'required' => false, ), )

The font collections list.

constCOLLECTION = array ( 'context' => array ( 'description' => 'Scope under which the request is made; determines fields present in response.', 'type' => 'string', 'enum' => array ( 0 => 'view', 1 => 'embed', 2 => 'edit', ), 'default' => 'view', 'required' => false, ), )

One font collection.