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
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
VERSION
public
final mixed
VERSION
= '1.7.3'
Properties
$basePath
protected
string
$basePath
$booted
protected
bool
$booted
= false
$extensions
protected
array<HydeExtension>, HydeExtension>
$extensions
= []
$files
protected
FileCollection
$files
$filesystem
protected
Filesystem
$filesystem
$hyperlinks
protected
Hyperlinks
$hyperlinks
$instance
protected
static self
$instance
$mediaDirectory
protected
string
$mediaDirectory
= '_media'
$outputDirectory
protected
string
$outputDirectory
= '_site'
$pages
protected
PageCollection
$pages
$routes
protected
RouteCollection
$routes
$sourceRoot
protected
string
$sourceRoot
= ''
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
FeatureshasFeature()
public
hasFeature(Feature|string $feature) : bool
Parameters
- $feature : Feature|string
Return values
booljsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>toArray()
Get the instance as an array.
public
toArray() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>toJson()
public
toJson([int $options = 0 ]) : string
Parameters
- $options : int = 0
Return values
stringversion()
public
static version() : string
Return values
stringautomaticallySerialize()
Automatically serialize all public properties.
protected
automaticallySerialize() : array<string|int, mixed>