NavigationData
extends ArrayObject
in package
implements
NavigationSchema, SerializableContract
uses
Serializable
FinalYes
Object implementation for the NavigationSchema. It extends the ArrayObject class so that its data can be accessed using dot notation in the page's front matter data.
Table of Contents
Interfaces
- NavigationSchema
- Front matter schema interfaces are used by various Hyde components to specify what data they provide or contain. They also serve as a convenient way to see the supported front matter properties.
- SerializableContract
- Specifies that a class can be serialized to an array and/or JSON.
Properties
Methods
- __construct() : mixed
- arraySerialize() : array<string|int, mixed>
- Recursively serialize Arrayables
- jsonSerialize() : array<string|int, mixed>
- make() : self
- toArray() : array{label: string, priority: int, hidden: bool, group: string|null}
- Get the instance as an array.
- toJson() : string
- automaticallySerialize() : array<string|int, mixed>
- Automatically serialize all public properties.
Properties
$group read-only
public
string|null
$group
$hidden read-only
public
bool
$hidden
$label read-only
public
string
$label
$priority read-only
public
int
$priority
Methods
__construct()
public
__construct(string $label, int $priority, bool $hidden[, string $group = null ]) : mixed
Parameters
- $label : string
- $priority : int
- $hidden : bool
- $group : string = null
arraySerialize()
Recursively serialize Arrayables
public
arraySerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>jsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>make()
public
static make(array{label: string, priority: int, hidden: bool, group: string|null} $data) : self
Parameters
- $data : array{label: string, priority: int, hidden: bool, group: string|null}
Return values
selftoArray()
Get the instance as an array.
public
toArray() : array{label: string, priority: int, hidden: bool, group: string|null}
Return values
array{label: string, priority: int, hidden: bool, group: string|null}toJson()
public
toJson([int $options = 0 ]) : string
Parameters
- $options : int = 0
Return values
stringautomaticallySerialize()
Automatically serialize all public properties.
protected
automaticallySerialize() : array<string|int, mixed>