API Documentation

HydePage
in package

Application

implements PageSchema, SerializableContract uses InteractsWithFrontMatter, Serializable, HasFactory

AbstractYes

The base class for all Hyde pages.

To ensure compatibility with the Hyde Framework, all page models should extend this class. Markdown-based pages can extend the BaseMarkdownPage class to get relevant helpers.

Unlike other frameworks, in general you don't instantiate pages yourself in Hyde, instead, the page models acts as blueprints defining information for Hyde to know how to parse a file, and what data around it should be generated.

To create a parsed file instance, you'd typically just create a source file, and you can then access the parsed file from the HydeKernel's page index. The source files are usually parsed by the SourceFileParser action.

In Blade views, you can always access the current page instance being rendered using the $page variable.

Interfaces

PageSchema: 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

$fileExtension : string
$identifier : string
$matter : FrontMatter
$metadata : PageMetadataBag
$navigation : NavigationData
$outputDirectory : string
$routeKey : string
$sourceDirectory : string
$template : string
$title : string

Methods

__construct() : mixed: Construct a new page instance.
all() : PageCollection<string|int, static>: Get a collection of all pages, parsed into page models.
arraySerialize() : array<string|int, mixed>: Recursively serialize Arrayables
baseRouteKey() : string: Get the route key base for the page model.
compile() : string: Compile the page into static HTML.
data() : FrontMatter|mixed: Get a value from the computed page data, or fallback to the page's front matter, then to the default value.
fileExtension() : string: Get the file extension of the source files for the page type.
files() : array<string|int, string>: Get an array of all the source file identifiers for the model.
get() : static: Get a page instance from the Kernel's page index by its identifier.
getBladeView() : string: Get the Blade template/view key for the page.
getCanonicalUrl() : string|null: Get the canonical URL for the page to use in the `<link rel="canonical">` tag.
getIdentifier() : string: Get the page model's identifier property.
getLink() : string: Format the page instance to a URL path, with support for pretty URLs if enabled.
getOutputPath() : string: Get the path where the compiled page will be saved.
getRoute() : Route: Get the route object for the page.
getRouteKey() : string: Get the route key for the page.
getSourcePath() : string: Get the path to the instance source file, relative to the project root.
has() : bool: See if a value exists in the computed page data or the front matter.
isDiscoverable() : bool: Returns whether the page type is discoverable through auto-discovery.
jsonSerialize() : array<string|int, mixed>
make() : static: Create a new page instance. Static alias for the constructor.
matter() : FrontMatter|mixed: Get the front matter object, or a value from within.
metadata() : PageMetadataBag: Get the generated metadata for the page.
navigationMenuGroup() : string|null: Get the group of the page in the navigation menu, if any.
navigationMenuLabel() : string: Get the label of the page in the navigation menu.
navigationMenuPriority() : int: Get the priority of the page in the navigation menu.
outputDirectory() : string: Get the output subdirectory to store compiled HTML files for the page type.
outputPath() : string: Qualify a page identifier into a target output file path, relative to the _site output directory.
parse() : static: Parse a source file into a new page model instance.
path() : string: Get an absolute file path to the page's source directory, or a file within it.
pathToIdentifier() : string: Format a filename to an identifier for a given model. Unlike the basename function, any nested paths within the source directory are retained in order to satisfy the page identifier definition.
setFileExtension() : void: Set the file extension for the page type.
setOutputDirectory() : void: Set the source directory for the page type.
setSourceDirectory() : void: Set the output directory for the page type.
showInNavigation() : bool: Can the page be shown in the navigation menu?
sourceDirectory() : string: Get the directory where source files are stored for the page type.
sourcePath() : string: Qualify a page identifier into file path to the source file, relative to the project root.
title() : string: Get the page title to display in HTML tags like `<title>` and `<meta>` tags.
toArray() : array<string|int, mixed>: Get the instance as an array.
toCoreDataObject() : CoreDataObject
toJson() : string
assignFactoryData() : void
automaticallySerialize() : array<string|int, mixed>: Automatically serialize all public properties.
constructFactoryData() : void
constructMetadata() : void

$fileExtension


    public
    static    string
    $fileExtension

$identifier read-only


    public
        string
    $identifier

$matter


    public
        FrontMatter
    $matter

$metadata


    public
        PageMetadataBag
    $metadata

$navigation


    public
        NavigationData
    $navigation

$outputDirectory


    public
    static    string
    $outputDirectory

$routeKey read-only


    public
        string
    $routeKey

