Skip to content

Commit 016d370

Browse files
authored
CS fixer and phpstan updates (#5)
1 parent eb777b8 commit 016d370

21 files changed

+351
-100
lines changed

.php_cs.dist .php-cs-fixer.dist.php

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
<?php
22

3-
$finder = PhpCsFixer\Finder::create()->in('src');
3+
$finder = PhpCsFixer\Finder::create()->in(__DIR__);
44

5-
return PhpCsFixer\Config::create()
5+
return (new PhpCsFixer\Config())
66
->setRules([
77
'@Symfony' => true,
8-
'braces' => false,
98
'new_with_braces' => false,
10-
'trailing_comma_in_multiline_array' => false,
9+
'trailing_comma_in_multiline' => false,
1110
'not_operator_with_successor_space' => true,
1211
'phpdoc_align' => false,
1312
'phpdoc_summary' => false,

CHANGELOG.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
### Changelog
22

3+
##### v2.1.0
4+
+ Updated internal tools php-cs-fixer and phpstan
5+
- Cleared all phpstan errors up to level 8 (max)
6+
+ Changed (corrected) some return types for functions
7+
- These were all from phpstan errors
8+
- Increased minor version number because of compatibility
9+
310
##### v2.0.2
411
+ Updated `GroupClause` class with:
512
- For backwards compatibility, `groupBy()` accepts both `array` and `string`

composer.json

+4-3
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,10 @@
3333
"ext-pdo": "*"
3434
},
3535
"scripts": {
36-
"fix": "php-cs-fixer fix",
37-
"test": "./vendor/bin/phpunit",
38-
"lint": "php-cs-fixer fix --dry-run --diff"
36+
"fix": "tools/php-cs-fixer/vendor/bin/php-cs-fixer fix",
37+
"lint": "tools/php-cs-fixer/vendor/bin/php-cs-fixer fix --dry-run --diff",
38+
"phpstan": "tools/phpstan/vendor/bin/phpstan --memory-limit=1G analyse",
39+
"phpstan-strict": "tools/phpstan/vendor/bin/phpstan --memory-limit=1G --level=6 analyse"
3940
},
4041
"autoload": {
4142
"psr-4": {

phpstan.neon

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
parameters:
2+
level: max
3+
paths:
4+
- src
5+
checkMissingIterableValueType: false
6+
inferPrivatePropertyTypeFromConstructor: true
7+
treatPhpDocTypesAsCertain: false

src/Clause/ClauseContainer.php

+3
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,8 @@
44

55
abstract class ClauseContainer
66
{
7+
/**
8+
* @var array
9+
*/
710
protected $container = [];
811
}

src/Clause/GroupClause.php

+5
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ class GroupClause extends ClauseContainer
66
{
77
/**
88
* @param mixed $columns
9+
*
10+
* @return void
911
*/
1012
public function groupBy($columns)
1113
{
@@ -16,6 +18,9 @@ public function groupBy($columns)
1618
}
1719
}
1820

21+
/**
22+
* @return string
23+
*/
1924
public function __toString()
2025
{
2126
if (empty($this->container)) {

src/Clause/HavingClause.php

+29-15
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,33 @@
55
class HavingClause extends ClauseContainer
66
{
77
/**
8-
* @param string $column
9-
* @param null $operator
10-
* @param string $chainType
8+
* @param string $column
9+
* @param string|null $operator
10+
* @param string $chainType
11+
*
12+
* @return void
1113
*/
1214
public function having($column, $operator = null, $chainType = 'AND')
1315
{
1416
$this->container[] = " $chainType $column $operator ?";
1517
}
1618

1719
/**
18-
* @param string $column
19-
* @param null $operator
20+
* @param string $column
21+
* @param string|null $operator
22+
*
23+
* @return void
2024
*/
2125
public function orHaving($column, $operator = null)
2226
{
2327
$this->having($column, $operator, 'OR');
2428
}
2529

2630
/**
27-
* @param string $column
28-
* @param null $operator
31+
* @param string $column
32+
* @param string|null $operator
33+
*
34+
* @return void
2935
*/
3036
public function havingCount($column, $operator = null)
3137
{
@@ -35,8 +41,10 @@ public function havingCount($column, $operator = null)
3541
}
3642

3743
/**
38-
* @param string $column
39-
* @param null $operator
44+
* @param string $column
45+
* @param string|null $operator
46+
*
47+
* @return void
4048
*/
4149
public function havingMax($column, $operator = null)
4250
{
@@ -46,8 +54,10 @@ public function havingMax($column, $operator = null)
4654
}
4755

4856
/**
49-
* @param string $column
50-
* @param null $operator
57+
* @param string $column
58+
* @param string|null $operator
59+
*
60+
* @return void
5161
*/
5262
public function havingMin($column, $operator = null)
5363
{
@@ -57,8 +67,10 @@ public function havingMin($column, $operator = null)
5767
}
5868

5969
/**
60-
* @param string $column
61-
* @param null $operator
70+
* @param string $column
71+
* @param string|null $operator
72+
*
73+
* @return void
6274
*/
6375
public function havingAvg($column, $operator = null)
6476
{
@@ -68,8 +80,10 @@ public function havingAvg($column, $operator = null)
6880
}
6981

7082
/**
71-
* @param string $column
72-
* @param null $operator
83+
* @param string $column
84+
* @param string|null $operator
85+
*
86+
* @return void
7387
*/
7488
public function havingSum($column, $operator = null)
7589
{

src/Clause/JoinClause.php

+25-17
Original file line numberDiff line numberDiff line change
@@ -5,44 +5,52 @@
55
class JoinClause extends ClauseContainer
66
{
77
/**
8-
* @param string $table
9-
* @param string $first
10-
* @param null $operator
11-
* @param null $second
12-
* @param string $joinType
8+
* @param string $table
9+
* @param string $first
10+
* @param string|null $operator
11+
* @param string|null $second
12+
* @param string $joinType
13+
*
14+
* @return void
1315
*/
1416
public function join($table, $first, $operator = null, $second = null, $joinType = 'INNER')
1517
{
1618
$this->container[] = ' '.$joinType.' JOIN '.$table.' ON '.$first.' '.$operator.' '.$second;
1719
}
1820

1921
/**
20-
* @param string $table
21-
* @param string $first
22-
* @param null $operator
23-
* @param null $second
22+
* @param string $table
23+
* @param string $first
24+
* @param string|null $operator
25+
* @param string|null $second
26+
*
27+
* @return void
2428
*/
2529
public function leftJoin($table, $first, $operator = null, $second = null)
2630
{
2731
$this->join($table, $first, $operator, $second, 'LEFT OUTER');
2832
}
2933

3034
/**
31-
* @param string $table
32-
* @param string $first
33-
* @param null $operator
34-
* @param null $second
35+
* @param string $table
36+
* @param string $first
37+
* @param string|null $operator
38+
* @param string|null $second
39+
*
40+
* @return void
3541
*/
3642
public function rightJoin($table, $first, $operator = null, $second = null)
3743
{
3844
$this->join($table, $first, $operator, $second, 'RIGHT OUTER');
3945
}
4046

4147
/**
42-
* @param string $table
43-
* @param string $first
44-
* @param null $operator
45-
* @param null $second
48+
* @param string $table
49+
* @param string $first
50+
* @param string|null $operator
51+
* @param string|null $second
52+
*
53+
* @return void
4654
*/
4755
public function fullJoin($table, $first, $operator = null, $second = null)
4856
{

src/Clause/LimitClause.php

+5
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,16 @@
44

55
class LimitClause extends ClauseContainer
66
{
7+
/**
8+
* @var int|string|null
9+
*/
710
private $limit = null;
811

912
/**
1013
* @param int $number
1114
* @param int $offset
15+
*
16+
* @return void
1217
*/
1318
public function limit($number, $offset = 0)
1419
{

src/Clause/OffsetClause.php

+5
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,15 @@
44

55
class OffsetClause extends ClauseContainer
66
{
7+
/**
8+
* @var int|null
9+
*/
710
private $offset = null;
811

912
/**
1013
* @param int $number
14+
*
15+
* @return void
1116
*/
1217
public function offset($number)
1318
{

src/Clause/OrderClause.php

+2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ class OrderClause extends ClauseContainer
77
/**
88
* @param string $column
99
* @param string $direction
10+
*
11+
* @return void
1012
*/
1113
public function orderBy($column, $direction = 'ASC')
1214
{

0 commit comments

Comments
 (0)