mirror of
https://github.com/fusionpbx/fusionpbx.git
synced 2026-01-10 10:38:22 +00:00
Documentation, format class, no modification. (#7629)
This commit is contained in:
frytimo
@@ -25,123 +25,144 @@
|
||||
Mark J Crane <markjcrane@fusionpbx.com>
|
||||
*/
|
||||
|
||||
class button {
|
||||
class button {
|
||||
|
||||
public static $collapse = 'hide-md-dn';
|
||||
public static $collapse = 'hide-md-dn';
|
||||
|
||||
public static function create($array) {
|
||||
global $settings;
|
||||
/**
|
||||
* Creates a button element based on the provided array of attributes.
|
||||
*
|
||||
* @param array $array An array containing button attributes, such as type, name, value, id, label, title, onclick,
|
||||
* etc.
|
||||
*
|
||||
* @return string The created button element as a string.
|
||||
*/
|
||||
public static function create($array) {
|
||||
global $settings;
|
||||
|
||||
$button_icons = $settings->get('theme', 'button_icons', 'auto');
|
||||
//parse styles into array
|
||||
if (!empty($array['style'])) {
|
||||
$tmp = explode(';',$array['style']);
|
||||
foreach ($tmp as $style) {
|
||||
if (!empty($style)) {
|
||||
$style = explode(':', $style);
|
||||
if (is_array($style) && @sizeof($style) == 2) {
|
||||
$styles[trim($style[0])] = trim($style[1]);
|
||||
}
|
||||
}
|
||||
}
|
||||
$array['style'] = $styles;
|
||||
unset($styles);
|
||||
}
|
||||
//button: open
|
||||
$button = "<button ";
|
||||
$button .= "type='".(!empty($array['type']) ? $array['type'] : 'button')."' ";
|
||||
$button .= !empty($array['name']) ? "name=".self::quote($array['name'])." " : null;
|
||||
$button .= !empty($array['value']) ? "value=".self::quote($array['value'])." " : null;
|
||||
$button .= !empty($array['id']) ? "id='".$array['id']."' " : null;
|
||||
$button .= !empty($array['label']) ? "alt=".self::quote($array['label'])." " : (!empty($array['title']) ? "alt=".self::quote($array['title'])." " : null);
|
||||
if ($button_icons == 'only' || $button_icons == 'auto' || $array['title']) {
|
||||
if (!empty($array['title']) || !empty($array['label'])) {
|
||||
$button .= "title=".(!empty($array['title']) ? self::quote($array['title']) : self::quote($array['label']))." ";
|
||||
$button_icons = $settings->get('theme', 'button_icons', 'auto');
|
||||
//parse styles into array
|
||||
if (!empty($array['style'])) {
|
||||
$tmp = explode(';', $array['style']);
|
||||
foreach ($tmp as $style) {
|
||||
if (!empty($style)) {
|
||||
$style = explode(':', $style);
|
||||
if (is_array($style) && @sizeof($style) == 2) {
|
||||
$styles[trim($style[0])] = trim($style[1]);
|
||||
}
|
||||
}
|
||||
$button .= !empty($array['onclick']) ? "onclick=".self::quote($array['onclick'])." " : null;
|
||||
$button .= !empty($array['onmouseover']) ? "onmouseenter=".self::quote($array['onmouseover'])." " : null;
|
||||
$button .= !empty($array['onmouseout']) ? "onmouseleave=".self::quote($array['onmouseout'])." " : null;
|
||||
//detect class addition (using + prefix)
|
||||
$button_class = !empty($array['class']) && substr($array['class'],0,1) == '+' ? 'default '.substr($array['class'], 1) : $array['class'] ?? '';
|
||||
$button .= "class='btn btn-".(!empty($button_class) ? $button_class : 'default')." ".(isset($array['disabled']) && $array['disabled'] ? 'disabled' : null)."' ";
|
||||
//ensure margin* styles are not applied to the button element when a link is defined
|
||||
if (!empty($array['style']) && is_array($array['style']) && @sizeof($array['style']) != 0) {
|
||||
$styles = '';
|
||||
foreach ($array['style'] as $property => $value) {
|
||||
if (empty($array['link']) || !substr_count($property, 'margin')) {
|
||||
$styles .= $property.': '.$value.'; ';
|
||||
}
|
||||
}
|
||||
$button .= $styles ? "style=".self::quote($styles)." " : null;
|
||||
unset($styles);
|
||||
}
|
||||
$button .= isset($array['disabled']) && $array['disabled'] ? "disabled='disabled' " : null;
|
||||
$button .= ">";
|
||||
//icon
|
||||
if (!empty($array['icon']) && (
|
||||
$button_icons == 'only' ||
|
||||
$button_icons == 'always' ||
|
||||
$button_icons == 'auto' ||
|
||||
!$array['label']
|
||||
)) {
|
||||
$icon_class = is_array($array['icon']) ? $array['icon']['text'] : $array['icon'];
|
||||
$button .= "<span class='".(substr($icon_class, 0, 3) != 'fa-' ? 'fa-solid fa-' : null).$icon_class." fa-fw'></span>";
|
||||
}
|
||||
//label
|
||||
if (!empty($array['label']) && (
|
||||
$button_icons != 'only' ||
|
||||
!$array['icon'] ||
|
||||
$array['class'] == 'link'
|
||||
)) {
|
||||
if (!empty($array['icon']) && $button_icons != 'always' && $button_icons != 'never' && isset($array['collapse']) && $array['collapse'] !== false) {
|
||||
if ($array['collapse'] != '') {
|
||||
$collapse_class = $array['collapse'];
|
||||
}
|
||||
else if (self::$collapse !== false) {
|
||||
$collapse_class = self::$collapse;
|
||||
}
|
||||
}
|
||||
$pad_class = !empty($array['icon']) ? 'pad' : null;
|
||||
$button .= "<span class='button-label ".($collapse_class ?? '')." ".$pad_class."'>".$array['label']."</span>";
|
||||
}
|
||||
//button: close
|
||||
$button .= "</button>";
|
||||
//link
|
||||
if (!empty($array['link'])) {
|
||||
$anchor = "<a ";
|
||||
$anchor .= "href='" . self::escape_href($array['link']) . "' ";
|
||||
$anchor .= "target='".(!empty($array['target']) ? $array['target'] : '_self')."' ";
|
||||
//ensure only margin* styles are applied to the anchor element
|
||||
if (!empty($array['style']) && is_array($array['style']) && @sizeof($array['style']) != 0) {
|
||||
$styles = '';
|
||||
foreach ($array['style'] as $property => $value) {
|
||||
if (substr_count($property, 'margin')) {
|
||||
$styles .= $property.': '.$value.'; ';
|
||||
}
|
||||
}
|
||||
$anchor .= $styles ? "style=".self::quote($styles)." " : null;
|
||||
unset($styles);
|
||||
}
|
||||
$anchor .= isset($array['disabled']) && $array['disabled'] ? "class='disabled' onclick='return false;' " : null;
|
||||
$anchor .= ">";
|
||||
$button = $anchor.$button."</a>";
|
||||
}
|
||||
return $button;
|
||||
}
|
||||
$array['style'] = $styles;
|
||||
unset($styles);
|
||||
}
|
||||
|
||||
private static function quote($value) {
|
||||
return substr_count($value, "'") ? '"'.$value.'"' : "'".$value."'";
|
||||
//button: open
|
||||
$button = "<button ";
|
||||
$button .= "type='" . (!empty($array['type']) ? $array['type'] : 'button') . "' ";
|
||||
$button .= !empty($array['name']) ? "name=" . self::quote($array['name']) . " " : null;
|
||||
$button .= !empty($array['value']) ? "value=" . self::quote($array['value']) . " " : null;
|
||||
$button .= !empty($array['id']) ? "id='" . $array['id'] . "' " : null;
|
||||
$button .= !empty($array['label']) ? "alt=" . self::quote($array['label']) . " " : (!empty($array['title']) ? "alt=" . self::quote($array['title']) . " " : null);
|
||||
if ($button_icons == 'only' || $button_icons == 'auto' || $array['title']) {
|
||||
if (!empty($array['title']) || !empty($array['label'])) {
|
||||
$button .= "title=" . (!empty($array['title']) ? self::quote($array['title']) : self::quote($array['label'])) . " ";
|
||||
}
|
||||
}
|
||||
|
||||
private static function escape_href(string $url): string {
|
||||
// clear whitespace
|
||||
$url = trim($url);
|
||||
|
||||
return htmlspecialchars($url, ENT_QUOTES, 'UTF-8');
|
||||
$button .= !empty($array['onclick']) ? "onclick=" . self::quote($array['onclick']) . " " : null;
|
||||
$button .= !empty($array['onmouseover']) ? "onmouseenter=" . self::quote($array['onmouseover']) . " " : null;
|
||||
$button .= !empty($array['onmouseout']) ? "onmouseleave=" . self::quote($array['onmouseout']) . " " : null;
|
||||
//detect class addition (using + prefix)
|
||||
$button_class = !empty($array['class']) && substr($array['class'], 0, 1) == '+' ? 'default ' . substr($array['class'], 1) : $array['class'] ?? '';
|
||||
$button .= "class='btn btn-" . (!empty($button_class) ? $button_class : 'default') . " " . (isset($array['disabled']) && $array['disabled'] ? 'disabled' : null) . "' ";
|
||||
//ensure margin* styles are not applied to the button element when a link is defined
|
||||
if (!empty($array['style']) && is_array($array['style']) && @sizeof($array['style']) != 0) {
|
||||
$styles = '';
|
||||
foreach ($array['style'] as $property => $value) {
|
||||
if (empty($array['link']) || !substr_count($property, 'margin')) {
|
||||
$styles .= $property . ': ' . $value . '; ';
|
||||
}
|
||||
}
|
||||
$button .= $styles ? "style=" . self::quote($styles) . " " : null;
|
||||
unset($styles);
|
||||
}
|
||||
$button .= isset($array['disabled']) && $array['disabled'] ? "disabled='disabled' " : null;
|
||||
$button .= ">";
|
||||
//icon
|
||||
if (!empty($array['icon']) && (
|
||||
$button_icons == 'only' ||
|
||||
$button_icons == 'always' ||
|
||||
$button_icons == 'auto' ||
|
||||
!$array['label']
|
||||
)) {
|
||||
$icon_class = is_array($array['icon']) ? $array['icon']['text'] : $array['icon'];
|
||||
$button .= "<span class='" . (substr($icon_class, 0, 3) != 'fa-' ? 'fa-solid fa-' : null) . $icon_class . " fa-fw'></span>";
|
||||
}
|
||||
//label
|
||||
if (!empty($array['label']) && (
|
||||
$button_icons != 'only' ||
|
||||
!$array['icon'] ||
|
||||
$array['class'] == 'link'
|
||||
)) {
|
||||
if (!empty($array['icon']) && $button_icons != 'always' && $button_icons != 'never' && isset($array['collapse']) && $array['collapse'] !== false) {
|
||||
if ($array['collapse'] != '') {
|
||||
$collapse_class = $array['collapse'];
|
||||
} elseif (self::$collapse !== false) {
|
||||
$collapse_class = self::$collapse;
|
||||
}
|
||||
}
|
||||
$pad_class = !empty($array['icon']) ? 'pad' : null;
|
||||
$button .= "<span class='button-label " . ($collapse_class ?? '') . " " . $pad_class . "'>" . $array['label'] . "</span>";
|
||||
}
|
||||
//button: close
|
||||
$button .= "</button>";
|
||||
//link
|
||||
if (!empty($array['link'])) {
|
||||
$anchor = "<a ";
|
||||
$anchor .= "href='" . self::escape_href($array['link']) . "' ";
|
||||
$anchor .= "target='" . (!empty($array['target']) ? $array['target'] : '_self') . "' ";
|
||||
//ensure only margin* styles are applied to the anchor element
|
||||
if (!empty($array['style']) && is_array($array['style']) && @sizeof($array['style']) != 0) {
|
||||
$styles = '';
|
||||
foreach ($array['style'] as $property => $value) {
|
||||
if (substr_count($property, 'margin')) {
|
||||
$styles .= $property . ': ' . $value . '; ';
|
||||
}
|
||||
}
|
||||
$anchor .= $styles ? "style=" . self::quote($styles) . " " : null;
|
||||
unset($styles);
|
||||
}
|
||||
$anchor .= isset($array['disabled']) && $array['disabled'] ? "class='disabled' onclick='return false;' " : null;
|
||||
$anchor .= ">";
|
||||
$button = $anchor . $button . "</a>";
|
||||
}
|
||||
return $button;
|
||||
}
|
||||
|
||||
/**
|
||||
* Quotes a value by surrounding it with single or double quotes based on whether it contains single quotes.
|
||||
*
|
||||
* @param string $value The value to be quoted.
|
||||
*
|
||||
* @return string The quoted value.
|
||||
*/
|
||||
private static function quote($value) {
|
||||
return substr_count($value, "'") ? '"' . $value . '"' : "'" . $value . "'";
|
||||
}
|
||||
|
||||
/**
|
||||
* Escapes a URL by removing leading/trailing whitespace and encoding special characters.
|
||||
*
|
||||
* @param string $url The URL to escape.
|
||||
*
|
||||
* @return string The escaped URL.
|
||||
*/
|
||||
private static function escape_href(string $url): string {
|
||||
// clear whitespace
|
||||
$url = trim($url);
|
||||
|
||||
return htmlspecialchars($url, ENT_QUOTES, 'UTF-8');
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
|
||||
//usage
|
||||
|
||||
Reference in New Issue
Block a user