mirror/php-monolog
1
0
Fork 0
mirror of https://github.com/Seldaek/monolog.git synced 2025-08-18 10:51:19 +02:00
Code Issues Releases Wiki Activity

Docblock fixes

Browse Source
This commit is contained in:
George Mponos
2018-12-09 22:31:46 +02:00
parent 966c2f64b3
commit 790ff7fd1d
6 changed files with 16 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
src/Monolog/Formatter/HtmlFormatter.php
View File

@@ -37,7 +37,7 @@ class HtmlFormatter extends NormalizerFormatter
]; ];
/** /**
* @param ?string $dateFormat The format of the timestamp: one supported by DateTime::format * @param string|null $dateFormat The format of the timestamp: one supported by DateTime::format
*/ */
public function __construct(?string $dateFormat = null) public function __construct(?string $dateFormat = null)
{ {
@@ -50,6 +50,7 @@ class HtmlFormatter extends NormalizerFormatter
* @param string $th Row header content * @param string $th Row header content
* @param string $td Row standard cell content * @param string $td Row standard cell content
* @param bool $escapeTd false if td content must not be html escaped * @param bool $escapeTd false if td content must not be html escaped
* @return string
*/ */
protected function addRow(string $th, string $td = ' ', bool $escapeTd = true): string protected function addRow(string $th, string $td = ' ', bool $escapeTd = true): string
{ {

8
src/Monolog/Formatter/LineFormatter.php
View File

@@ -31,10 +31,10 @@ class LineFormatter extends NormalizerFormatter
protected $includeStacktraces; protected $includeStacktraces;
/** /**
* @param ?string $format The format of the message * @param string|null $format The format of the message
* @param ?string $dateFormat The format of the timestamp: one supported by DateTime::format * @param string|null $dateFormat The format of the timestamp: one supported by DateTime::format
* @param bool $allowInlineLineBreaks Whether to allow inline line breaks in log entries * @param bool $allowInlineLineBreaks Whether to allow inline line breaks in log entries
* @param bool $ignoreEmptyContextAndExtra * @param bool $ignoreEmptyContextAndExtra
*/ */
public function __construct(?string $format = null, ?string $dateFormat = null, bool $allowInlineLineBreaks = false, bool $ignoreEmptyContextAndExtra = false) public function __construct(?string $format = null, ?string $dateFormat = null, bool $allowInlineLineBreaks = false, bool $ignoreEmptyContextAndExtra = false)
{ {

8
src/Monolog/Formatter/LogstashFormatter.php
View File

@@ -42,10 +42,10 @@ class LogstashFormatter extends NormalizerFormatter
protected $contextKey; protected $contextKey;
/** /**
* @param string $applicationName the application that sends the data, used as the "type" field of logstash * @param string $applicationName The application that sends the data, used as the "type" field of logstash
* @param ?string $systemName the system/machine name, used as the "source" field of logstash, defaults to the hostname of the machine * @param string|null $systemName The system/machine name, used as the "source" field of logstash, defaults to the hostname of the machine
* @param string $extraKey the key for extra keys inside logstash "fields", defaults to extra * @param string $extraKey The key for extra keys inside logstash "fields", defaults to extra
* @param string $contextKey the key for context keys inside logstash "fields", defaults to context * @param string $contextKey The key for context keys inside logstash "fields", defaults to context
*/ */
public function __construct(string $applicationName, ?string $systemName = null, string $extraKey = 'extra', string $contextKey = 'context') public function __construct(string $applicationName, ?string $systemName = null, string $extraKey = 'extra', string $contextKey = 'context')
{ {

2
src/Monolog/Formatter/NormalizerFormatter.php
View File

@@ -31,7 +31,7 @@ class NormalizerFormatter implements FormatterInterface
private $jsonEncodeOptions = JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRESERVE_ZERO_FRACTION; private $jsonEncodeOptions = JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRESERVE_ZERO_FRACTION;
/** /**
* @param ?string $dateFormat The format of the timestamp: one supported by DateTime::format * @param string|null $dateFormat The format of the timestamp: one supported by DateTime::format
*/ */
public function __construct(?string $dateFormat = null) public function __construct(?string $dateFormat = null)
{ {

4
src/Monolog/Handler/Slack/SlackRecord.php
View File

@@ -35,13 +35,13 @@ class SlackRecord
/** /**
* Slack channel (encoded ID or name) * Slack channel (encoded ID or name)
* @var ?string * @var string|null
*/ */
private $channel; private $channel;
/** /**
* Name of a bot * Name of a bot
* @var ?string * @var string|null
*/ */
private $username; private $username;

6
src/Monolog/Processor/PsrLogMessageProcessor.php
View File

@@ -24,15 +24,15 @@ class PsrLogMessageProcessor implements ProcessorInterface
{ {
public const SIMPLE_DATE = "Y-m-d\TH:i:s.uP"; public const SIMPLE_DATE = "Y-m-d\TH:i:s.uP";
/** @var ?string */ /** @var string|null */
private $dateFormat; private $dateFormat;
/** @var bool */ /** @var bool */
private $removeUsedContextFields; private $removeUsedContextFields;
/** /**
* @param ?string $dateFormat The format of the timestamp: one supported by DateTime::format * @param string|null $dateFormat The format of the timestamp: one supported by DateTime::format
* @param bool $removeUsedContextFields If set to true the fields interpolated into message gets unset * @param bool $removeUsedContextFields If set to true the fields interpolated into message gets unset
*/ */
public function __construct(?string $dateFormat = null, bool $removeUsedContextFields = false) public function __construct(?string $dateFormat = null, bool $removeUsedContextFields = false)
{ {