Skip to content

Commit cbfe80d

Browse files
paulbalandanpaulbalandan
committed
Separate and group similar phpdocs
1 parent 2b78883 commit cbfe80d

File tree

87 files changed

+401
-126
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

87 files changed

+401
-126
lines changed

‎admin/module/tests/_support/Libraries/ConfigReader.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,11 @@
3030
* THE SOFTWARE.
3131
*
3232
* @package CodeIgniter
33+
*
3334
* @author CodeIgniter Dev Team
3435
* @copyright 2019-2021 CodeIgniter Foundation
3536
* @license https://opensource.org/licenses/MIT MIT License
37+
*
3638
* @link https://codeigniter.com
3739
* @since Version 4.0.0
3840
* @filesource

‎admin/starter/tests/_support/Libraries/ConfigReader.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,11 @@
3030
* THE SOFTWARE.
3131
*
3232
* @package CodeIgniter
33+
*
3334
* @author CodeIgniter Dev Team
3435
* @copyright 2019-2021 CodeIgniter Foundation
3536
* @license https://opensource.org/licenses/MIT MIT License
37+
*
3638
* @link https://codeigniter.com
3739
* @since Version 4.0.0
3840
* @filesource

‎app/Config/App.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -436,7 +436,6 @@ class App extends BaseConfig
436436
* Defaults to `Lax` as recommended in this link:
437437
*
438438
* @see https://portswigger.net/web-security/csrf/samesite-cookies
439-
*
440439
* @deprecated Use `Config\Security` $samesite property instead of using this property.
441440
*
442441
* @var string

