API Documentation

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

Properties

$group  : string|null
$hidden  : bool
$label  : string
$priority  : int

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}
toJson()  : string

Properties

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
inheritDoc
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
self

toArray()

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
string

        
On this page

Search results