Documentation

CoreFunctions
in package

A library class that provides shared access to resources and common functions

Tags
author

Jason Savell jsavell@library.tamu.edu

Table of Contents

Properties

$appConfiguration  : array<string|int, mixed>
$instance  : CoreFunctions
$logger  : Logger

Methods

getAppConfiguration()  : array<string|int, mixed>
Provides a single instance of the global app configuration to all extenders of CoreObject
getInstance()  : CoreFunctions
Returns a singleton instance of the CoreFunctions class
getLogger()  : Logger
Provides a single instance of a configured Logger to all extenders of CoreObject
__construct()  : mixed
setAppConfiguration()  : void
Sets the AppConfiguration
setLogger()  : void
Sets the Logger

Properties

$appConfiguration

private array<string|int, mixed> $appConfiguration = null

This provides the global app configuration to all extenders of this class

$logger

private Logger $logger = null

This provides the configured Logger to all extenders of this class

Methods

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
Logger

setAppConfiguration()

Sets the AppConfiguration

private setAppConfiguration(array<string|int, mixed> $appConfiguration) : void
Parameters
$appConfiguration : array<string|int, mixed>

An array representing the app configuration

setLogger()

Sets the Logger

private setLogger(Logger $logger) : void
Parameters
$logger : Logger

An instance of a Logger implementation


        
On this page

Search results