New generic icon_get() and print_icon() functions

Generates appropriate HTML tag to display a fontawesome icon, including
optional pop-up title and additional CSS classes.

Fixes #27828

core/icon_api.php

@@ -34,6 +34,40 @@
 require_api( 'helper_api.php' );
 require_api( 'utility_api.php' );
 
+/**
+ * Returns HTML to display an icon with optional title pop-up.
+ *
+ * @param string $p_icon    Fontawesome icon name (fa-xxx)
+ * @param string $p_classes Optional additional CSS classes
+ * @param string $p_title   Optional pop-up text
+ *
+ * @return string
+ */
+function icon_get( $p_icon, $p_classes = '', $p_title = '' ) {
+	# Add 'fa-' prefix if missing
+	if( substr( $p_icon, 0, 3 ) != 'fa-' ) {
+		$p_icon = 'fa-' . $p_icon;
+	}
+
+	if( $p_title ) {
+		$p_title = 'title="' . $p_title . '"';
+	}
+
+	/** @noinspection HtmlUnknownAttribute */
+	return sprintf( '<i class="fa %s %s" %s></i>', $p_icon, $p_classes, $p_title );
+}
+
+/**
+ * Prints an icon with optional title pop-up.
+ *
+ * @param string $p_icon    Fontawesome icon name (fa-xxx)
+ * @param string $p_classes Optional additional CSS classes
+ * @param string $p_title   Optional pop-up text
+ */
+function print_icon( $p_icon, $p_classes = '', $p_title = '' ) {
+	echo icon_get( $p_icon, $p_classes, $p_title );
+}
+
 /**
  * gets the status icon
  * @param string $p_icon Icon file name.
@@ -44,7 +78,7 @@ function icon_get_status_icon( $p_icon ) {
 	$t_status_icon_arr = config_get( 'status_icon_arr' );
 	$t_priotext = get_enum_element( 'priority', $p_icon );
 	if( isset( $t_status_icon_arr[$p_icon] ) && !is_blank( $t_status_icon_arr[$p_icon] ) ) {
-		return ' <i class="fa ' . $t_status_icon_arr[$p_icon] . '" title="' . $t_priotext . '"></i>';
+		return icon_get( $t_status_icon_arr[$p_icon], '', $t_priotext );
 	} else {
 		return '&#160;';
 	}
@@ -87,10 +121,8 @@ function print_sort_icon( $p_dir, $p_sort_by, $p_field ) {
 		$t_dir = ASCENDING;
 	}
 
+	echo '&#160;';
 	if( !is_blank( $t_sort_icon_arr[$t_dir] ) ) {
-		echo '&#160;<i class="fa ' . $t_sort_icon_arr[$t_dir] . ' fa-lg blue"></i>';
-	} else {
-		echo '&#160;';
+		echo icon_get( $t_sort_icon_arr[$t_dir], 'fa-lg blue' );
 	}
 }
-