$sourceDirectory


    public
    static    string
    $sourceDirectory

$template


    public
    static    string
    $template

$title read-only


    public
        string
    $title

__construct()

Construct a new page instance.


    public
                    __construct([string $identifier = '' ][, FrontMatter|array<string|int, mixed> $matter = [] ]) : mixed

Parameters

$identifier : string = ''
$matter : FrontMatter|array<string|int, mixed> = []

all()

Get a collection of all pages, parsed into page models.


    public
            static        all() : PageCollection<string|int, static>

Return values

PageCollection<string|int, static>

arraySerialize()

Recursively serialize Arrayables


    public
                    arraySerialize() : array<string|int, mixed>

Return values

array<string|int, mixed>

baseRouteKey()

Get the route key base for the page model.


    public
            static        baseRouteKey() : string

This is the same value as the output directory.

Return values

string

compile()

Compile the page into static HTML.


    public
    abstract                compile() : string

Return values

string —

The compiled HTML for the page.

data()

Get a value from the computed page data, or fallback to the page's front matter, then to the default value.


    public
                    data([string $key = null ][, mixed $default = null ]) : FrontMatter|mixed

Parameters

$key : string = null
$default : mixed = null

Return values

FrontMatter|mixed

fileExtension()

Get the file extension of the source files for the page type.


    public
            static        fileExtension() : string

Return values

string

files()

Get an array of all the source file identifiers for the model.


    public
            static        files() : array<string|int, string>

Note that the values do not include the source directory or file extension.

Return values

array<string|int, string>

get()

Get a page instance from the Kernel's page index by its identifier.


    public
            static        get(string $identifier) : static

Parameters

$identifier : string

Return values

static

getBladeView()

Get the Blade template/view key for the page.


    public
                    getBladeView() : string

Return values

string

getCanonicalUrl()

Get the canonical URL for the page to use in the `<link rel="canonical">` tag.


    public
                    getCanonicalUrl() : string|null

It can be explicitly set in the front matter using the canonicalUrl key, otherwise it will be generated based on the site URL and the output path, unless there is no configured base URL, leading to this returning null.

Return values

string|null

getIdentifier()

Get the page model's identifier property.


    public
                    getIdentifier() : string

The identifier is the part between the source directory and the file extension. It may also be known as a 'slug', or previously 'basename', but it retains the nested path structure if the page is stored in a subdirectory.

For example, the identifier of a source file stored as '_pages/about/contact.md' would be 'about/contact', and 'pages/about.md' would simply be 'about'.

Return values

string

getLink()

Format the page instance to a URL path, with support for pretty URLs if enabled.


    public
                    getLink() : string

Note that the link is always relative to site root, and does not contain ../ segments.

Return values

string

getOutputPath()

Get the path where the compiled page will be saved.


    public
                    getOutputPath() : string

Return values

string —

Path relative to the site output directory.

getRoute()

Get the route object for the page.


    public
                    getRoute() : Route

Return values

Route

getRouteKey()

Get the route key for the page.


    public
                    getRouteKey() : string

The route key is the page URL path, relative to the site root, but without any file extensions. For example, if the page will be saved to _site/docs/index.html, the key is docs/index.

Route keys are used to identify page routes, similar to how named routes work in Laravel, only that here the name is not just arbitrary, but also defines the output location, as the route key is used to determine the output path which is $routeKey.html.

Return values

string

getSourcePath()

Get the path to the instance source file, relative to the project root.


    public
                    getSourcePath() : string

Return values

string

has()

See if a value exists in the computed page data or the front matter.


    public
                    has(string $key) : bool

Parameters

$key : string

Return values

bool

isDiscoverable()

Returns whether the page type is discoverable through auto-discovery.


    public
            static        isDiscoverable() : bool

Return values

bool

jsonSerialize()


    public
                    jsonSerialize() : array<string|int, mixed>

Return values

array<string|int, mixed>

make()

Create a new page instance. Static alias for the constructor.


    public
            static        make([string $identifier = '' ][, FrontMatter|array<string|int, mixed> $matter = [] ]) : static

Parameters

$identifier : string = ''
$matter : FrontMatter|array<string|int, mixed> = []

Return values

static

matter()

Get the front matter object, or a value from within.


    public
                    matter([string $key = null ][, mixed $default = null ]) : FrontMatter|mixed

Parameters

$key : string = null
$default : mixed = null

Return values

FrontMatter|mixed

metadata()

Get the generated metadata for the page.


    public
                    metadata() : PageMetadataBag

Return values

PageMetadataBag

