Issues (11)

Security Analysis    no request data  

This project does not seem to handle request data directly as such no vulnerable execution paths were found.

  Cross-Site Scripting
Cross-Site Scripting enables an attacker to inject code into the response of a web-request that is viewed by other users. It can for example be used to bypass access controls, or even to take over other users' accounts.
  File Exposure
File Exposure allows an attacker to gain access to local files that he should not be able to access. These files can for example include database credentials, or other configuration files.
  File Manipulation
File Manipulation enables an attacker to write custom data to files. This potentially leads to injection of arbitrary code on the server.
  Object Injection
Object Injection enables an attacker to inject an object into PHP code, and can lead to arbitrary code execution, file exposure, or file manipulation attacks.
  Code Injection
Code Injection enables an attacker to execute arbitrary code on the server.
  Response Splitting
Response Splitting can be used to send arbitrary responses.
  File Inclusion
File Inclusion enables an attacker to inject custom files into PHP's file loading mechanism, either explicitly passed to include, or for example via PHP's auto-loading mechanism.
  Command Injection
Command Injection enables an attacker to inject a shell command that is execute with the privileges of the web-server. This can be used to expose sensitive data, or gain access of your server.
  SQL Injection
SQL Injection enables an attacker to execute arbitrary SQL code on your database server gaining access to user data, or manipulating user data.
  XPath Injection
XPath Injection enables an attacker to modify the parts of XML document that are read. If that XML document is for example used for authentication, this can lead to further vulnerabilities similar to SQL Injection.
  LDAP Injection
LDAP Injection enables an attacker to inject LDAP statements potentially granting permission to run unauthorized queries, or modify content inside the LDAP tree.
  Header Injection
  Other Vulnerability
This category comprises other attack vectors such as manipulating the PHP runtime, loading custom extensions, freezing the runtime, or similar.
  Regex Injection
Regex Injection enables an attacker to execute arbitrary code in your PHP process.
  XML Injection
XML Injection enables an attacker to read files on your local filesystem including configuration files, or can be abused to freeze your web-server process.
  Variable Injection
Variable Injection enables an attacker to overwrite program variables with custom data, and can lead to further vulnerabilities.
Unfortunately, the security analysis is currently not available for your project. If you are a non-commercial open-source project, please contact support to gain access.

src/Argument/Argument.php (1 issue)

assigning incompatible types to properties.

Bug Documentation Major

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

