mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
2c77edf4d2
* Better handling of some alerting errors * Better error output * Consolidate simple template parsing * Fixes reported by phpstan (one was a bug, yay!) * add back forgotten trim * don't remove the template if there is no match * Match previous behavior, which was inconsistent. * use anonymous class for tests instead * Oopsie, Stringable is PHP8+ * fix style
114 lines
2.9 KiB
PHP
114 lines
2.9 KiB
PHP
<?php
|
|
/*
|
|
* SimpleTemplate.php
|
|
*
|
|
* Simple variable substitution template
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
* @package LibreNMS
|
|
* @link http://librenms.org
|
|
* @copyright 2021 Tony Murray
|
|
* @author Tony Murray <murraytony@gmail.com>
|
|
*/
|
|
|
|
namespace App\View;
|
|
|
|
use LibreNMS\Util\StringHelpers;
|
|
|
|
class SimpleTemplate
|
|
{
|
|
/**
|
|
* @var string
|
|
*/
|
|
private $template;
|
|
/**
|
|
* @var array
|
|
*/
|
|
private $variables;
|
|
/**
|
|
* @var string
|
|
*/
|
|
private $regex = '/{{ \$?([a-zA-Z0-9\-_.:]+) }}/';
|
|
/**
|
|
* @var callable
|
|
*/
|
|
private $callback;
|
|
/**
|
|
* @var bool
|
|
*/
|
|
private $keepEmpty = false;
|
|
|
|
public function __construct(string $template, array $variables = [])
|
|
{
|
|
$this->template = $template;
|
|
$this->variables = $variables;
|
|
}
|
|
|
|
/**
|
|
* By default, unmatched templates will be removed from the output, set this to keep them
|
|
*/
|
|
public function keepEmptyTemplates(): SimpleTemplate
|
|
{
|
|
$this->keepEmpty = true;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Add a variable to the set of possible substitutions
|
|
*/
|
|
public function setVariable(string $key, string $value): SimpleTemplate
|
|
{
|
|
$this->variables[$key] = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Instead of using the given variables to replace {{ var }}
|
|
* send the matched variable to this callback, which will return a string to replace it
|
|
*/
|
|
public function replaceWith(callable $callback): SimpleTemplate
|
|
{
|
|
$this->callback = $callback;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Create and parse a simple template
|
|
*
|
|
* @param string $template
|
|
* @param array $variables
|
|
* @return string
|
|
*/
|
|
public static function parse(string $template, array $variables): string
|
|
{
|
|
return (string) new static($template, $variables);
|
|
}
|
|
|
|
public function __toString()
|
|
{
|
|
return preg_replace_callback($this->regex, $this->callback ?? function ($matches) {
|
|
$replacement = $this->variables[$matches[1]] ?? ($this->keepEmpty ? $matches[0] : '');
|
|
if (! StringHelpers::isStringable($replacement)) {
|
|
return '';
|
|
}
|
|
|
|
return $replacement;
|
|
}, $this->template);
|
|
}
|
|
}
|