MonologExtension
extends Extension
in package
MonologExtension is an extension for the Monolog library.
Tags
Table of Contents
- $annotatedClasses : mixed
- $nestedHandlers : mixed
- $processedConfigs : mixed
- $swiftMailerHandlers : mixed
- addAnnotatedClassesToCompile() : mixed
- Adds annotated classes to the class cache.
- getAlias() : string
- Returns the recommended alias to use in XML.
- getAnnotatedClassesToCompile() : array<string|int, mixed>
- Gets the annotated classes to cache.
- getConfiguration() : ConfigurationInterface|null
- Returns extension configuration.
- getNamespace() : mixed
- getXsdValidationBasePath() : string
- Returns the base path for the XSD files.
- load() : mixed
- Loads the Monolog configuration.
- isConfigEnabled() : bool
- processConfiguration() : array<string|int, mixed>
- buildHandler() : mixed
- buildPsrLogMessageProcessor() : string
- getHandlerClassByType() : mixed
- getHandlerId() : mixed
- markNestedHandler() : mixed
Properties
$annotatedClasses
private
mixed
$annotatedClasses
= []
$nestedHandlers
private
mixed
$nestedHandlers
= []
$processedConfigs
private
mixed
$processedConfigs
= []
$swiftMailerHandlers
private
mixed
$swiftMailerHandlers
= []
Methods
addAnnotatedClassesToCompile()
Adds annotated classes to the class cache.
public
addAnnotatedClassesToCompile(array<string|int, mixed> $annotatedClasses) : mixed
Parameters
- $annotatedClasses : array<string|int, mixed>
-
An array of class patterns
Return values
mixed —getAlias()
Returns the recommended alias to use in XML.
public
getAlias() : string
This alias is also the mandatory prefix to use when using YAML.
This convention is to remove the "Extension" postfix from the class name and then lowercase and underscore the result. So:
AcmeHelloExtension
becomes
acme_hello
This can be overridden in a sub-class to specify the alias manually.
Tags
Return values
string —getAnnotatedClassesToCompile()
Gets the annotated classes to cache.
public
getAnnotatedClassesToCompile() : array<string|int, mixed>
Return values
array<string|int, mixed> —getConfiguration()
Returns extension configuration.
public
getConfiguration(array<string|int, mixed> $config, ContainerBuilder $container) : ConfigurationInterface|null
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
Return values
ConfigurationInterface|null —getNamespace()
public
getNamespace() : mixed
Return values
mixed —getXsdValidationBasePath()
Returns the base path for the XSD files.
public
getXsdValidationBasePath() : string
Return values
string —The XSD base path
load()
Loads the Monolog configuration.
public
load(array<string|int, mixed> $configs, ContainerBuilder $container) : mixed
Parameters
- $configs : array<string|int, mixed>
-
An array of configuration settings
- $container : ContainerBuilder
-
A ContainerBuilder instance
Return values
mixed —isConfigEnabled()
protected
isConfigEnabled(ContainerBuilder $container, array<string|int, mixed> $config) : bool
Parameters
- $container : ContainerBuilder
- $config : array<string|int, mixed>
Tags
Return values
bool —processConfiguration()
protected
final processConfiguration(ConfigurationInterface $configuration, array<string|int, mixed> $configs) : array<string|int, mixed>
Parameters
- $configuration : ConfigurationInterface
- $configs : array<string|int, mixed>
Return values
array<string|int, mixed> —buildHandler()
private
buildHandler(ContainerBuilder $container, mixed $name, array<string|int, mixed> $handler) : mixed
Parameters
- $container : ContainerBuilder
- $name : mixed
- $handler : array<string|int, mixed>
Return values
mixed —buildPsrLogMessageProcessor()
private
buildPsrLogMessageProcessor(ContainerBuilder $container, array<string|int, mixed> $processorOptions) : string
Parameters
- $container : ContainerBuilder
- $processorOptions : array<string|int, mixed>
Return values
string —getHandlerClassByType()
private
getHandlerClassByType(mixed $handlerType) : mixed
Parameters
- $handlerType : mixed
Return values
mixed —getHandlerId()
private
getHandlerId(mixed $name) : mixed
Parameters
- $name : mixed
Return values
mixed —markNestedHandler()
private
markNestedHandler(mixed $nestedHandlerId) : mixed
Parameters
- $nestedHandlerId : mixed