mirror/processwire
1
0
Fork 0
mirror of https://github.com/processwire/processwire.git synced 2025-08-25 23:56:41 +02:00
Code Issues Releases Wiki Activity

Add WireLog option for specifying which user should be recorded with the log entry (if different from current user).

Browse Source
This commit is contained in:
Ryan Cramer
2018-05-18 09:21:13 -04:00
parent 7b2692f0cd
commit aa34db127e
2 changed files with 14 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
wire/core/Wire.php
View File

@@ -1476,8 +1476,9 @@ abstract class Wire implements WireTranslatable, WireFuelable, WireTrackable {
* *
* @param string $str Text to log, or omit to return the `$log` API variable. * @param string $str Text to log, or omit to return the `$log` API variable.
* @param array $options Optional extras to include: * @param array $options Optional extras to include:
* - `url` (string): URL to record the with the log entry (default=auto-detect) * - `url` (string): URL to record the with the log entry (default=auto-detect)
* - `name` (string): Name of log to use (default=auto-detect) * - `name` (string): Name of log to use (default=auto-detect)
* - `user` (User|string|null): User instance, user name, or null to log for current User. (default=null)
* @return WireLog * @return WireLog
* *
*/ */

13
wire/core/WireLog.php
View File

@@ -95,6 +95,7 @@ class WireLog extends Wire {
* @param array $options Options to modify default behavior: * @param array $options Options to modify default behavior:
* - `showUser` (bool): Include the username in the log entry? (default=true) * - `showUser` (bool): Include the username in the log entry? (default=true)
* - `showURL` (bool): Include the current URL in the log entry? (default=true) * - `showURL` (bool): Include the current URL in the log entry? (default=true)
* - `user` (User|string|null): User instance, user name, or null to use current User. (default=null)
* - `url` (bool): URL to record with the log entry (default=auto determine) * - `url` (bool): URL to record with the log entry (default=auto determine)
* - `delimiter` (string): Log entry delimiter (default="\t" aka tab) * - `delimiter` (string): Log entry delimiter (default="\t" aka tab)
* @return bool Whether it was written or not (generally always going to be true) * @return bool Whether it was written or not (generally always going to be true)
@@ -106,6 +107,7 @@ class WireLog extends Wire {
$defaults = array( $defaults = array(
'showUser' => true, 'showUser' => true,
'showURL' => true, 'showURL' => true,
'user' => null,
'url' => '', // URL to show (default=blank, auto-detect) 'url' => '', // URL to show (default=blank, auto-detect)
'delimiter' => "\t", 'delimiter' => "\t",
); );
@@ -141,8 +143,15 @@ class WireLog extends Wire {
} }
if($options['showUser']) { if($options['showUser']) {
$user = $this->wire('user'); $user = !empty($options['user']) ? $options['user'] : $this->wire('user');
$text = ($user && $user->id ? $user->name : "?") . "$options[delimiter]$text"; $userName = '';
if($user instanceof Page) {
$userName = $user->id ? $user->name : '?';
} else if(is_string($user)) {
$userName = $user;
}
if(empty($userName)) $userName = '?';
$text = "$userName$options[delimiter]$text";
} }
return $log->save($text); return $log->save($text);