1
<?php
2
3
namespace League\CLImate\Argument;
4
5
use League\CLImate\Exceptions\UnexpectedValueException;
6
use function is_array;
7
8
class Argument
9
{
10
    /**
11
     * An argument's name.
12
     *
13
     * Use this name when internally referring to the argument.
14
     *
15
     * @var string
16
     */
17
    protected $name;
18
19
    /**
20
     * An argument's short representation.
21
     *
22
     * @var string
23
     */
24
    protected $prefix;
25
26
    /**
27
     * An argument's long representation.
28
     *
29
     * @var string
30
     */
31
    protected $longPrefix;
32
33
    /**
34
     * An argument's description.
35
     *
36
     * @var string
37
     */
38
    protected $description;
39
40
    /**
41
     * Whether or not an argument is required.
42
     *
43
     * @var bool
44
     */
45
    protected $required = false;
46
47
    /**
48
     * Whether or not an argument only needs to be defined to have a value.
49
     *
50
     * These arguments have the value true when they are defined on the command
51
     * line.
52
     *
53
     * @var bool
54
     */
55
    protected $noValue = false;
56
57
    /**
58
     * Which data type to cast an argument's value to.
59
     *
60
     * Valid data types are "string", "int", "float", and "bool".
61
     *
62
     * @var string
63
     */
64
    protected $castTo = 'string';
65
66
    /**
67
     * An argument's default value.
68
     *
69
     * @var string
70
     */
71
    protected $defaultValue = [];
72
73
    /**
74
     * An argument's value, after type casting.
75
     *
76
     * @var string[]|int[]|float[]|bool[]
77
     */
78
    protected $values = [];
79
80
    /**
81
     * Build a new command argument.
82 48
     *
83
     * @param string $name
84 48
     */
85 48
    public function __construct($name)
86
    {
87
        $this->setName($name);
88
    }
89
90
    /**
91
     * Build a new command argument from an array.
92
     *
93
     * @param string $name
94
     * @param array $params
95 48
     *
96
     * @return Argument
97 48
     */
98 48
    public static function createFromArray($name, array $params)
99
    {
100 48
        $argument = new Argument($name);
101 48
        $params   = self::getSettableArgumentParams($params);
102 48
103 44
        foreach ($params as $key => $value) {
104
            $method = 'set' . ucwords($key);
105 44
            $argument->{$method}($value);
106 8
        }
107 8
108
        return $argument;
109 44
    }
110
111
    /**
112
     * Get argument params based on settable properties
113
     *
114
     * @param array $params
115
     *
116
     * @return array
117
     */
118
    protected static function getSettableArgumentParams(array $params)
119 48
    {
120
        $allowed = [
121
                    'prefix',
122 48
                    'longPrefix',
123 48
                    'description',
124 48
                    'required',
125 48
                    'noValue',
126 48
                    'castTo',
127 48
                    'defaultValue',
128 48
                ];
129 48
130
        return array_intersect_key($params, array_flip($allowed));
131 48
    }
132
133
    /**
134
     * Retrieve an argument's name.
135
     *
136
     * Use this name when internally referring to the argument.
137
     *
138
     * @return string
139
     */
140
    public function name()
141 24
    {
142
        return $this->name;
143 24
    }
144
145
    /**
146
     * Set an argument's name.
147
     *
148
     * Use this name when internally referring to the argument.
149
     *
150
     * @param string $name
151
     */
152
    protected function setName($name)
153 48
    {
154
        $this->name = trim($name);
155 48
    }
156 48
157
    /**
158
     * Retrieve an argument's short form.
159
     *
160
     * @return string
161
     */
162
    public function prefix()
163 24
    {
164
        return $this->prefix;
165 24
    }
166
167
    /**
168
     * Set an argument's short form.
169
     *
170
     * @param string $prefix
171
     */
172
    protected function setPrefix($prefix)
173 20
    {
174
        $this->prefix = trim($prefix);
175 20
    }
176 20
177
    /**
178
     * Retrieve an argument's long form.
179
     *
180
     * @return string
181
     */
182
    public function longPrefix()
183 24
    {
184
        return $this->longPrefix;
185 24
    }
186
187
    /**
188
     * Set an argument's short form.
189
     *
190
     * @param string $longPrefix
191
     */
192
    protected function setLongPrefix($longPrefix)
193 20
    {
194
        $this->longPrefix = trim($longPrefix);
195 20
    }
196 20
197
    /**
198
     * Determine if an argument has a prefix.
199
     *
200
     * @return bool
201
     */
202
    public function hasPrefix()
203 20
    {
204
        return $this->prefix() || $this->longPrefix();
205 20
    }
206
207
    /**
208
     * Retrieve an argument's description.
209
     *
210
     * @return string
211
     */
212
    public function description()
213 4
    {
214
        return $this->description;
215 4
    }
216
217
    /**
218
     * Set an argument's description.
219
     *
220
     * @param string $description
221
     */
222
    protected function setDescription($description)
223 4
    {
224
        $this->description = trim($description);
225 4
    }
226 4
227
    /**
228
     * Determine whether or not an argument is required.
229
     *
230
     * @return bool
231
     */
232
    public function isRequired()
233 20
    {
234
        return $this->required;
235 20
    }
236
237
    /**
238
     * Set whether an argument is required or not.
239
     *
240
     * @param bool $required
241
     */
242
    protected function setRequired($required)
243 8
    {
244
        $this->required = (bool) $required;
245 8
    }
246 8
247
    /**
248
     * Determine whether or not an argument only needs to be defined to have a
249
     * value.
250
     *
251
     * @return bool
252
     */
253
    public function noValue()
254 40
    {
255
        return $this->noValue;
256 40
    }
257
258
    /**
259
     * Set whether or not an argument only needs to be defined to have a value.
260
     *
261
     * @param bool $noValue
262
     */
263
    protected function setNoValue($noValue)
264 12
    {
265
        $this->setCastTo('bool');
266 12
        $this->noValue = (bool) $noValue;
267 12
    }
268 12
269
    /**
270
     * Retrieve the data type to cast an argument's value to.
271
     *
272
     * @return string
273
     */
274
    public function castTo()
275 4
    {
276
        return $this->castTo;
277 4
    }
278
279
    /**
280
     * Set the data type to cast an argument's value to.
281
     *
282
     * Valid data types are "string", "int", "float", and "bool".
283
     *
284
     * @param string $castTo
285
     *
286
     * @return void
287
     * @throws UnexpectedValueException if $castTo is not a valid data type.
288 32
     */
289
    protected function setCastTo($castTo)
290 32
    {
291 4
        if (!in_array($castTo, ['string', 'int', 'float', 'bool'])) {
292
            throw new UnexpectedValueException(
293
                "An argument may only be cast to the data type "
294 4
                . "'string', 'int', 'float', or 'bool'."
295
            );
296
        }
297 28
298 28
        $this->castTo = $this->noValue() ? 'bool' : $castTo;
299
    }
300
301
    /**
302
     * Retrieve an argument's default values.
303
     *
304
     * @return string
305 44
     */
306
    public function defaultValue()
307 44
    {
308
        return $this->defaultValue;
309
    }
310
311
    /**
312
     * Set an argument's default value.
313
     *
314
     * @param string $defaultValue
315 8
     */
316
    public function setDefaultValue($defaultValue)
317 8
    {
318 8
        if (!is_array($defaultValue)) {
319
            $defaultValue = [$defaultValue];
320
        }
321
        $this->defaultValue = $defaultValue;
0 ignored issues
show
Documentation Bug introduced by Craig Duncan
It seems like $defaultValue of type array is incompatible with the declared type string of property $defaultValue.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
322
    }
323
324
    /**
325
     * Retrieve an argument's value.
326
     *
327 28
     * Argument values are type cast based on the value of $castTo.
328
     *
329 28
     * @return string|int|float|bool
330
     */
331
    public function value()
332
    {
333
        if ($this->values) {
334
            return end($this->values);
335
        }
336
        $cast_method = 'castTo' . ucwords($this->castTo);
337
        return $this->{$cast_method}(current($this->defaultValue()));
338
    }
339 36
340
    /**
341 36
     * Retrieve an argument's values.
342 36
     *
343 36
     * Argument values are type cast based on the value of $castTo.
344
     *
345
     * @return string[]|int[]|float[]|bool[]
346
     */
347
    public function values()
348
    {
349
        if ($this->values) {
350 24
            return $this->values;
351
        }
352 24
        $cast_method = 'castTo' . ucwords($this->castTo);
353
        return array_map([$this, $cast_method], $this->defaultValue());
354
    }
355
356
    /**
357
     * @deprecated use values() instead.
358
     */
359
    public function valueArray()
360 4
    {
361
        return $this->values();
362 4
    }
363
364
    /**
365
     * Set an argument's value based on its command line entry.
366
     *
367
     * Argument values are type cast based on the value of $castTo.
368
     *
369
     * @param string|bool $value
370 4
     */
371
    public function setValue($value)
372 4
    {
373
        $cast_method = 'castTo' . ucwords($this->castTo);
374
        $this->values[] = $this->{$cast_method}($value);
375
    }
376
377
    /**
378
     * @param string $value
379
     *
380 8
     * @return string
381
     */
382 8
    protected function castToString($value)
383
    {
384
        return (string) $value;
385
    }
386
387
    /**
388
     * @param string $value
389
     *
390
     * @return int
391
     */
392
    protected function castToInt($value)
393
    {
394
        return (int) $value;
395
    }
396
397
    /**
398
     * @param string $value
399
     *
400
     * @return float
401
     */
402
    protected function castToFloat($value)
403
    {
404
        return (float) $value;
405
    }
406
407
    /**
408
     * @param string $value
409
     *
410
     * @return bool
411
     */
412
    protected function castToBool($value)
413
    {
414
        return (bool) $value;
415
    }
416
}
417