Skip to content

Commit

Permalink
Drop useless phpdoc, already covered by PHP
Browse files Browse the repository at this point in the history
  • Loading branch information
@lyrixx
lyrixx committed Mar 26, 2024
1 parent fe5ea30 commit 33208d4
Show file tree
Hide file tree
Showing 5 changed files with 2 additions and 86 deletions.
4 changes: 0 additions & 4 deletions src/LoggerAwareInterface.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,6 @@ interface LoggerAwareInterface
{
/**
* Sets a logger instance on the object.
*
* @param LoggerInterface $logger
*
* @return void
*/
public function setLogger(LoggerInterface $logger): void;
}
4 changes: 0 additions & 4 deletions src/LoggerAwareTrait.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,11 @@ trait LoggerAwareTrait
{
/**
* The logger instance.
*
* @var LoggerInterface|null
*/
protected ?LoggerInterface $logger = null;

/**
* Sets a logger.
*
* @param LoggerInterface $logger
*/
public function setLogger(LoggerInterface $logger): void
{
Expand Down
28 changes: 0 additions & 28 deletions src/LoggerInterface.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,7 @@ interface LoggerInterface
/**
* System is unusable.
*
* @param string|\Stringable $message
* @param mixed[] $context
*
* @return void
*/
public function emergency(string|\Stringable $message, array $context = []): void;

Expand All @@ -35,10 +32,7 @@ public function emergency(string|\Stringable $message, array $context = []): voi
* Example: Entire website down, database unavailable, etc. This should
* trigger the SMS alerts and wake you up.
*
* @param string|\Stringable $message
* @param mixed[] $context
*
* @return void
*/
public function alert(string|\Stringable $message, array $context = []): void;

Expand All @@ -47,21 +41,15 @@ public function alert(string|\Stringable $message, array $context = []): void;
*
* Example: Application component unavailable, unexpected exception.
*
* @param string|\Stringable $message
* @param mixed[] $context
*
* @return void
*/
public function critical(string|\Stringable $message, array $context = []): void;

/**
* Runtime errors that do not require immediate action but should typically
* be logged and monitored.
*
* @param string|\Stringable $message
* @param mixed[] $context
*
* @return void
*/
public function error(string|\Stringable $message, array $context = []): void;

Expand All @@ -71,20 +59,14 @@ public function error(string|\Stringable $message, array $context = []): void;
* Example: Use of deprecated APIs, poor use of an API, undesirable things
* that are not necessarily wrong.
*
* @param string|\Stringable $message
* @param mixed[] $context
*
* @return void
*/
public function warning(string|\Stringable $message, array $context = []): void;

/**
* Normal but significant events.
*
* @param string|\Stringable $message
* @param mixed[] $context
*
* @return void
*/
public function notice(string|\Stringable $message, array $context = []): void;

Expand All @@ -93,32 +75,22 @@ public function notice(string|\Stringable $message, array $context = []): void;
*
* Example: User logs in, SQL logs.
*
* @param string|\Stringable $message
* @param mixed[] $context
*
* @return void
*/
public function info(string|\Stringable $message, array $context = []): void;

/**
* Detailed debug information.
*
* @param string|\Stringable $message
* @param mixed[] $context
*
* @return void
*/
public function debug(string|\Stringable $message, array $context = []): void;

/**
* Logs with an arbitrary level.
*
* @param mixed $level
* @param string|\Stringable $message
* @param mixed[] $context
*
* @return void
*
* @throws \Psr\Log\InvalidArgumentException
*/
public function log($level, string|\Stringable $message, array $context = []): void;
Expand Down
46 changes: 1 addition & 45 deletions src/LoggerTrait.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,6 @@ trait LoggerTrait
{
/**
* System is unusable.
*
* @param string|\Stringable $message
* @param array $context
*
* @return void
*/
public function emergency(string|\Stringable $message, array $context = []): void
{
Expand All @@ -30,11 +25,6 @@ public function emergency(string|\Stringable $message, array $context = []): voi
*
* Example: Entire website down, database unavailable, etc. This should
* trigger the SMS alerts and wake you up.
*
* @param string|\Stringable $message
* @param array $context
*
* @return void
*/
public function alert(string|\Stringable $message, array $context = []): void
{
Expand All @@ -45,11 +35,6 @@ public function alert(string|\Stringable $message, array $context = []): void
* Critical conditions.
*
* Example: Application component unavailable, unexpected exception.
*
* @param string|\Stringable $message
* @param array $context
*
* @return void
*/
public function critical(string|\Stringable $message, array $context = []): void
{
Expand All @@ -59,11 +44,6 @@ public function critical(string|\Stringable $message, array $context = []): void
/**
* Runtime errors that do not require immediate action but should typically
* be logged and monitored.
*
* @param string|\Stringable $message
* @param array $context
*
* @return void
*/
public function error(string|\Stringable $message, array $context = []): void
{
Expand All @@ -75,11 +55,6 @@ public function error(string|\Stringable $message, array $context = []): void
*
* Example: Use of deprecated APIs, poor use of an API, undesirable things
* that are not necessarily wrong.
*
* @param string|\Stringable $message
* @param array $context
*
* @return void
*/
public function warning(string|\Stringable $message, array $context = []): void
{
Expand All @@ -88,11 +63,6 @@ public function warning(string|\Stringable $message, array $context = []): void

/**
* Normal but significant events.
*
* @param string|\Stringable $message
* @param array $context
*
* @return void
*/
public function notice(string|\Stringable $message, array $context = []): void
{
Expand All @@ -103,11 +73,6 @@ public function notice(string|\Stringable $message, array $context = []): void
* Interesting events.
*
* Example: User logs in, SQL logs.
*
* @param string|\Stringable $message
* @param array $context
*
* @return void
*/
public function info(string|\Stringable $message, array $context = []): void
{
Expand All @@ -116,11 +81,6 @@ public function info(string|\Stringable $message, array $context = []): void

/**
* Detailed debug information.
*
* @param string|\Stringable $message
* @param array $context
*
* @return void
*/
public function debug(string|\Stringable $message, array $context = []): void
{
Expand All @@ -130,11 +90,7 @@ public function debug(string|\Stringable $message, array $context = []): void
/**
* Logs with an arbitrary level.
*
* @param mixed $level
* @param string|\Stringable $message
* @param array $context
*
* @return void
* @param mixed $level
*
* @throws \Psr\Log\InvalidArgumentException
*/
Expand Down
6 changes: 1 addition & 5 deletions src/NullLogger.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,7 @@ class NullLogger extends AbstractLogger
/**
* Logs with an arbitrary level.
*
* @param mixed $level
* @param string|\Stringable $message
* @param array $context
*
* @return void
* @param mixed[] $context
*
* @throws \Psr\Log\InvalidArgumentException
*/
Expand Down

0 comments on commit 33208d4

Please sign in to comment.