1
|
|
|
<?php |
2
|
|
|
/** |
3
|
|
|
* @package A simple ORM that performs basic CRUD operations |
4
|
|
|
* @author Surajudeen AKANDE <[email protected]> |
5
|
|
|
* @license MIT <https://opensource.org/licenses/MIT> |
6
|
|
|
* @link http://www.github.com/andela-sakande |
7
|
|
|
* */ |
8
|
|
|
namespace Sirolad\Libraries; |
9
|
|
|
|
10
|
|
|
use Sirolad\Exception; |
11
|
|
|
use Sirolad\Interfaces\FormatterInterface; |
12
|
|
|
|
13
|
|
|
/** |
14
|
|
|
* This class pluralizes, tokenize, make placeholders and associative array for the main class (Potato). |
15
|
|
|
* */ |
16
|
|
|
class Formatter implements FormatterInterface |
17
|
|
|
{ |
18
|
|
|
/** |
19
|
|
|
* Pluralizes or singularizes inputs |
20
|
|
|
* @param string $str |
21
|
|
|
* @return string $str |
22
|
|
|
* */ |
23
|
|
|
public static function addOrRemoveS($str) |
24
|
|
|
{ |
25
|
|
|
$tableNameAsArray = str_split($str); |
26
|
|
|
|
27
|
|
|
if ($tableNameAsArray[count($tableNameAsArray) - 1] === 's') { |
28
|
|
|
array_pop($tableNameAsArray); |
29
|
|
|
$str = implode($tableNameAsArray); |
30
|
|
|
} else { |
31
|
|
|
$str .= 's'; |
32
|
|
|
} |
33
|
|
|
|
34
|
|
|
return $str; |
35
|
|
|
} |
36
|
|
|
|
37
|
|
|
/** |
38
|
|
|
* Break down a delimited statement into set of string separated by comma |
39
|
|
|
* |
40
|
|
|
* @param string $str Statement to be broken down |
41
|
|
|
* @param string $delimiter Character being searched for to bring about the break down |
42
|
|
|
* @return string Comma-separated set of string |
43
|
|
|
*/ |
44
|
|
|
public static function tokenize($str, $delimiter) |
45
|
|
|
{ |
46
|
|
|
$output = ''; |
47
|
|
|
$token = strtok($str, $delimiter); |
48
|
|
|
$output .= $token; |
49
|
|
|
|
50
|
|
|
while ($token) { |
51
|
|
|
$token = strtok($delimiter); |
52
|
|
|
$output .= ',' .$token; |
53
|
|
|
} |
54
|
|
|
|
55
|
|
|
return rtrim($output, ','); |
56
|
|
|
} |
57
|
|
|
|
58
|
|
|
/** |
59
|
|
|
* Generate unnamed placeholders depending on the number of table fields concerned |
60
|
|
|
* |
61
|
|
|
* @param array $record Set of affected table fields |
|
|
|
|
62
|
|
|
* @return array $placeholder Sql statement placeholders for field values |
63
|
|
|
*/ |
64
|
|
|
public static function generateUnnamedPlaceholders(array $records) |
65
|
|
|
{ |
66
|
|
|
$placeholder = []; |
67
|
|
|
|
68
|
|
|
foreach ($records as $record) { |
69
|
|
|
array_push($placeholder, '?'); |
70
|
|
|
} |
71
|
|
|
|
72
|
|
|
return $placeholder; |
73
|
|
|
} |
74
|
|
|
|
75
|
|
|
/** |
76
|
|
|
* Create an array of elements in the format 'array_key=array_value' of the argument array supplied |
77
|
|
|
* |
78
|
|
|
* @param array $record Associative type of array |
79
|
|
|
* @return array $temp New array of elements in the format 'array_key=array_value' of the argument array supplied |
80
|
|
|
*/ |
81
|
|
|
public static function makeAssociativeArray(array $record) |
82
|
|
|
{ |
83
|
|
|
$temp = []; |
84
|
|
|
for ($i = 1; $i < count($record); $i++) { |
|
|
|
|
85
|
|
|
$value = array_values($record)[$i]; |
86
|
|
|
|
87
|
|
|
if (is_null($value)) { |
88
|
|
|
$value = 'NULL'; |
89
|
|
|
} else { |
90
|
|
|
$value = '"' . $value . '"'; |
91
|
|
|
} |
92
|
|
|
|
93
|
|
|
array_push($temp, array_keys($record)[$i] . '=' . $value); |
94
|
|
|
} |
95
|
|
|
return $temp; |
96
|
|
|
} |
97
|
|
|
} |
98
|
|
|
|
This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit.
Consider the following example. The parameter
$ireland
is not defined by the methodfinale(...)
.The most likely cause is that the parameter was changed, but the annotation was not.