StaticPageBuilder
in package
uses
InteractsWithDirectories
Converts a Hyde page object into a static HTML page.
Table of Contents
Methods
- handle() : string
- Invoke the static page builder for the given page.
- needsDirectories() : void
- Ensure the supplied directories exist by creating them if they don't.
- needsDirectory() : void
- Ensure the supplied directory exist by creating it if it does not.
- needsParentDirectory() : void
- Ensure the supplied file's parent directory exists by creating it if it does not.
Methods
handle()
Invoke the static page builder for the given page.
public
static handle(HydePage $page) : string
Parameters
- $page : HydePage
Return values
stringneedsDirectories()
Ensure the supplied directories exist by creating them if they don't.
protected
static needsDirectories(array<string|int, string> $directories) : void
Parameters
- $directories : array<string|int, string>
-
array with relative file paths to the directories
needsDirectory()
Ensure the supplied directory exist by creating it if it does not.
protected
static needsDirectory(string $directory) : void
Parameters
- $directory : string
-
relative file path to the directory
needsParentDirectory()
Ensure the supplied file's parent directory exists by creating it if it does not.
protected
static needsParentDirectory(string $file[, int $levels = 1 ]) : void
Parameters
- $file : string
- $levels : int = 1