AbstractHelper
extends CoreObject
in package
implements
Configurable
AbstractYes
A base class for many Core classes to provide shared access to resources and common functions
Table of Contents
Interfaces
- Configurable
- An interface defining a Configurable class
Properties
Methods
- configure() : void
- Override to handle any Helper specific configurations.
- getAppConfiguration() : array<string|int, mixed>
- Provides a single instance of the global app configuration to all extenders of CoreObject
- getLogger() : Logger
- Provides a single instance of a configured Logger to all extenders of CoreObject
- getSite() : Site
- Get the site associated with this Helper
- setSite() : void
- Set the site associated with this Helper
Properties
$site
private
Site
$site
The associated Site implementation
Methods
configure()
Override to handle any Helper specific configurations.
public
configure(Site $site) : void
Parameters
- $site : Site
-
An implementation of the \Pipit\Interfaces\Site interface
getAppConfiguration()
Provides a single instance of the global app configuration to all extenders of CoreObject
public
getAppConfiguration() : array<string|int, mixed>
Return values
array<string|int, mixed>getLogger()
Provides a single instance of a configured Logger to all extenders of CoreObject
public
getLogger() : Logger
Return values
LoggergetSite()
Get the site associated with this Helper
public
getSite() : Site
Return values
SitesetSite()
Set the site associated with this Helper
public
setSite(Site $site) : void
Parameters
- $site : Site
-
An implementation of the \Pipit\Interfaces\Site interface