Strings::kbdSymbol() - Code Metrics - Inspection of "4 new functions..." - w3l/holt45 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#37)

by w3l

created 2016-01-28 23:12 UTC

Strings::kbdSymbol() C

↳ Parent: Strings

Complexity

Conditions	8
Paths	18

Size

Total Lines	70
Code Lines	50

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	70
rs	6.4909
cc	8
eloc	50
nc	18
nop	2

How to fix Long Method

<?php
/**
 * Strings.php
 */
namespace w3l\Holt45;

/**
 * Handle strings(convert, encode, replace, etc).
 */
trait Strings
{
    /**
     * Obfuscate string (url-safe and somewhat hard to guess).
     *
     * @param string $input The text that should be obfuscated
     * @return string Obfuscated string
     */
    public static function obfuscateString($input)
    {
        return bin2hex(base64_encode(strrev($input)));
    }

    /**
     * Deobfuscate string
     *
     * @param string $input Obfuscated string
     * @return string Deobfuscated string
     */
    public static function deobfuscateString($input)
    {
        return strrev(base64_decode(hex2bin($input)));
    }

    /**
     * Convert <textarea> to [textarea].
     *
     * @param string $html
     * @return string
     */
    public static function textareaEncode($html)
    {
        return preg_replace("/<textarea(.*?)>(.*?)<\/textarea>/is", "[textarea$1]$2[/textarea]", $html);
    }

    /**
     * Convert [textarea] to <textarea>.
     *
     * @param string $html
     * @return string
     */
    public static function textareaDecode($html)
    {
        return preg_replace("/\[textarea(.*?)\](.*?)\[\/textarea\]/is", "<textarea$1>$2</textarea>", $html);
    }

    /**
     * To replace "Hallo [@var] world" with $value.
     *
     * Example:
     * ```php
     * replace_string($string, array("val1" => "foo", "val2" => "bar"))
     * ```
     *
     * @param string $langString String containing placeholder.
     * @param array $dynamicContent key->value array.
     * @return string String with placeholder replaced.
     */
    public static function replaceString($langString, $dynamicContent = array())
    {
        foreach ($dynamicContent as $k => $v) {
            $langString = str_replace("[@".$k."]", $v, $langString);
        }
        return $langString;
    }

    /**
     * Creates rainbow-colored text.
     *
     * @uses Holt45::colorBlend()
     * @uses Holt45::rgbhex()
     *
     * @param string $text Text wanted coloured.
     * @return string String with span-tags with color.
     */
    public static function rainbowText($text)
    {
        $colorsBase = array(
        array(255, 0, 0),
        array(255, 102, 0),
        array(255, 238, 0),
        array(0, 255, 0),
        array(0, 153, 255),
        array(68, 0, 255),
        array(153, 0, 255)
        );

        $colorsBuild = array();

        $strlenText = strlen($text);

        if ($strlenText > 7) {
            while (count($colorsBuild) < $strlenText) {
                for ($i = 0, $size = count($colorsBase); $i < $size; $i++) {

                    $colorsBuild[] = $colorsBase[$i];

                    if (count($colorsBuild) >= $strlenText) {
                        continue 2;
                    }

                    if ($i < count($colorsBase)-1) {

                        $colorsBuild[] = self::colorBlend($colorsBase[$i], $colorsBase[$i+1]);

                        if (count($colorsBuild) >= $strlenText) {
                            continue 2;
                        }
                    }
                }
                $colorsBase = $colorsBuild;
                $colorsBuild = array();
            }
        } elseif ($strlenText <= 7) {
            $colorsBuild = $colorsBase;
        }

        $arrayText = str_split($text);
        $returnText = "";
        for ($i = 0, $size = count($arrayText); $i < $size; $i++) {
            $returnText .= '<span style="color: #'.self::rgbhex($colorsBuild[$i]).';">'.$arrayText[$i].'</span>';
        }
        return $returnText;
    }
    
