replace remaining niftyString() occurrences
authorDenis Ovsienko <denis@ovsienko.info>
Wed, 14 Nov 2018 10:37:52 +0000 (10:37 +0000)
committerDenis Ovsienko <denis@ovsienko.info>
Wed, 14 Nov 2018 10:38:27 +0000 (10:38 +0000)
This seems to be the last commit in the series, the previous one was
commit a0bdf6d.

* formatVLANAsLabel()
* formatVLANAsPlainText()
* formatVLANAsShortLink()
* formatPatchCableHeapAsPlainText()
* dynamic_title_decoder_throwing()

[skip ci]

wwwroot/inc/functions.php
wwwroot/inc/interface-lib.php
wwwroot/inc/interface.php

index 10b6343..e3f78dc 100644 (file)
@@ -3573,7 +3573,7 @@ function formatVLANAsLabel ($vlaninfo)
 {
        $ret = $vlaninfo['vlan_id'];
        if ($vlaninfo['vlan_descr'] != '')
-               $ret .= ' <i>(' . niftyString ($vlaninfo['vlan_descr']) . ')</i>';
+               $ret .= ' <i>(' . stringForLabel ($vlaninfo['vlan_descr']) . ')</i>';
        return $ret;
 }
 
@@ -3581,7 +3581,7 @@ function formatVLANAsPlainText ($vlaninfo)
 {
        $ret = 'VLAN' . $vlaninfo['vlan_id'];
        if ($vlaninfo['vlan_descr'] != '')
-               $ret .= ' (' . niftyString ($vlaninfo['vlan_descr'], 20, FALSE) . ')';
+               $ret .= ' (' . stringForLabel ($vlaninfo['vlan_descr'], 20) . ')';
        return $ret;
 }
 
@@ -3602,9 +3602,9 @@ function formatVLANAsShortLink ($vlaninfo)
 function formatVLANAsRichText ($vlaninfo)
 {
        $ret = 'VLAN' . $vlaninfo['vlan_id'];
-       $ret .= ' @' . niftyString ($vlaninfo['domain_descr']);
+       $ret .= ' @' . stringForLabel ($vlaninfo['domain_descr']);
        if ($vlaninfo['vlan_descr'] != '')
-               $ret .= ' <i>(' . niftyString ($vlaninfo['vlan_descr']) . ')</i>';
+               $ret .= ' <i>(' . stringForLabel ($vlaninfo['vlan_descr']) . ')</i>';
        return $ret;
 }
 
@@ -6633,7 +6633,7 @@ function formatPatchCableHeapAsPlainText ($heap)
        $text = "${heap['amount']} pcs: [${heap['end1_connector']}] ${heap['pctype']} [${heap['end2_connector']}]";
        if ($heap['description'] != '')
                $text .=  " (${heap['description']})";
-       return niftyString ($text, 512, FALSE);
+       return stringForOption ($text, 512);
 }
 
 // takes a list of structures and the field name in those structures.
index 03f4c00..eede563 100644 (file)
@@ -1054,11 +1054,8 @@ function makeFileDownloadButton ($file_id, $imgname = 'download')
        return "<a href='${href}'>${img}</a>";
 }
 
-// XXX: in new code please use one of the stringFor... functions below
-//
-// This is a dual-purpose formating function:
-// 1. Replace empty strings with nbsp.
-// 2. Cut strings that are too long: append "cut here" indicator and provide a mouse hint.
+// This function is DEPRECATED and will be removed in version 0.22.0.
+// Instead of it please use one of the stringFor...() functions below.
 function niftyString ($string, $maxlen = 30, $usetags = TRUE)
 {
        $cutind = '&hellip;'; // length is 1
index 0280aa4..f7a8e20 100644 (file)
@@ -5551,14 +5551,14 @@ function dynamic_title_decoder_throwing ($path_position)
                $file = spotEntity ('file', genericAssertion ('file_id', 'natural'));
                return array
                (
-                       'name' => niftyString ($file['name'], 30, FALSE),
+                       'name' => stringForOption ($file['name'], 30),
                        'params' => array ('file_id' => $_REQUEST['file_id'])
                );
        case 'ipaddress':
                $address = getIPAddress (ip_parse ($_REQUEST['ip']));
                return array
                (
-                       'name' => niftyString ($address['ip'] . ($address['name'] != '' ? ' (' . $address['name'] . ')' : ''), 50, FALSE),
+                       'name' => stringForOption ($address['ip'] . ($address['name'] != '' ? ' (' . $address['name'] . ')' : ''), 50),
                        'params' => array ('ip' => $address['ip'])
                );
        case 'ipv4net':
@@ -5628,7 +5628,7 @@ function dynamic_title_decoder_throwing ($path_position)
                        throw new EntityNotFoundException ('VLAN domain', $vdom_id);
                return array
                (
-                       'name' => "domain '" . niftyString ($vdlist[$vdom_id], 40, FALSE) . "'",
+                       'name' => "domain '" . stringForOption ($vdlist[$vdom_id], 40) . "'",
                        'params' => array ('vdom_id' => $vdom_id)
                );
        case 'vlan':
@@ -5641,7 +5641,7 @@ function dynamic_title_decoder_throwing ($path_position)
                $vst = spotEntity ('vst', $sic['vst_id']);
                return array
                (
-                       'name' => "template '" . niftyString ($vst['description'], 40, FALSE) . "'",
+                       'name' => "template '" . stringForOption ($vst['description'], 40) . "'",
                        'params' => array ('vst_id' => $sic['vst_id'])
                );
        case 'dqueue':