Skip to content

Commit e2e5ea9

Browse files
skipperbentskipperbent
committed
[ISSUE] Changed return-type to self to support ide's that doesn't parse phpdocs (issue: #110)
1 parent 20985a4 commit e2e5ea9

2 files changed

Lines changed: 43 additions & 43 deletions

File tree

‎src/Pecee/Pixie/QueryBuilder/NestedCriteria.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ class NestedCriteria extends QueryBuilderHandler
1717
*
1818
* @return static
1919
*/
20-
protected function whereHandler($key, string $operator = null, $value = null, $joiner = 'AND'): IQueryBuilderHandler
20+
protected function whereHandler($key, string $operator = null, $value = null, $joiner = 'AND'): QueryBuilderHandler
2121
{
2222
$key = $this->addTablePrefix($key);
2323
$this->statements['criteria'][] = compact('key', 'operator', 'value', 'joiner');

‎src/Pecee/Pixie/QueryBuilder/QueryBuilderHandler.php‎

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ public function asObject(string $className, array $constructorArgs = []): QueryB
132132
*
133133
* @return static
134134
*/
135-
public function setFetchMode($parameters = null): IQueryBuilderHandler
135+
public function setFetchMode($parameters = null): self
136136
{
137137
$this->fetchParameters = \func_get_args();
138138

@@ -309,7 +309,7 @@ public function getConnection(): Connection
309309
*
310310
* @return static
311311
*/
312-
public function setConnection(Connection $connection): IQueryBuilderHandler
312+
public function setConnection(Connection $connection): self
313313
{
314314
$this->connection = $connection;
315315

@@ -425,7 +425,7 @@ public function getLastQuery(): ?QueryObject
425425
*
426426
* @return static
427427
*/
428-
public function limit(int $limit): IQueryBuilderHandler
428+
public function limit(int $limit): self
429429
{
430430
$this->statements['limit'] = $limit;
431431

@@ -439,7 +439,7 @@ public function limit(int $limit): IQueryBuilderHandler
439439
*
440440
* @return static $this
441441
*/
442-
public function fetchNext(int $fetchNext): IQueryBuilderHandler
442+
public function fetchNext(int $fetchNext): self
443443
{
444444
$this->statements['fetch_next'] = $fetchNext;
445445

@@ -457,7 +457,7 @@ public function fetchNext(int $fetchNext): IQueryBuilderHandler
457457
*
458458
* @return static
459459
*/
460-
public function select($fields): IQueryBuilderHandler
460+
public function select($fields): self
461461
{
462462
if (\is_array($fields) === false) {
463463
$fields = \func_get_args();
@@ -563,7 +563,7 @@ protected function addStatement(string $key, $value): void
563563
* ->table($qb->raw('table_one as one'))
564564
* ```
565565
*/
566-
public function table($tables = null): IQueryBuilderHandler
566+
public function table($tables = null): self
567567
{
568568
if ($tables === null) {
569569
return $this->from($tables);
@@ -584,7 +584,7 @@ public function table($tables = null): IQueryBuilderHandler
584584
*
585585
* @return static
586586
*/
587-
public function from($tables = null): IQueryBuilderHandler
587+
public function from($tables = null): self
588588
{
589589
if ($tables === null) {
590590
$this->statements['tables'] = null;
@@ -623,7 +623,7 @@ public function from($tables = null): IQueryBuilderHandler
623623
*
624624
* @return static
625625
*/
626-
public function alias(string $alias, ?string $table = null): IQueryBuilderHandler
626+
public function alias(string $alias, ?string $table = null): self
627627
{
628628
if ($table === null && isset($this->statements['tables'][0]) === true) {
629629
$table = $this->statements['tables'][0];
@@ -642,7 +642,7 @@ public function alias(string $alias, ?string $table = null): IQueryBuilderHandle
642642
* @throws Exception
643643
* @return static
644644
*/
645-
public function newQuery(): IQueryBuilderHandler
645+
public function newQuery(): self
646646
{
647647
return new static($this->connection);
648648
}
@@ -788,7 +788,7 @@ public function find($value, string $fieldName = 'id')
788788
*
789789
* @return static
790790
*/
791-
public function where($key, $operator = null, $value = null): IQueryBuilderHandler
791+
public function where($key, $operator = null, $value = null): self
792792
{
793793
// If two params are given then assume operator is =
794794
if (\func_num_args() === 2) {
@@ -813,7 +813,7 @@ public function where($key, $operator = null, $value = null): IQueryBuilderHandl
813813
*
814814
* @return static
815815
*/
816-
protected function whereHandler($key, ?string $operator = null, $value = null, $joiner = 'AND'): IQueryBuilderHandler
816+
protected function whereHandler($key, ?string $operator = null, $value = null, $joiner = 'AND'): self
817817
{
818818
$key = $this->addTablePrefix($key);
819819
$this->statements['wheres'][] = compact('key', 'operator', 'value', 'joiner');
@@ -855,7 +855,7 @@ public function getEvent(string $name, string $table = null): ?callable
855855
*
856856
* @return static
857857
*/
858-
public function groupBy($field): IQueryBuilderHandler
858+
public function groupBy($field): self
859859
{
860860
if (($field instanceof Raw) === false) {
861861
$field = $this->addTablePrefix($field);
@@ -881,7 +881,7 @@ public function groupBy($field): IQueryBuilderHandler
881881
* @return static
882882
* @throws Exception
883883
*/
884-
public function innerJoin($table, $key, $operator = null, $value = null): IQueryBuilderHandler
884+
public function innerJoin($table, $key, $operator = null, $value = null): self
885885
{
886886
return $this->join($table, $key, $operator, $value, 'inner');
887887
}
@@ -915,7 +915,7 @@ public function innerJoin($table, $key, $operator = null, $value = null): IQuery
915915
* })
916916
* ```
917917
*/
918-
public function join($table, $key = null, $operator = null, $value = null, $type = ''): IQueryBuilderHandler
918+
public function join($table, $key = null, $operator = null, $value = null, $type = ''): self
919919
{
920920
$joinBuilder = null;
921921

@@ -1068,7 +1068,7 @@ public function transaction(\Closure $callback): Transaction
10681068
* @return static
10691069
* @throws Exception
10701070
*/
1071-
public function joinUsing($table, $fields, $joinType = ''): IQueryBuilderHandler
1071+
public function joinUsing($table, $fields, $joinType = ''): self
10721072
{
10731073
if (\is_array($fields) === false) {
10741074
$fields = [$fields];
@@ -1099,7 +1099,7 @@ public function joinUsing($table, $fields, $joinType = ''): IQueryBuilderHandler
10991099
* @return static
11001100
* @throws Exception
11011101
*/
1102-
public function leftJoin($table, $key, $operator = null, $value = null): IQueryBuilderHandler
1102+
public function leftJoin($table, $key, $operator = null, $value = null): self
11031103
{
11041104
return $this->join($table, $key, $operator, $value, 'left');
11051105
}
@@ -1111,7 +1111,7 @@ public function leftJoin($table, $key, $operator = null, $value = null): IQueryB
11111111
*
11121112
* @return static $this
11131113
*/
1114-
public function offset(int $offset): IQueryBuilderHandler
1114+
public function offset(int $offset): self
11151115
{
11161116
$this->statements['offset'] = $offset;
11171117

@@ -1125,7 +1125,7 @@ public function offset(int $offset): IQueryBuilderHandler
11251125
*
11261126
* @return static
11271127
*/
1128-
public function onDuplicateKeyUpdate(array $data): IQueryBuilderHandler
1128+
public function onDuplicateKeyUpdate(array $data): self
11291129
{
11301130
$this->addStatement('onduplicate', $data);
11311131

@@ -1141,7 +1141,7 @@ public function onDuplicateKeyUpdate(array $data): IQueryBuilderHandler
11411141
*
11421142
* @return static
11431143
*/
1144-
public function orHaving($key, $operator, $value): IQueryBuilderHandler
1144+
public function orHaving($key, $operator, $value): self
11451145
{
11461146
return $this->having($key, $operator, $value, 'OR');
11471147
}
@@ -1156,7 +1156,7 @@ public function orHaving($key, $operator, $value): IQueryBuilderHandler
11561156
*
11571157
* @return static
11581158
*/
1159-
public function having($key, $operator, $value, $joiner = 'AND'): IQueryBuilderHandler
1159+
public function having($key, $operator, $value, $joiner = 'AND'): self
11601160
{
11611161
$key = $this->addTablePrefix($key);
11621162
$this->statements['havings'][] = compact('key', 'operator', 'value', 'joiner');
@@ -1173,7 +1173,7 @@ public function having($key, $operator, $value, $joiner = 'AND'): IQueryBuilderH
11731173
*
11741174
* @return static
11751175
*/
1176-
public function orWhere($key, $operator = null, $value = null): IQueryBuilderHandler
1176+
public function orWhere($key, $operator = null, $value = null): self
11771177
{
11781178
// If two params are given then assume operator is =
11791179
if (\func_num_args() === 2) {
@@ -1193,7 +1193,7 @@ public function orWhere($key, $operator = null, $value = null): IQueryBuilderHan
11931193
*
11941194
* @return static
11951195
*/
1196-
public function orWhereBetween($key, $valueFrom, $valueTo): IQueryBuilderHandler
1196+
public function orWhereBetween($key, $valueFrom, $valueTo): self
11971197
{
11981198
return $this->whereHandler($key, 'BETWEEN', [$valueFrom, $valueTo], 'OR');
11991199
}
@@ -1206,7 +1206,7 @@ public function orWhereBetween($key, $valueFrom, $valueTo): IQueryBuilderHandler
12061206
*
12071207
* @return static
12081208
*/
1209-
public function orWhereIn($key, $values): IQueryBuilderHandler
1209+
public function orWhereIn($key, $values): self
12101210
{
12111211
return $this->whereHandler($key, 'IN', $values, 'OR');
12121212
}
@@ -1220,7 +1220,7 @@ public function orWhereIn($key, $values): IQueryBuilderHandler
12201220
*
12211221
* @return static
12221222
*/
1223-
public function orWhereNot($key, $operator = null, $value = null): IQueryBuilderHandler
1223+
public function orWhereNot($key, $operator = null, $value = null): self
12241224
{
12251225
// If two params are given then assume operator is =
12261226
if (\func_num_args() === 2) {
@@ -1239,7 +1239,7 @@ public function orWhereNot($key, $operator = null, $value = null): IQueryBuilder
12391239
*
12401240
* @return static
12411241
*/
1242-
public function orWhereNotIn($key, $values): IQueryBuilderHandler
1242+
public function orWhereNotIn($key, $values): self
12431243
{
12441244
return $this->whereHandler($key, 'NOT IN', $values, 'OR');
12451245
}
@@ -1251,7 +1251,7 @@ public function orWhereNotIn($key, $values): IQueryBuilderHandler
12511251
*
12521252
* @return static
12531253
*/
1254-
public function orWhereNotNull($key): IQueryBuilderHandler
1254+
public function orWhereNotNull($key): self
12551255
{
12561256
return $this->whereNullHandler($key, 'NOT', 'or');
12571257
}
@@ -1265,7 +1265,7 @@ public function orWhereNotNull($key): IQueryBuilderHandler
12651265
*
12661266
* @return static
12671267
*/
1268-
protected function whereNullHandler($key, string $prefix = '', string $operator = ''): IQueryBuilderHandler
1268+
protected function whereNullHandler($key, string $prefix = '', string $operator = ''): self
12691269
{
12701270
$key = $this->adapterInstance->wrapSanitizer($this->addTablePrefix($key));
12711271
$prefix = ($prefix !== '') ? $prefix . ' ' : $prefix;
@@ -1280,7 +1280,7 @@ protected function whereNullHandler($key, string $prefix = '', string $operator
12801280
*
12811281
* @return static
12821282
*/
1283-
public function orWhereNull($key): IQueryBuilderHandler
1283+
public function orWhereNull($key): self
12841284
{
12851285
return $this->whereNullHandler($key, '', 'or');
12861286
}
@@ -1293,7 +1293,7 @@ public function orWhereNull($key): IQueryBuilderHandler
12931293
*
12941294
* @return static
12951295
*/
1296-
public function orderBy($fields, string $direction = 'ASC'): IQueryBuilderHandler
1296+
public function orderBy($fields, string $direction = 'ASC'): self
12971297
{
12981298
if (\is_array($fields) === false) {
12991299
$fields = [$fields];
@@ -1327,7 +1327,7 @@ public function orderBy($fields, string $direction = 'ASC'): IQueryBuilderHandle
13271327
* @return static
13281328
* @throws Exception
13291329
*/
1330-
public function query(string $sql, array $bindings = []): IQueryBuilderHandler
1330+
public function query(string $sql, array $bindings = []): self
13311331
{
13321332
$queryObject = new QueryObject($sql, $bindings, $this->getConnection());
13331333
$this->connection->setLastQuery($queryObject);
@@ -1396,7 +1396,7 @@ public function replace(array $data)
13961396
* @return static
13971397
* @throws Exception
13981398
*/
1399-
public function rightJoin($table, $key, ?string $operator = null, $value = null): IQueryBuilderHandler
1399+
public function rightJoin($table, $key, ?string $operator = null, $value = null): self
14001400
{
14011401
return $this->join($table, $key, $operator, $value, 'right');
14021402
}
@@ -1408,7 +1408,7 @@ public function rightJoin($table, $key, ?string $operator = null, $value = null)
14081408
*
14091409
* @return static
14101410
*/
1411-
public function selectDistinct($fields): IQueryBuilderHandler
1411+
public function selectDistinct($fields): self
14121412
{
14131413
if ($this->overwriteEnabled === true) {
14141414
$this->statements['distincts'] = $fields;
@@ -1427,7 +1427,7 @@ public function selectDistinct($fields): IQueryBuilderHandler
14271427
*
14281428
* @return static $this
14291429
*/
1430-
public function union(QueryBuilderHandler $query, ?string $unionType = self::UNION_TYPE_NONE): IQueryBuilderHandler
1430+
public function union(QueryBuilderHandler $query, ?string $unionType = self::UNION_TYPE_NONE): self
14311431
{
14321432
$statements = $query->getStatements();
14331433

@@ -1460,7 +1460,7 @@ public function getStatements(): array
14601460
*
14611461
* @return static $this
14621462
*/
1463-
public function setStatements(array $statements): IQueryBuilderHandler
1463+
public function setStatements(array $statements): self
14641464
{
14651465
$this->statements = $statements;
14661466

@@ -1534,7 +1534,7 @@ public function insert(array $data)
15341534
*
15351535
* @return static
15361536
*/
1537-
public function whereBetween($key, $valueFrom, $valueTo): IQueryBuilderHandler
1537+
public function whereBetween($key, $valueFrom, $valueTo): self
15381538
{
15391539
return $this->whereHandler($key, 'BETWEEN', [$valueFrom, $valueTo]);
15401540
}
@@ -1547,7 +1547,7 @@ public function whereBetween($key, $valueFrom, $valueTo): IQueryBuilderHandler
15471547
*
15481548
* @return static
15491549
*/
1550-
public function whereIn($key, $values): IQueryBuilderHandler
1550+
public function whereIn($key, $values): self
15511551
{
15521552
return $this->whereHandler($key, 'IN', $values);
15531553
}
@@ -1561,7 +1561,7 @@ public function whereIn($key, $values): IQueryBuilderHandler
15611561
*
15621562
* @return static
15631563
*/
1564-
public function whereNot($key, $operator = null, $value = null): IQueryBuilderHandler
1564+
public function whereNot($key, $operator = null, $value = null): self
15651565
{
15661566
// If two params are given then assume operator is =
15671567
if (\func_num_args() === 2) {
@@ -1580,7 +1580,7 @@ public function whereNot($key, $operator = null, $value = null): IQueryBuilderHa
15801580
*
15811581
* @return static
15821582
*/
1583-
public function whereNotIn($key, $values): IQueryBuilderHandler
1583+
public function whereNotIn($key, $values): self
15841584
{
15851585
return $this->whereHandler($key, 'NOT IN', $values);
15861586
}
@@ -1592,7 +1592,7 @@ public function whereNotIn($key, $values): IQueryBuilderHandler
15921592
*
15931593
* @return static
15941594
*/
1595-
public function whereNotNull($key): IQueryBuilderHandler
1595+
public function whereNotNull($key): self
15961596
{
15971597
return $this->whereNullHandler($key, 'NOT');
15981598
}
@@ -1604,7 +1604,7 @@ public function whereNotNull($key): IQueryBuilderHandler
16041604
*
16051605
* @return static
16061606
*/
1607-
public function whereNull($key): IQueryBuilderHandler
1607+
public function whereNull($key): self
16081608
{
16091609
return $this->whereNullHandler($key);
16101610
}
@@ -1614,7 +1614,7 @@ public function whereNull($key): IQueryBuilderHandler
16141614
* @param $statement string
16151615
* @return static
16161616
*/
1617-
public function for(string $statement): IQueryBuilderHandler
1617+
public function for(string $statement): self
16181618
{
16191619
$this->addStatement('for', $statement);
16201620
return $this;
@@ -1660,7 +1660,7 @@ public function isOverwriteEnabled(): bool
16601660
* @param bool $enabled
16611661
* @return static
16621662
*/
1663-
public function setOverwriteEnabled(bool $enabled): IQueryBuilderHandler
1663+
public function setOverwriteEnabled(bool $enabled): self
16641664
{
16651665
$this->overwriteEnabled = $enabled;
16661666

0 commit comments

Comments
 (0)