    /**
     * Get the symbol from a list of keyboard-keys...
     *
     * @used-by Holt45::kbdShortcut()
     *
     * @param string $inputKey Text
     * @param string $inputOperatingSystem default|auto|win|mac|linux
     * @return null|string HTML Entity (decimal)
     */
    public static function kbdSymbol($inputKey, $inputOperatingSystem = "default")
    {
        $inputKey = mb_strtolower($inputKey);
        
        if ($inputOperatingSystem == "auto") {
            
            $inputOperatingSystem = "default";
            
            $getClientOperatingSystem = self::getClientOperatingSystem();

            
            if ($getClientOperatingSystem == "linux" ||
                $getClientOperatingSystem == "mac" ||
                $getClientOperatingSystem == "win") {
                   $inputOperatingSystem = $getClientOperatingSystem;
            }
        }
        
        $arrayConvert = array(
        "return" => "enter",
        "control" => "ctrl",
        "escape" => "esc",
        "caps lock" => "caps-lock",
        "page up" => "page-up",
        "page down" => "page-down",
        "arrow left" => "arrow-left",
        "left" => "arrow-left",
        "arrow up" => "arrow-up",
        "up" => "arrow-up",
        "arrow right" => "arrow-right",
        "right" => "arrow-right",
        "arrow down" => "arrow-down",
        "down" => "arrow-down"
        );
        
        /* Convert input */
        if (array_key_exists($inputKey, $arrayConvert)) {
            $inputKey = $arrayConvert[$inputKey];
        }

        $arrayKeySymbols = array(
        "shift" => array("default" => "&#8679;"),
        "opt" => array("default" => "&#8997;"),
        "enter" => array("default" => "&#9166;", "mac" => "&#8996;"),
        "alt" => array("default" => "&#9095;", "mac" => "&#8997;"),
        "delete" => array("default" => "&#9003;"),
        "ctrl" => array("default" => "&#10034;", "win" => "&#10034;", "linux" => "&#9096;", "mac" => "&#00094;"),
        "esc" => array("default" => "&#9099;"),
        "command" => array("default" => "&#8984;"),
        "tab" => array("default" => "&#8633;", "mac" => "&#8677;"),
        "caps-lock" => array("default" => "&#65;", "mac" => "&#8682;"),
        "page-up" => array("default" => "&#9650;", "mac" => "&#8670;"),
        "page-down" => array("default" => "&#9660;", "mac" => "&#8671;"),
        "arrow-left" => array("default" => "&#8592;"),
        "arrow-up" => array("default" => "&#8593;"),
        "arrow-right" => array("default" => "&#8594;"),
        "arrow-down" => array("default" => "&#8595;"),
        // Sun
        "compose" => array("default" => "&#9092;"),
        "meta" => array("default" => "&#9670")
        );
        
        if (array_key_exists($inputKey, $arrayKeySymbols)) {
            
            return ((array_key_exists($inputOperatingSystem, $arrayKeySymbols[$inputKey])) ?
                                      $arrayKeySymbols[$inputKey][$inputOperatingSystem] :
                                      $arrayKeySymbols[$inputKey]["default"]);
        }
        
        return null;
    }

    /**
     * Show fancy buttons for keyboard-shortcuts.
     *
     * @uses Holt45::kbdSymbol()
     *
     * @param array $inputArrayKeys
     * @param string $inputOperatingSystem
     * @param string $inputKbdClass
     * @param string $inputKbdSymbolClass
     * @param string $inputJoinHtml Glue
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return string String of html
     */
    public static function kbdShortcut($inputArrayKeys,
                                       $inputOperatingSystem = "default",
                                       $inputKbdClass = "holt45-kbd",
                                       $inputKbdSymbolClass = "holt45-kbd__symbol",
                                       $inputJoinGlue = " + ")
    {
        $returnArray = array();

        foreach ($inputArrayKeys as $key) {
            
            $kbdSymbol = self::kbdSymbol($key, $inputOperatingSystem);
            
            $kbdSymbolHtml = "";
            
            if ($kbdSymbol !== null) {
                $kbdSymbolHtml = '<span class="'.$inputKbdSymbolClass.'">'.$kbdSymbol.'</span>';
            }
            
            $returnArray[] = '<kbd class="'.$inputKbdClass.'">'.$kbdSymbolHtml.$key.'</kbd>';
            
        }

        return implode($inputJoinGlue, $returnArray);
    }
}


