Skip to content

Add Psalm capability annotations to LoggerInterface #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
danog wants to merge 1 commit into
base: master
Choose a base branch
from
+9 −0
Open

Add Psalm capability annotations to LoggerInterface #87

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/LoggerInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ interface LoggerInterface
* System is unusable.
*
* @param mixed[] $context
* @psalm-capabilities read-props|write-this-props|write-props|read-globals|write-globals|io|time
*/
public function emergency(string|\Stringable $message, array $context = []): void;

Expand All @@ -33,6 +34,7 @@ public function emergency(string|\Stringable $message, array $context = []): voi
* trigger the SMS alerts and wake you up.
*
* @param mixed[] $context
* @psalm-capabilities read-props|write-this-props|write-props|read-globals|write-globals|io|time
*/
public function alert(string|\Stringable $message, array $context = []): void;

Expand All @@ -42,6 +44,7 @@ public function alert(string|\Stringable $message, array $context = []): void;
* Example: Application component unavailable, unexpected exception.
*
* @param mixed[] $context
* @psalm-capabilities read-props|write-this-props|write-props|read-globals|write-globals|io|time
*/
public function critical(string|\Stringable $message, array $context = []): void;

Expand All @@ -50,6 +53,7 @@ public function critical(string|\Stringable $message, array $context = []): void
* be logged and monitored.
*
* @param mixed[] $context
* @psalm-capabilities read-props|write-this-props|write-props|read-globals|write-globals|io|time
*/
public function error(string|\Stringable $message, array $context = []): void;

Expand All @@ -60,13 +64,15 @@ public function error(string|\Stringable $message, array $context = []): void;
* that are not necessarily wrong.
*
* @param mixed[] $context
* @psalm-capabilities read-props|write-this-props|write-props|read-globals|write-globals|io|time
*/
public function warning(string|\Stringable $message, array $context = []): void;

/**
* Normal but significant events.
*
* @param mixed[] $context
* @psalm-capabilities read-props|write-this-props|write-props|read-globals|write-globals|io|time
*/
public function notice(string|\Stringable $message, array $context = []): void;

Expand All @@ -76,13 +82,15 @@ public function notice(string|\Stringable $message, array $context = []): void;
* Example: User logs in, SQL logs.
*
* @param mixed[] $context
* @psalm-capabilities read-props|write-this-props|write-props|read-globals|write-globals|io|time
*/
public function info(string|\Stringable $message, array $context = []): void;

/**
* Detailed debug information.
*
* @param mixed[] $context
* @psalm-capabilities read-props|write-this-props|write-props|read-globals|write-globals|io|time
*/
public function debug(string|\Stringable $message, array $context = []): void;

Expand All @@ -93,6 +101,7 @@ public function debug(string|\Stringable $message, array $context = []): void;
* @param mixed[] $context
*
* @throws \Psr\Log\InvalidArgumentException
* @psalm-capabilities read-props|write-this-props|write-props|read-globals|write-globals|io|time
*/
public function log($level, string|\Stringable $message, array $context = []): void;
}