navigationMenuGroup()

Get the group of the page in the navigation menu, if any.


    public
                    navigationMenuGroup() : string|null

Return values

string|null

navigationMenuLabel()

Get the label of the page in the navigation menu.


    public
                    navigationMenuLabel() : string

Return values

string

navigationMenuPriority()

Get the priority of the page in the navigation menu.


    public
                    navigationMenuPriority() : int

Return values

int

outputDirectory()

Get the output subdirectory to store compiled HTML files for the page type.


    public
            static        outputDirectory() : string

Return values

string

outputPath()

Qualify a page identifier into a target output file path, relative to the _site output directory.


    public
            static        outputPath(string $identifier) : string

Parameters

$identifier : string

Return values

string

parse()

Parse a source file into a new page model instance.


    public
            static        parse(string $identifier) : static

Parameters

$identifier : string: The identifier of the page to parse.

Return values

static —

New page model instance for the parsed source file.

path()

Get an absolute file path to the page's source directory, or a file within it.


    public
            static        path([string $path = '' ]) : string

Parameters

$path : string = ''

Return values

string

pathToIdentifier()

Format a filename to an identifier for a given model. Unlike the basename function, any nested paths within the source directory are retained in order to satisfy the page identifier definition.


    public
            static        pathToIdentifier(string $path) : string

Parameters

$path : string: Example: index.blade.php

Return values

string —

Example: index

setFileExtension()

Set the file extension for the page type.


    public
            static        setFileExtension(string $fileExtension) : void

Parameters

$fileExtension : string

setOutputDirectory()

Set the source directory for the page type.


    public
            static        setOutputDirectory(string $outputDirectory) : void

Parameters

$outputDirectory : string

setSourceDirectory()

Set the output directory for the page type.


    public
            static        setSourceDirectory(string $sourceDirectory) : void

Parameters

$sourceDirectory : string

showInNavigation()

Can the page be shown in the navigation menu?


    public
                    showInNavigation() : bool

Return values

bool

sourceDirectory()

Get the directory where source files are stored for the page type.


    public
            static        sourceDirectory() : string

Return values

string

sourcePath()

Qualify a page identifier into file path to the source file, relative to the project root.


    public
            static        sourcePath(string $identifier) : string

Parameters

$identifier : string

Return values

string

title()

Get the page title to display in HTML tags like `<title>` and `<meta>` tags.


    public
                    title() : string

Return values

string

toArray()

Get the instance as an array.


    public
                    toArray() : array<string|int, mixed>

Return values

array<string|int, mixed>

toCoreDataObject()


    public
                    toCoreDataObject() : CoreDataObject

Return values

CoreDataObject

toJson()


    public
                    toJson([int $options = 0 ]) : string

Parameters

$options : int = 0

Return values

string

assignFactoryData()


    protected
                    assignFactoryData(PageDataFactory $factory) : void

Parameters

$factory : PageDataFactory

automaticallySerialize()

Automatically serialize all public properties.


    protected
                    automaticallySerialize() : array<string|int, mixed>

Return values

array<string|int, mixed>

constructFactoryData()


    protected
                    constructFactoryData() : void

constructMetadata()


    protected
                    constructMetadata() : void

HydePage in package Application implements PageSchema, SerializableContract uses InteractsWithFrontMatter, Serializable, HasFactory

Tags

Table of Contents

Interfaces

Properties

Methods

Properties

$fileExtension

$identifier read-only

$matter

$metadata

$navigation

$outputDirectory

$routeKey read-only

$sourceDirectory

$template

$title read-only

Methods

__construct()

Parameters

all()

Return values

arraySerialize()

Return values

baseRouteKey()

Return values

compile()

Return values

data()

Parameters

Return values

fileExtension()

Return values

files()

Return values

get()

Parameters

Tags

Return values

getBladeView()

Return values

getCanonicalUrl()

Return values

getIdentifier()

Return values

getLink()

Return values

getOutputPath()

Return values

getRoute()

Return values

getRouteKey()

Return values

getSourcePath()

Return values

has()

Parameters

Return values

isDiscoverable()

Return values

jsonSerialize()

Tags

Return values

make()

Parameters

Return values

matter()

Parameters

Return values

metadata()

Return values

navigationMenuGroup()

Return values

navigationMenuLabel()

Return values

navigationMenuPriority()

Return values

outputDirectory()

Return values

outputPath()

HydePage
in package

Application

implements PageSchema, SerializableContract uses InteractsWithFrontMatter, Serializable, HasFactory