HydeCoreExtension
extends HydeExtension
in package
When creating a HydePHP extension, you should create a class that extends this one.
After registering your implementation with the HydeKernel (usually in a service provider), Hyde will be able to use the information within to integrate your plugin, and to allow you to hook into various parts of the internal application lifecycle, and through that, all aspects of Hyde.
Before creating your extension, it will certainly be helpful if you first become familiar with the basic internal architecture of HydePHP, as well as how the auto-discovery system functions.
Table of Contents
Methods
- discoverFiles() : void
- If your extension needs to hook into the file discovery process, you can configure the following handler method. It will be called at the end of the file discovery process. The collection instance will be injected, so that you can interact with it directly.
- discoverPages() : void
- If your extension needs to hook into the page discovery process, you can configure the following handler method. It will be called at the end of the page discovery process. The collection instance will be injected, so that you can interact with it directly.
- discoverRoutes() : void
- If your extension needs to hook into the route discovery process, you can configure the following handler method. It will be called at the end of the route discovery process. The collection instance will be injected, so that you can interact with it directly.
- getPageClasses() : array<string|int, HydePage>>
- If your extension adds new discoverable page classes, you should register them here.
Methods
discoverFiles()
If your extension needs to hook into the file discovery process, you can configure the following handler method. It will be called at the end of the file discovery process. The collection instance will be injected, so that you can interact with it directly.
public
discoverFiles(FileCollection $collection) : void
Parameters
- $collection : FileCollection
discoverPages()
If your extension needs to hook into the page discovery process, you can configure the following handler method. It will be called at the end of the page discovery process. The collection instance will be injected, so that you can interact with it directly.
public
discoverPages(PageCollection $collection) : void
Parameters
- $collection : PageCollection
discoverRoutes()
If your extension needs to hook into the route discovery process, you can configure the following handler method. It will be called at the end of the route discovery process. The collection instance will be injected, so that you can interact with it directly.
public
discoverRoutes(RouteCollection $collection) : void
Parameters
- $collection : RouteCollection
getPageClasses()
If your extension adds new discoverable page classes, you should register them here.
public
static getPageClasses() : array<string|int, HydePage>>