librenms/includes/helpers.php
Tony Murray fa16c025ba
Fix popup toast messages (Remove Flasher) (#16090)
* Remove flasher
Just use a bit of custom code to interface with toastr js
This is able to retain our custom theme and work properly

* Fix style issues

* Missed reference rename

* Remove test code :)

* Fix a missed rename

* Fix one more missed reference

* Fix typo
2024-06-05 08:07:42 -05:00

134 lines
3.7 KiB
PHP

<?php
/**
* helpers.php
*
* Functions available in both Laravel and Legacy code (must not call any other legacy functions)
*
* 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 <https://www.gnu.org/licenses/>.
*
* @link https://www.librenms.org
*
* @copyright 2018 Tony Murray
* @author Tony Murray <murraytony@gmail.com>
*/
use LibreNMS\Util\Debug;
use LibreNMS\Util\Laravel;
if (! function_exists('d_echo')) {
/**
* Legacy convenience function - please use this instead of 'if (Debug::isEnabled()) { echo ...; }'
* Use Log directly in pure Laravel code!
*
* @param string|array|float|int $text The error message or array to print
* @param string $no_debug_text Text to print if debug is disabled
*/
function d_echo($text, $no_debug_text = null)
{
if (Laravel::isBooted()) {
\Log::debug(is_string($text) ? rtrim($text) : $text);
} elseif (Debug::isEnabled()) {
print_r($text);
}
if (! Debug::isEnabled() && $no_debug_text) {
echo "$no_debug_text";
}
}
}
if (! function_exists('array_pairs')) {
/**
* Get all consecutive pairs of values in an array.
* [1,2,3,4] -> [[1,2],[2,3],[3,4]]
*
* @param array $array
* @return array
*/
function array_pairs($array)
{
$pairs = [];
for ($i = 1; $i < count($array); $i++) {
$pairs[] = [$array[$i - 1], $array[$i]];
}
return $pairs;
}
}
/**
* Cast string to int or float.
* Returns 0 if string is not numeric
*
* @param string $number
* @return float|int
*/
function cast_number($number)
{
return \LibreNMS\Util\Number::cast($number);
}
if (! function_exists('trans_fb')) {
/**
* Translate the given message with a fallback string if none exists.
*
* @param string $key
* @param string $fallback
* @param array $replace
* @param string $locale
* @return \Symfony\Component\Translation\TranslatorInterface|string
*/
function trans_fb($key, $fallback, $replace = [], $locale = null)
{
return ($key === ($translation = trans($key, $replace, $locale))) ? $fallback : $translation;
}
}
if (! function_exists('preg_match_any')) {
/**
* Check an array of regexes against a subject if any match, return true
*
* @param string $subject the string to match against
* @param array|string $regexes an array of regexes or single regex to check
* @return bool if any of the regexes matched, return true
*/
function preg_match_any($subject, $regexes)
{
foreach ((array) $regexes as $regex) {
if (preg_match($regex, $subject)) {
return true;
}
}
return false;
}
}
if (! function_exists('toast')) {
/**
* send a toastr popup or return ToastInterface
*/
function toast(?string $title = null, ?string $message = null, string $level = 'info', ?array $options = null)
{
$toast = app(\App\Http\Interfaces\ToastInterface::class);
if (! is_null($message)) {
return $toast->message($title, $message, $level, $options);
}
return $toast;
}
}