Completed
Push — develop ( b68cde...86f0dd )
by Adam
57s queued 52s
created

Helper::convertToLowercase()   A

Complexity

Conditions 3
Paths 2

Size

Total Lines 13
Code Lines 7

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 9
CRAP Score 3

Importance

Changes 0
Metric Value
dl 0
loc 13
ccs 9
cts 9
cp 1
rs 9.4285
c 0
b 0
f 0
cc 3
eloc 7
nc 2
nop 1
crap 3
1
<?php
2
/**
3
 * Helper class
4
 */
5
namespace IBM\Watson\Common;
6
7
/**
8
 * Helper class
9
 *
10
 * This class defines various static utility functions that are in use
11
 * throughout the SDK
12
 *
13
 */
14
class Helper
15
{
16
    /**
17
     * Convert a string to camelCase. Strings already in camelCase will not be modified
18
     *
19
     * @param string  $string The input string
20
     * @return string The output string
21
     */
22 18
    public static function camelCase($string)
23
    {
24 18
        $string = self::convertToLowercase($string);
25 18
        return preg_replace_callback(
26 18
            '/_([a-z])/',
27 18
            function ($match) {
28 6
                return strtoupper($match[1]);
29 18
            },
30
            $string
31 12
        );
32
    }
33
34
    /**
35
     * Convert strings with underscores to all lowercase
36
     *
37
     * @param string string The input string
38
     * @return string The output string
39
     */
40 18
    protected static function convertToLowercase($string)
41
    {
42 18
        $explodedStr = explode('_', $string);
43
44 18
        if (count($explodedStr) > 1) {
45 6
            foreach ($explodedStr as $value) {
46 6
                $lowercasedStr[] = strtolower($value);
0 ignored issues
show
Coding Style Comprehensibility introduced by
$lowercasedStr was never initialized. Although not strictly required by PHP, it is generally a good practice to add $lowercasedStr = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
47 4
            }
48 6
            $string = implode('_', $lowercasedStr);
0 ignored issues
show
Bug introduced by
The variable $lowercasedStr does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
49 4
        }
50
51 18
        return $string;
52
    }
53
54
    /**
55
     * Initialize an object with the given parameters
56
     *
57
     * @param mixed $target  The object to set parameters on
58
     * @param array $parameters The parameters to set
59
     */
60 42
    public static function initialize($target, $parameters)
61
    {
62 42
        if (is_array($parameters)) {
63 36
            foreach ($parameters as $key => $value) {
64 9
                $method = 'set'.ucfirst(static::camelCase($key));
65 9
                if (method_exists($target, $method)) {
66 9
                    $target->$method($value);
67 6
                }
68 24
            }
69 24
        }
70 42
    }
71
}
72