mirror/processwire
1
0
Fork 0
mirror of https://github.com/processwire/processwire.git synced 2025-08-09 08:17:12 +02:00
Code Issues Releases Wiki Activity

Several improvements to Notices: 1) now you can include separate label and notice text by calling message/warning/error like this: $this->message([ 'Notice label' => 'Notice text' ]); 2) new support for a Notice::allowDuplicate flag which allows duplicate notices to appear when rendered. To use, specify it in the flags argument: $this->message('notice text', 'duplicate'); or $this->message('notice text', Notice::duplicate); 3) improved debugging output when passed object or array values for message text. 4) notice icon can now be specified in the notice flags, if using a flags string, i.e. $this->message('notice text', 'icon-eye-slash'); These can be combined with other flags of course, i.e. $this->message('notice text', 'markdown duplicate icon-home');

Browse Source
This commit is contained in:
Ryan Cramer
2022-12-02 14:07:41 -05:00
parent a8b3c772d9
commit adf43d28df
1 changed files with 125 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

140
wire/core/Notices.php
View File

@@ -13,7 +13,7 @@
* ProcessWire 3.x, Copyright 2022 by Ryan Cramer
* https://processwire.com
*
* @property string $text Text of notice
* @property string|object|array $text Text or value of notice
* @property string $class Class of notice
* @property int $timestamp Unix timestamp of when the notice was generated
* @property int $flags Bitmask using any of the Notice::constants
@@ -65,11 +65,19 @@ abstract class Notice extends WireData {
/**
* Flag indicates the notice is allowed to contain markup and won’t be automatically entity encoded
*
* Note: entity encoding is done by the admin theme at output time, which should detect this flag.
*
* Note: entity encoding is done by the admin theme at output time, which should detect this flag.
*
*/
const allowMarkup = 32;
/**
* Alias of allowMarkup flag
*
* @since 3.0.208
*
*/
const markup = 32;
/**
* Make notice anonymous (not tied to a particular class)
*
@@ -86,6 +94,14 @@ abstract class Notice extends WireData {
*/
const noGroup = 131072;
/**
* Alias of noGroup flag
*
* @since 3.0.208
*
*/
const separate = 131072;
/**
* Ignore notice unless it will be seen by a logged-in user
*
@@ -131,6 +147,32 @@ abstract class Notice extends WireData {
*/
const allowMarkdown = 4194304;
/**
* Alias of allowMarkdown flag
*
* @since 3.0.208
*
*/
const markdown = 4194304;
/**
* Present duplicate notices separately rather than collapsing them to one
*
* String name can be referred to as 'allowDuplicate' or just 'duplicate'
*
* @since 3.0.208
*
*/
const allowDuplicate = 8388608;
/**
* Alias of allowDuplicate flag
*
* @since 3.0.208
*
*/
const duplicate = 8388608;
/**
* Flag integers to flag names
*
@@ -145,6 +187,7 @@ abstract class Notice extends WireData {
self::logOnly => 'logOnly',
self::allowMarkup => 'allowMarkup',
self::allowMarkdown => 'allowMarkdown',
self::allowDuplicate => 'allowDuplicate',
self::anonymous => 'anonymous',
self::noGroup => 'noGroup',
self::login => 'login',
@@ -152,6 +195,20 @@ abstract class Notice extends WireData {
self::superuser => 'superuser',
self::persist => 'persist',
);
/**
* Alternate names to flags
*
* @var int[]
* @since 3.0.208
*
*/
static protected $flagNamesAlt = array(
'duplicate' => self::allowDuplicate,
'markup' => self::allowMarkup,
'markdown' => self::allowMarkdown,
'separate' => self::noGroup,
);
/**
* Create the Notice
@@ -258,7 +315,15 @@ abstract class Notice extends WireData {
if(is_int($name)) return $name;
$name = trim($name);
if(ctype_digit("$name")) return (int) $name;
$flag = array_search(strtolower($name), array_map('strtolower', self::$flagNames));
$name = strtolower($name);
if(isset(self::$flagNamesAlt[$name])) {
return self::$flagNamesAlt[$name];
} else if(strpos($name, 'icon-') === 0) {
$this->icon = substr($name, 5);
$flag = 0;
} else {
$flag = array_search($name, array_map('strtolower', self::$flagNames));
}
return $flag ? $flag : 0;
}
@@ -348,7 +413,16 @@ abstract class Notice extends WireData {
}
public function __toString() {
return (string) $this->text;
$text = $this->text;
if(is_object($text)) {
$value = method_exists($text, '__toString') ? (string) $text : '';
$class = $text->className();
$text = "object:$class";
if($value !== '' && $value !== $class) $text .= "($value)";
} else if(is_array($text)) {
$text = 'array(' . count($text) . ')';
}
return $text;
}
}
@@ -493,8 +567,10 @@ class Notices extends WireArray {
$page = $this->wire()->page;
if(!$page || !$page->template || $page->template->name != 'admin') return false;
}
if($this->isDuplicate($item)) {
if($item->flags & Notice::allowDuplicate) {
// allow it
} else if($this->isDuplicate($item)) {
$item->qty = $item->qty+1;
return false;
}
@@ -516,20 +592,46 @@ class Notices extends WireArray {
*/
protected function formatNotice(Notice $item) {
$text = $item->text;
$label = '';
if(is_array($text)) {
$item->text = "<pre>" . trim(print_r($this->sanitizeArray($text), true)) . "</pre>";
// if text is associative array with 1 item, we consider the
// key to be the notice label and value to be the notice text
if(count($text) === 1) {
$value = reset($text);
$key = key($text);
if(is_string($key)) {
$label = $key;
$text = $value;
$item->text = $text;
if($this->wire()->config->debug) {
$item->class = $label;
$label = '';
}
}
}
}
if(is_object($text) || is_array($text)) {
$text = Debug::toStr($text, array('html' => true));
$item->flags = $item->flags | Notice::allowMarkup;
} else if($text instanceof Wire) {
$item->text = "<pre>" . $this->wire()->sanitizer->entities(print_r($text, true)) . "</pre>";
$item->flags = $item->flags | Notice::allowMarkup;
} else if(is_object($text)) {
$item->text = (string) $text;
}
$item->text = $text;
}
if($item->hasFlag('allowMarkdown')) {
$item->text = $this->wire()->sanitizer->entitiesMarkdown($text, array('allowBrackets' => true));
$item->addFlag('allowMarkup');
$item->removeFlag('allowMarkdown');
}
if($label) {
if($item->hasFlag('allowMarkup')) {
$label = $this->wire()->sanitizer->entities($label);
$item->text = "<strong>$label:</strong> $item->text";
} else {
$item->text = "$label: \n$item->text";
}
}
}
/**
@@ -733,7 +835,15 @@ class Notices extends WireArray {
if(is_array($value)) {
$value = $this->sanitizeArray($value);
} else {
if(is_object($value)) $value = (string) $value;
if(is_object($value)) {
if($value instanceof Wire) {
$value = (string) $value;
$class = wireClassName($value);
if($value !== $class) $value = "object:$class($value)";
} else {
$value = 'object:' . wireClassName($value);
}
}
$value = $sanitizer->entities($value);
}
$key = $sanitizer->entities($key);