1			<?php
2			/**
3			* Strings.php
4			*/
5			namespace w3l\Holt45;
6
7			/**
8			* Handle strings(convert, encode, replace, etc).
9			*/
10			trait Strings
11			{
12			/**
13			* Obfuscate string (url-safe and somewhat hard to guess).
14			*
15			* @param string $input The text that should be obfuscated
16			* @return string Obfuscated string
17			*/
18			public static function obfuscateString($input)
19			{
20			return bin2hex(base64_encode(strrev($input)));
21			}
22
23			/**
24			* Deobfuscate string
25			*
26			* @param string $input Obfuscated string
27			* @return string Deobfuscated string
28			*/
29			public static function deobfuscateString($input)
30			{
31			return strrev(base64_decode(hex2bin($input)));
32			}
33
34			/**
35			* Convert <textarea> to [textarea].
36			*
37			* @param string $html
38			* @return string
39			*/
40			public static function textareaEncode($html)
41			{
42			return preg_replace("/<textarea(.?)>(.?)<\/textarea>/is", "[textarea$1]$2[/textarea]", $html);
43			}
44
45			/**
46			* Convert [textarea] to <textarea>.
47			*
48			* @param string $html
49			* @return string
50			*/
51			public static function textareaDecode($html)
52			{
53			return preg_replace("/\[textarea(.?)\](.?)\[\/textarea\]/is", "<textarea$1>$2</textarea>", $html);
54			}
55
56			/**
57			* To replace "Hallo [@var] world" with $value.
58			*
59			* Example:
60			* ```php
61			* replace_string($string, array("val1" => "foo", "val2" => "bar"))
62			* ```
63			*
64			* @param string $langString String containing placeholder.
65			* @param array $dynamicContent key->value array.
66			* @return string String with placeholder replaced.
67			*/
68			public static function replaceString($langString, $dynamicContent = array())
69			{
70			foreach ($dynamicContent as $k => $v) {
71			$langString = str_replace("[@".$k."]", $v, $langString);
72			}
73			return $langString;
74			}
75
76			/**
77			* Creates rainbow-colored text.
78			*
79			* @uses Holt45::colorBlend()
80			* @uses Holt45::rgbhex()
81			*
82			* @param string $text Text wanted coloured.
83			* @return string String with span-tags with color.
84			*/
85			public static function rainbowText($text)
86			{
87			$colorsBase = array(
88			array(255, 0, 0),
89			array(255, 102, 0),
90			array(255, 238, 0),
91			array(0, 255, 0),
92			array(0, 153, 255),
93			array(68, 0, 255),
94			array(153, 0, 255)
95			);
96
97			$colorsBuild = array();
98
99			$strlenText = strlen($text);
100
101			if ($strlenText > 7) {
102			while (count($colorsBuild) < $strlenText) {
103			for ($i = 0, $size = count($colorsBase); $i < $size; $i++) {
104
105			$colorsBuild[] = $colorsBase[$i];
106
107			if (count($colorsBuild) >= $strlenText) {
108			continue 2;
109			}
110
111			if ($i < count($colorsBase)-1) {
112
113			$colorsBuild[] = self::colorBlend($colorsBase[$i], $colorsBase[$i+1]);
114
115			if (count($colorsBuild) >= $strlenText) {
116			continue 2;
117			}
118			}
119			}
120			$colorsBase = $colorsBuild;
121			$colorsBuild = array();
122			}
123			} elseif ($strlenText <= 7) {
124			$colorsBuild = $colorsBase;
125			}
126
127			$arrayText = str_split($text);
128			$returnText = "";
129			for ($i = 0, $size = count($arrayText); $i < $size; $i++) {
130			$returnText .= '<span style="color: #'.self::rgbhex($colorsBuild[$i]).';">'.$arrayText[$i].'</span>';
131			}
132			return $returnText;
133			}
134
135			/**
136			* Get the symbol from a list of keyboard-keys...
137			*
138			* @used-by Holt45::kbdShortcut()
139			*
140			* @param string $inputKey Text
141			* @param string $inputOperatingSystem default\|auto\|win\|mac\|linux
142			* @return null\|string HTML Entity (decimal)
143			*/
144			public static function kbdSymbol($inputKey, $inputOperatingSystem = "default")
145			{
146			$inputKey = mb_strtolower($inputKey);
147
148			if ($inputOperatingSystem == "auto") {
149
150			$inputOperatingSystem = "default";
151
152			$getClientOperatingSystem = self::getClientOperatingSystem();
			0 ignored issues – show Comprehensibility Naming introduced 2016-01-28 22:57 UTC by Report Bug Copy Issue Report The variable name `$getClientOperatingSystem` exceeds the maximum configured length of `20`. Very long variable names usually make code harder to read. It is therefore recommended not to make variable names too verbose. Loading history...
153
154			if ($getClientOperatingSystem == "linux" \|\|
155			$getClientOperatingSystem == "mac" \|\|
156			$getClientOperatingSystem == "win") {
157			$inputOperatingSystem = $getClientOperatingSystem;
158			}
159			}
160
161			$arrayConvert = array(
162			"return" => "enter",
163			"control" => "ctrl",
164			"escape" => "esc",
165			"caps lock" => "caps-lock",
166			"page up" => "page-up",
167			"page down" => "page-down",
168			"arrow left" => "arrow-left",
169			"left" => "arrow-left",
170			"arrow up" => "arrow-up",
171			"up" => "arrow-up",
172			"arrow right" => "arrow-right",
173			"right" => "arrow-right",
174			"arrow down" => "arrow-down",
175			"down" => "arrow-down"
176			);
177
178			/* Convert input */
179			if (array_key_exists($inputKey, $arrayConvert)) {
180			$inputKey = $arrayConvert[$inputKey];
181			}
182
183			$arrayKeySymbols = array(
184			"shift" => array("default" => "⇧"),
185			"opt" => array("default" => "⌥"),
186			"enter" => array("default" => "⏎", "mac" => "⌤"),
187			"alt" => array("default" => "⎇", "mac" => "⌥"),
188			"delete" => array("default" => "⌫"),
189			"ctrl" => array("default" => "✲", "win" => "✲", "linux" => "⎈", "mac" => "^"),
190			"esc" => array("default" => "⎋"),
191			"command" => array("default" => "⌘"),
192			"tab" => array("default" => "↹", "mac" => "⇥"),
193			"caps-lock" => array("default" => "A", "mac" => "⇪"),
194			"page-up" => array("default" => "▲", "mac" => "⇞"),
195			"page-down" => array("default" => "▼", "mac" => "⇟"),
196			"arrow-left" => array("default" => "←"),
197			"arrow-up" => array("default" => "↑"),
198			"arrow-right" => array("default" => "→"),
199			"arrow-down" => array("default" => "↓"),
200			// Sun
201			"compose" => array("default" => "⎄"),
202			"meta" => array("default" => "&#9670")
203			);
204
205			if (array_key_exists($inputKey, $arrayKeySymbols)) {
206
207			return ((array_key_exists($inputOperatingSystem, $arrayKeySymbols[$inputKey])) ?
208			$arrayKeySymbols[$inputKey][$inputOperatingSystem] :
209			$arrayKeySymbols[$inputKey]["default"]);
210			}
211
212			return null;
213			}
214
215			/**
216			* Show fancy buttons for keyboard-shortcuts.
217			*
218			* @uses Holt45::kbdSymbol()
219			*
220			* @param array $inputArrayKeys
221			* @param string $inputOperatingSystem
222			* @param string $inputKbdClass
223			* @param string $inputKbdSymbolClass
224			* @param string $inputJoinHtml Glue
			0 ignored issues – show Bug introduced 2016-01-28 22:57 UTC by Report Bug Copy Issue Report There is no parameter named `$inputJoinHtml`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
225			* @return string String of html
226			*/
227			public static function kbdShortcut($inputArrayKeys,
228			$inputOperatingSystem = "default",
229			$inputKbdClass = "holt45-kbd",
230			$inputKbdSymbolClass = "holt45-kbd__symbol",
231			$inputJoinGlue = " + ")
232			{
233			$returnArray = array();
234
235			foreach ($inputArrayKeys as $key) {
236
237			$kbdSymbol = self::kbdSymbol($key, $inputOperatingSystem);
238
239			$kbdSymbolHtml = "";
240
241			if ($kbdSymbol !== null) {
242			$kbdSymbolHtml = '<span class="'.$inputKbdSymbolClass.'">'.$kbdSymbol.'</span>';
243			}
244
245			$returnArray[] = '<kbd class="'.$inputKbdClass.'">'.$kbdSymbolHtml.$key.'</kbd>';
246
247			}
248
249			return implode($inputJoinGlue, $returnArray);
250			}
251			}
252

w3l / holt45

GitHub Access Token became invalid

Pull Request — master (#37)

Strings::kbdSymbol() C

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like