Skip to content

[9.x] PSR Log v3 #40087

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

Merged
merged 4 commits into from
Dec 17, 2021
+28 −28
Merged

[9.x] PSR Log v3 #40087

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c0816b8
PSR Log v3
driesvints Dec 17, 2021
9a4c78f
Apply fixes from StyleCI
taylorotwell Dec 17, 2021
9a94078
Re-add support for psr/log v2
driesvints Dec 17, 2021
9ba80db
formatting
taylorotwell Dec 17, 2021
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
2 changes: 1 addition & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"monolog/monolog": "^2.0",
"nesbot/carbon": "^2.53.1",
"psr/container": "^1.1.1|^2.0.1",
"psr/log": "^1.0|^2.0",
"psr/log": "^2.0|^3.0",
"psr/simple-cache": "^1.0",
"ramsey/uuid": "^4.2.2",
"symfony/console": "^6.0",
Expand Down
2 changes: 1 addition & 1 deletion src/Illuminate/Broadcasting/composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"require": {
"php": "^8.0.2",
"ext-json": "*",
"psr/log": "^1.0|^2.0",
"psr/log": "^2.0|^3.0",
"illuminate/bus": "^9.0",
"illuminate/collections": "^9.0",
"illuminate/contracts": "^9.0",
Expand Down
50 changes: 25 additions & 25 deletions src/Illuminate/Log/Logger.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,95 +49,95 @@ public function __construct(LoggerInterface $logger, Dispatcher $dispatcher = nu
/**
* Log an emergency message to the logs.
*
* @param string $message
* @param Arrayable|Jsonable|\Stringable|array|string $message
* @param array $context
* @return void
*/
public function emergency($message, array $context = []): void
public function emergency(Arrayable|Jsonable|\Stringable|array|string $message, array $context = []): void
{
$this->writeLog(__FUNCTION__, $message, $context);
}

/**
* Log an alert message to the logs.
*
* @param string $message
* @param Arrayable|Jsonable|\Stringable|array|string $message
* @param array $context
* @return void
*/
public function alert($message, array $context = []): void
public function alert(Arrayable|Jsonable|\Stringable|array|string $message, array $context = []): void
{
$this->writeLog(__FUNCTION__, $message, $context);
}

/**
* Log a critical message to the logs.
*
* @param string $message
* @param Arrayable|Jsonable|\Stringable|array|string $message
* @param array $context
* @return void
*/
public function critical($message, array $context = []): void
public function critical(Arrayable|Jsonable|\Stringable|array|string $message, array $context = []): void
{
$this->writeLog(__FUNCTION__, $message, $context);
}

/**
* Log an error message to the logs.
*
* @param string $message
* @param Arrayable|Jsonable|\Stringable|array|string $message
* @param array $context
* @return void
*/
public function error($message, array $context = []): void
public function error(Arrayable|Jsonable|\Stringable|array|string $message, array $context = []): void
{
$this->writeLog(__FUNCTION__, $message, $context);
}

/**
* Log a warning message to the logs.
*
* @param string $message
* @param Arrayable|Jsonable|\Stringable|array|string $message
* @param array $context
* @return void
*/
public function warning($message, array $context = []): void
public function warning(Arrayable|Jsonable|\Stringable|array|string $message, array $context = []): void
{
$this->writeLog(__FUNCTION__, $message, $context);
}

/**
* Log a notice to the logs.
*
* @param string $message
* @param Arrayable|Jsonable|\Stringable|array|string $message
* @param array $context
* @return void
*/
public function notice($message, array $context = []): void
public function notice(Arrayable|Jsonable|\Stringable|array|string $message, array $context = []): void
{
$this->writeLog(__FUNCTION__, $message, $context);
}

/**
* Log an informational message to the logs.
*
* @param string $message
* @param Arrayable|Jsonable|\Stringable|array|string $message
* @param array $context
* @return void
*/
public function info($message, array $context = []): void
public function info(Arrayable|Jsonable|\Stringable|array|string $message, array $context = []): void
{
$this->writeLog(__FUNCTION__, $message, $context);
}

/**
* Log a debug message to the logs.
*
* @param string $message
* @param Arrayable|Jsonable|\Stringable|array|string $message
* @param array $context
* @return void
*/
public function debug($message, array $context = []): void
public function debug(Arrayable|Jsonable|\Stringable|array|string $message, array $context = []): void
{
$this->writeLog(__FUNCTION__, $message, $context);
}
Expand All @@ -146,11 +146,11 @@ public function debug($message, array $context = []): void
* Log a message to the logs.
*
* @param string $level
* @param string $message
* @param Arrayable|Jsonable|\Stringable|array|string $message
* @param array $context
* @return void
*/
public function log($level, $message, array $context = []): void
public function log($level, Arrayable|Jsonable|\Stringable|array|string $message, array $context = []): void
{
$this->writeLog($level, $message, $context);
}
Expand All @@ -159,11 +159,11 @@ public function log($level, $message, array $context = []): void
* Dynamically pass log calls into the writer.
*
* @param string $level
* @param string $message
* @param Arrayable|Jsonable|\Stringable|array|string $message
* @param array $context
* @return void
*/
public function write($level, $message, array $context = []): void
public function write($level, Arrayable|Jsonable|\Stringable|array|string $message, array $context = []): void
{
$this->writeLog($level, $message, $context);
}
Expand All @@ -172,11 +172,11 @@ public function write($level, $message, array $context = []): void
* Write a message to the log.
*
* @param string $level
* @param string $message
* @param Arrayable|Jsonable|\Stringable|array|string $message
* @param array $context
* @return void
*/
protected function writeLog($level, $message, $context)
protected function writeLog($level, Arrayable|Jsonable|\Stringable|array|string $message, $context): void
{
$this->logger->{$level}(
$message = $this->formatMessage($message),
Expand Down Expand Up @@ -249,8 +249,8 @@ protected function fireLogEvent($level, $message, array $context = [])
/**
* Format the parameters for the logger.
*
* @param mixed $message
* @return mixed
* @param Arrayable|Jsonable|\Stringable|array|string $message
* @return string
*/
protected function formatMessage($message)
{
Expand All @@ -262,7 +262,7 @@ protected function formatMessage($message)
return var_export($message->toArray(), true);
}

return $message;
return (string) $message;
Copy link
Member Author

@driesvints driesvints Dec 17, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added this because fireLogEvent always expects the $message to be a string. And also because we pipe the message to a decorated psr/log implementation which in turn expects either a string or a Stringable.

}

/**
Expand Down
2 changes: 1 addition & 1 deletion src/Illuminate/Mail/composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"illuminate/macroable": "^9.0",
"illuminate/support": "^9.0",
"league/commonmark": "^2.0.2",
"psr/log": "^1.0|^2.0",
"psr/log": "^2.0|^3.0",
"symfony/mailer": "^6.0",
"tijsverkoyen/css-to-inline-styles": "^2.2.2"
},
Expand Down