Skip to content

Commit 765b59d

Browse files
creifenscheidChristian Reifenscheidlinawolf
authored
[TASK] Adds custom log processor example (#6248)
* [TASK] Adds custom log processor example * Add example for extending AbstractProcessor class Added an example section for extending the abstract processor class. --------- Co-authored-by: Christian Reifenscheid <reifenscheid@clickstorm.de> Co-authored-by: Lina Wolf <48202465+linawolf@users.noreply.github.com>
1 parent 41279ea commit 765b59d

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

Documentation/ApiOverview/Logging/Processors/Index.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,11 @@ It is suggested to extend the abstract class
157157
:t3src:`core/Classes/Log/Processor/AbstractProcessor.php` which allows you use
158158
configuration options by adding the corresponding properties and setter methods.
159159

160+
.. rubric:: Example
161+
162+
.. literalinclude:: _MyProcessorWithOptions.php
163+
:caption: EXT:my_extension/Classes/Log/Processor/MyProcessor.php
164+
160165
Please keep in mind that TYPO3 will silently continue operating,
161166
in case a log processor is throwing an exception while executing
162167
the :php:`processLogRecord()` method.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<?php
2+
3+
namespace MyVendor\MyExtension\Log\Processor;
4+
5+
use TYPO3\CMS\Core\Log\LogRecord;
6+
7+
class MyProcessor extends \TYPO3\CMS\Core\Log\Processor\AbstractProcessor
8+
{
9+
protected bool $option = true;
10+
11+
public function setOption(bool $option): void
12+
{
13+
$this->option = $option;
14+
}
15+
16+
public function processLogRecord(LogRecord $logRecord): LogRecord
17+
{
18+
// add magic
19+
20+
return $logRecord;
21+
}
22+
}

0 commit comments

Comments
 (0)