#### `make()` Create a new page instance. Static alias for the constructor. ```php HydePage::make(string $identifier, Hyde\Markdown\Models\FrontMatter|array $matter): static ``` #### `isDiscoverable()` Returns whether the page type is discoverable through auto-discovery. ```php HydePage::isDiscoverable(): bool ``` #### `get()` Get a page instance from the Kernel's page index by its identifier. ```php HydePage::get(string $identifier): static ``` - **Throws:** \Hyde\Framework\Exceptions\FileNotFoundException If the page does not exist. #### `parse()` Parse a source file into a new page model instance. ```php /** @param string $identifier The identifier of the page to parse. */ HydePage::parse(string $identifier): static // New page model instance for the parsed source file. ``` - **Throws:** \Hyde\Framework\Exceptions\FileNotFoundException If the file does not exist. #### `files()` Get an array of all the source file identifiers for the model. Note that the values do not include the source directory or file extension. ```php HydePage::files(): array ``` #### `all()` Get a collection of all pages, parsed into page models. ```php HydePage::all(): \Hyde\Foundation\Kernel\PageCollection ``` #### `sourceDirectory()` Get the directory where source files are stored for the page type. ```php HydePage::sourceDirectory(): string ``` #### `outputDirectory()` Get the output subdirectory where compiled files are stored for the page type. ```php HydePage::outputDirectory(): string ``` #### `sourceExtension()` Get the file extension of the source files for the page type, such as `.md` or `.blade.php`. ```php HydePage::sourceExtension(): string ``` #### `outputExtension()` Get the output file extension for the page type, such as `.html` or `.txt`. Output extensions should include the leading dot, for example `.html` or `.txt`. ```php HydePage::outputExtension(): string ``` #### `setSourceDirectory()` Set the source directory for the page type. ```php HydePage::setSourceDirectory(string $sourceDirectory): void ``` #### `setOutputDirectory()` Set the output directory for the page type. ```php HydePage::setOutputDirectory(string $outputDirectory): void ``` #### `setSourceExtension()` Set the source file extension for the page type. ```php HydePage::setSourceExtension(string $sourceExtension): void ``` #### `sourcePath()` Qualify a page identifier into file path to the source file, relative to the project root. ```php HydePage::sourcePath(string $identifier): string ``` #### `outputPath()` Qualify a page identifier into a target output file path, relative to the _site output directory. ```php HydePage::outputPath(string $identifier): string ``` #### `path()` Get an absolute file path to the page's source directory, or a file within it. ```php HydePage::path(string $path): 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. ```php /** @param string $path Example: index.blade.php */ HydePage::pathToIdentifier(string $path): string // Example: index ``` #### `baseRouteKey()` Get the route key base for the page model. This is the same value as the output directory. ```php HydePage::baseRouteKey(): string ``` #### `__construct()` Construct a new page instance. ```php $page = new HydePage(string $identifier, Hyde\Markdown\Models\FrontMatter|array $matter): void ``` #### `compile()` Compile the page into static HTML. ```php $page->compile(): string // The compiled HTML for the page. ``` #### `toArray()` Get the instance as an array. ```php $page->toArray(): array ``` #### `getSourcePath()` Get the path to the instance source file, relative to the project root. ```php $page->getSourcePath(): string ``` #### `getOutputPath()` Get the path where the compiled page will be saved. ```php $page->getOutputPath(): string // Path relative to the site output directory. ``` #### `getRouteKey()` Get the route key for the page. Route keys identify page routes and define their output locations. The `.html` extension is implicit, so `_site/docs/index.html` uses `docs/index`. Non-HTML extensions remain part of the key, so `_site/docs/search.json` uses `docs/search.json`. ```php $page->getRouteKey(): string ``` #### `getRoute()` Get the route object for the page. ```php $page->getRoute(): Hyde\Support\Models\Route ``` #### `getLink()` Format the page instance to a URL path, with support for pretty URLs if enabled. Note that the link is always relative to site root, and does not contain `../` segments. ```php $page->getLink(): string ``` #### `getIdentifier()` Get the page model's identifier property. 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'. ```php $page->getIdentifier(): string ``` #### `getBladeView()` Get the Blade template/view key for the page. ```php $page->getBladeView(): string ``` #### `title()` Get the page title to display in HTML tags like `