Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7399423
FilterHandler.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
6 KB
Referenced Files
None
Subscribers
None
FilterHandler.php
View Options
<?php
declare
(
strict_types
=
1
);
/*
* This file is part of the Monolog package.
*
* (c) Jordi Boggiano <j.boggiano@seld.be>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace
Monolog\Handler
;
use
Monolog\Logger
;
use
Monolog\ResettableInterface
;
use
Monolog\Formatter\FormatterInterface
;
use
Psr\Log\LogLevel
;
/**
* Simple handler wrapper that filters records based on a list of levels
*
* It can be configured with an exact list of levels to allow, or a min/max level.
*
* @author Hennadiy Verkh
* @author Jordi Boggiano <j.boggiano@seld.be>
*
* @phpstan-import-type Record from \Monolog\Logger
* @phpstan-import-type Level from \Monolog\Logger
* @phpstan-import-type LevelName from \Monolog\Logger
*/
class
FilterHandler
extends
Handler
implements
ProcessableHandlerInterface
,
ResettableInterface
,
FormattableHandlerInterface
{
use
ProcessableHandlerTrait
;
/**
* Handler or factory callable($record, $this)
*
* @var callable|HandlerInterface
* @phpstan-var callable(?Record, HandlerInterface): HandlerInterface|HandlerInterface
*/
protected
$handler
;
/**
* Minimum level for logs that are passed to handler
*
* @var int[]
* @phpstan-var array<Level, int>
*/
protected
$acceptedLevels
;
/**
* Whether the messages that are handled can bubble up the stack or not
*
* @var bool
*/
protected
$bubble
;
/**
* @psalm-param HandlerInterface|callable(?Record, HandlerInterface): HandlerInterface $handler
*
* @param callable|HandlerInterface $handler Handler or factory callable($record|null, $filterHandler).
* @param int|array $minLevelOrList A list of levels to accept or a minimum level if maxLevel is provided
* @param int|string $maxLevel Maximum level to accept, only used if $minLevelOrList is not an array
* @param bool $bubble Whether the messages that are handled can bubble up the stack or not
*
* @phpstan-param Level|LevelName|LogLevel::*|array<Level|LevelName|LogLevel::*> $minLevelOrList
* @phpstan-param Level|LevelName|LogLevel::* $maxLevel
*/
public
function
__construct
(
$handler
,
$minLevelOrList
=
Logger
::
DEBUG
,
$maxLevel
=
Logger
::
EMERGENCY
,
bool
$bubble
=
true
)
{
$this
->
handler
=
$handler
;
$this
->
bubble
=
$bubble
;
$this
->
setAcceptedLevels
(
$minLevelOrList
,
$maxLevel
);
if
(!
$this
->
handler
instanceof
HandlerInterface
&&
!
is_callable
(
$this
->
handler
))
{
throw
new
\RuntimeException
(
"The given handler ("
.
json_encode
(
$this
->
handler
).
") is not a callable nor a Monolog
\H
andler
\H
andlerInterface object"
);
}
}
/**
* @phpstan-return array<int, Level>
*/
public
function
getAcceptedLevels
():
array
{
return
array_flip
(
$this
->
acceptedLevels
);
}
/**
* @param int|string|array $minLevelOrList A list of levels to accept or a minimum level or level name if maxLevel is provided
* @param int|string $maxLevel Maximum level or level name to accept, only used if $minLevelOrList is not an array
*
* @phpstan-param Level|LevelName|LogLevel::*|array<Level|LevelName|LogLevel::*> $minLevelOrList
* @phpstan-param Level|LevelName|LogLevel::* $maxLevel
*/
public
function
setAcceptedLevels
(
$minLevelOrList
=
Logger
::
DEBUG
,
$maxLevel
=
Logger
::
EMERGENCY
):
self
{
if
(
is_array
(
$minLevelOrList
))
{
$acceptedLevels
=
array_map
(
'Monolog
\L
ogger::toMonologLevel'
,
$minLevelOrList
);
}
else
{
$minLevelOrList
=
Logger
::
toMonologLevel
(
$minLevelOrList
);
$maxLevel
=
Logger
::
toMonologLevel
(
$maxLevel
);
$acceptedLevels
=
array_values
(
array_filter
(
Logger
::
getLevels
(),
function
(
$level
)
use
(
$minLevelOrList
,
$maxLevel
)
{
return
$level
>=
$minLevelOrList
&&
$level
<=
$maxLevel
;
}));
}
$this
->
acceptedLevels
=
array_flip
(
$acceptedLevels
);
return
$this
;
}
/**
* {@inheritDoc}
*/
public
function
isHandling
(
array
$record
):
bool
{
return
isset
(
$this
->
acceptedLevels
[
$record
[
'level'
]]);
}
/**
* {@inheritDoc}
*/
public
function
handle
(
array
$record
):
bool
{
if
(!
$this
->
isHandling
(
$record
))
{
return
false
;
}
if
(
$this
->
processors
)
{
/** @var Record $record */
$record
=
$this
->
processRecord
(
$record
);
}
$this
->
getHandler
(
$record
)->
handle
(
$record
);
return
false
===
$this
->
bubble
;
}
/**
* {@inheritDoc}
*/
public
function
handleBatch
(
array
$records
):
void
{
$filtered
=
[];
foreach
(
$records
as
$record
)
{
if
(
$this
->
isHandling
(
$record
))
{
$filtered
[]
=
$record
;
}
}
if
(
count
(
$filtered
)
>
0
)
{
$this
->
getHandler
(
$filtered
[
count
(
$filtered
)
-
1
])->
handleBatch
(
$filtered
);
}
}
/**
* Return the nested handler
*
* If the handler was provided as a factory callable, this will trigger the handler's instantiation.
*
* @return HandlerInterface
*
* @phpstan-param Record $record
*/
public
function
getHandler
(?
array
$record
=
null
)
{
if
(!
$this
->
handler
instanceof
HandlerInterface
)
{
$this
->
handler
=
(
$this
->
handler
)(
$record
,
$this
);
if
(!
$this
->
handler
instanceof
HandlerInterface
)
{
throw
new
\RuntimeException
(
"The factory callable should return a HandlerInterface"
);
}
}
return
$this
->
handler
;
}
/**
* {@inheritDoc}
*/
public
function
setFormatter
(
FormatterInterface
$formatter
):
HandlerInterface
{
$handler
=
$this
->
getHandler
();
if
(
$handler
instanceof
FormattableHandlerInterface
)
{
$handler
->
setFormatter
(
$formatter
);
return
$this
;
}
throw
new
\UnexpectedValueException
(
'The nested handler of type '
.
get_class
(
$handler
).
' does not support formatters.'
);
}
/**
* {@inheritDoc}
*/
public
function
getFormatter
():
FormatterInterface
{
$handler
=
$this
->
getHandler
();
if
(
$handler
instanceof
FormattableHandlerInterface
)
{
return
$handler
->
getFormatter
();
}
throw
new
\UnexpectedValueException
(
'The nested handler of type '
.
get_class
(
$handler
).
' does not support formatters.'
);
}
public
function
reset
()
{
$this
->
resetProcessors
();
if
(
$this
->
getHandler
()
instanceof
ResettableInterface
)
{
$this
->
getHandler
()->
reset
();
}
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Sat, Nov 21, 16:00 (7 h, 35 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
88/16/d9c6de67ec250cc906f0fcc3d216
Default Alt Text
FilterHandler.php (6 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment