API Documentation

HydeKernel
in package
implements SerializableContract uses HandlesFoundationCollections, ImplementsStringHelpers, ForwardsHyperlinks, ForwardsFilesystem, ManagesHydeKernel, ManagesExtensions, ManagesViewData, BootsHydeKernel, Serializable, Macroable

Encapsulates a HydePHP project, providing helpful methods for interacting with it.

Tags
see
Hyde

for the facade commonly used to access this class.

author

Caen De Silva caen@desilva.se

copyright

2022 Caen De Silva

license

MIT License

link
https://hydephp.com/
extra

Usage information:

The HydeKernel It is stored as a singleton in this class, and is bound into the Laravel Application Service Container, and can be accessed in a few ways.

Commonly, you'll use the Hyde facade to access it, but you can also use Dependency Injection by type-hinting the HydeKernel::class, or use the hyde() function to get the Kernel. The Kernel instance is constructed and bound in the app/bootstrap.php script.

Table of Contents

Interfaces

SerializableContract
Specifies that a class can be serialized to an array and/or JSON.

Constants

VERSION  = '1.7.3'

Properties

$basePath  : string
$booted  : bool
$extensions  : array<HydeExtension>, HydeExtension>
$files  : FileCollection
$filesystem  : Filesystem
$hyperlinks  : Hyperlinks
$instance  : self
$mediaDirectory  : string
$outputDirectory  : string
$pages  : PageCollection
$routes  : RouteCollection
$sourceRoot  : string

Methods

__construct()  : mixed
arraySerialize()  : array<string|int, mixed>
Recursively serialize Arrayables
features()  : Features
hasFeature()  : bool
jsonSerialize()  : array<string|int, mixed>
toArray()  : array<string|int, mixed>
Get the instance as an array.
toJson()  : string
version()  : string
automaticallySerialize()  : array<string|int, mixed>
Automatically serialize all public properties.

Constants

Properties

$mediaDirectory

protected string $mediaDirectory = '_media'

$outputDirectory

protected string $outputDirectory = '_site'

Methods

__construct()

public __construct([string|null $basePath = null ]) : mixed
Parameters
$basePath : string|null = null

arraySerialize()

Recursively serialize Arrayables

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

features()

public features() : Features
Return values
Features

hasFeature()

public hasFeature(Feature|string $feature) : bool
Parameters
$feature : Feature|string
Return values
bool

jsonSerialize()

public jsonSerialize() : array<string|int, mixed>
Tags
inheritDoc
Return values
array<string|int, mixed>

toArray()

Get the instance as an array.

public toArray() : array<string|int, mixed>
Tags
inheritDoc
Return values
array<string|int, mixed>

toJson()

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

version()

public static version() : string
Return values
string

automaticallySerialize()

Automatically serialize all public properties.

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

        
On this page

Search results