‎app/Config/Autoload.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ class Autoload extends AutoloadConfig
3737
* 'App' => APPPATH
3838
* ];
3939
*```
40+
*
4041
* @var array<string, string>
4142
*/
4243
public $psr4 = [
@@ -60,6 +61,7 @@ class Autoload extends AutoloadConfig
6061
* 'MyClass' => '/path/to/class/file.php'
6162
* ];
6263
*```
64+
*
6365
* @var array<string, string>
6466
*/
6567
public $classmap = [];
@@ -78,6 +80,7 @@ class Autoload extends AutoloadConfig
7880
* '/path/to/my/file.php',
7981
* ];
8082
* ```
83+
*
8184
* @var array<int, string>
8285
*/
8386
public $files = [];

‎system/CLI/BaseCommand.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ abstract public function run(array $params);
114114
* @param array $params
115115
*
116116
* @return mixed
117+
*
117118
* @throws ReflectionException
118119
*/
119120
protected function call(string $command, array $params = [])

‎system/CLI/CLI.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,8 @@ public static function init()
180180
* Named options must be in the following formats:
181181
* php index.php user -v --v -name=John --name=John
182182
*
183-
* @param string $prefix
183+
* @param string $prefix
184+
*
184185
* @return string
185186
*
186187
* @codeCoverageIgnore

‎system/CLI/CommandRunner.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ public function __construct()
4343
* @param array ...$params
4444
*
4545
* @return mixed
46+
*
4647
* @throws ReflectionException
4748
*/
4849
public function _remap($method, ...$params)
@@ -61,6 +62,7 @@ public function _remap($method, ...$params)
6162
* @param array $params
6263
*
6364
* @return mixed
65+
*
6466
* @throws ReflectionException
6567
*/
6668
public function index(array $params)

‎system/CLI/Console.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ public function __construct(CodeIgniter $app)
4949
* @param bool $useSafeOutput
5050
*
5151
* @return RequestInterface|Response|ResponseInterface|mixed
52+
*
5253
* @throws Exception
5354
*/
5455
public function run(bool $useSafeOutput = false)

‎system/CodeIgniter.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -288,6 +288,7 @@ protected function initializeKint()
288288
* @param bool $returnResponse
289289
*
290290
* @return bool|RequestInterface|ResponseInterface|mixed
291+
*
291292
* @throws RedirectException
292293
* @throws Exception
293294
*/
@@ -366,6 +367,7 @@ public function useSafeOutput(bool $safe = true)
366367
* @param bool $returnResponse
367368
*
368369
* @return RequestInterface|ResponseInterface|mixed
370+
*
369371
* @throws RedirectException
370372
*/
371373
protected function handleRequest(?RouteCollectionInterface $routes, Cache $cacheConfig, bool $returnResponse = false)
@@ -741,6 +743,7 @@ public function displayPerformanceMetrics(string $output): string
741743
* of the config file.
742744
*
743745
* @return string|null
746+
*
744747
* @throws RedirectException
745748
*/
746749
protected function tryToRouteIt(RouteCollectionInterface $routes = null)

‎system/Common.php

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -421,6 +421,7 @@ function env(string $key, $default = null)
421421
* @param string $encoding
422422
*
423423
* @return string|array
424+
*
424425
* @throws InvalidArgumentException
425426
*/
426427
function esc($data, string $context = 'html', string $encoding = null)
@@ -549,9 +550,11 @@ function force_https(int $duration = 31536000, RequestInterface $request = null,
549550
* be just temporary, but would probably be kept for a few years.
550551
*
551552
* @link http://www.hardened-php.net/suhosin/
552-
* @param string $functionName Function to check for
553-
* @return bool TRUE if the function exists and is safe to call,
554-
* FALSE otherwise.
553+
*
554+
* @param string $functionName Function to check for
555+
*
556+
* @return bool TRUE if the function exists and is safe to call,
557+
* FALSE otherwise.
555558
*
556559
* @codeCoverageIgnore This is too exotic
557560
*/
@@ -581,7 +584,8 @@ function function_usable(string $functionName): bool
581584
* 2. {namespace}/Helpers
582585
* 3. system/Helpers
583586
*
584-
* @param string|array $filenames
587+
* @param string|array $filenames
588+
*
585589
* @throws FileNotFoundException
586590
*/
587591
function helper($filenames)
@@ -1175,6 +1179,7 @@ function view(string $name, array $data = [], array $options = []): string
11751179
* @param string|null $cacheName
11761180
*
11771181
* @return string
1182+
*
11781183
* @throws ReflectionException
11791184
*/
11801185
function view_cell(string $library, $params = null, int $ttl = 0, string $cacheName = null): string

‎system/Config/DotEnv.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,7 @@ public function normaliseVariable(string $name, string $value = ''): array
161161
* @param string $value
162162
*
163163
* @return string
164+
*
164165
* @throws InvalidArgumentException
165166
*/
166167
protected function sanitizeValue(string $value): string

‎system/Database/BaseBuilder.php

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -248,9 +248,10 @@ class BaseBuilder
248248
/**
249249
* Constructor
250250
*
251-
* @param string|array $tableName
252-
* @param ConnectionInterface $db
253-
* @param array $options
251+
* @param string|array $tableName
252+
* @param ConnectionInterface $db
253+
* @param array $options
254+
*
254255
* @throws DatabaseException
255256
*/
256257
public function __construct($tableName, ConnectionInterface &$db, array $options = null)
@@ -494,6 +495,7 @@ public function selectCount(string $select = '', string $alias = '')
494495
* @param string $type
495496
*
496497
* @return $this
498+
*
497499
* @throws DataException
498500
* @throws DatabaseException
499501
*/
@@ -959,12 +961,13 @@ public function orHavingNotIn(string $key = null, $values = null, bool $escape =
959961
* @used-by whereNotIn()
960962
* @used-by orWhereNotIn()
961963
*
962-
* @param string $key The field to search
963-
* @param array|Closure|null $values The values searched on, or anonymous function with subquery
964-
* @param bool $not If the statement would be IN or NOT IN
965-
* @param string $type
966-
* @param bool $escape
967-
* @param string $clause (Internal use only)
964+
* @param string $key The field to search
965+
* @param array|Closure|null $values The values searched on, or anonymous function with subquery
966+
* @param bool $not If the statement would be IN or NOT IN
967+
* @param string $type
968+
* @param bool $escape
969+
* @param string $clause (Internal use only)
970+
*
968971
* @throws InvalidArgumentException
969972
*
970973
* @return $this
@@ -1957,7 +1960,8 @@ public function getWhere($where = null, int $limit = null, ?int $offset = 0, boo
19571960
* @param bool $escape Whether to escape values and identifiers
19581961
* @param int $batchSize Batch size
19591962
*
1960-
* @return int|false Number of rows inserted or FALSE on failure
1963+
* @return int|false Number of rows inserted or FALSE on failure
1964+
*
19611965
* @throws DatabaseException
19621966
*/
19631967
public function insertBatch(array $set = null, bool $escape = null, int $batchSize = 100)
@@ -2161,6 +2165,7 @@ public function insert(array $set = null, bool $escape = null)
21612165
* has been chosen to be inserted into.
21622166
*
21632167
* @return bool
2168+
*
21642169
* @throws DatabaseException
21652170
*/
21662171
protected function validateInsert(): bool
@@ -2203,6 +2208,7 @@ protected function _insert(string $table, array $keys, array $unescapedKeys): st
22032208
* @param array $set An associative array of insert values
22042209
*
22052210
* @return BaseResult|Query|string|false
2211+
*
22062212
* @throws DatabaseException
22072213
*/
22082214
public function replace(array $set = null)
@@ -2383,6 +2389,7 @@ protected function _update(string $table, array $values): string
23832389
* chosen to be update.
23842390
*
23852391
* @return bool
2392+
*
23862393
* @throws DatabaseException
23872394
*/
23882395
protected function validateUpdate(): bool
@@ -2410,7 +2417,8 @@ protected function validateUpdate(): bool
24102417
* @param string $index The where key
24112418
* @param int $batchSize The size of the batch to run
24122419
*
2413-
* @return mixed Number of rows affected, SQL string, or FALSE on failure
2420+
* @return mixed Number of rows affected, SQL string, or FALSE on failure
2421+
*
24142422
* @throws DatabaseException
24152423
*/
24162424
public function updateBatch(array $set = null, string $index = null, int $batchSize = 100)
@@ -2523,6 +2531,7 @@ protected function _updateBatch(string $table, array $values, string $index): st
25232531
* @param bool $escape
25242532
*
25252533
* @return $this|null
2534+
*
25262535
* @throws DatabaseException
25272536
*/
25282537
public function setUpdateBatch($key, string $index = '', bool $escape = null)
@@ -2661,6 +2670,7 @@ public function getCompiledDelete(bool $reset = true): string
26612670
* @param bool $resetData
26622671
*
26632672
* @return string|bool
2673+
*
26642674
* @throws DatabaseException
26652675
*/
26662676
public function delete($where = '', int $limit = null, bool $resetData = true)

0 commit comments

Comments
 (0)