Skip to content

refactor: fix missingType.return errors in system files #9530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion system/CodeIgniter.php
Original file line number Diff line number Diff line change
Expand Up @@ -948,7 +948,9 @@ protected function display404errors(PageNotFoundException $e)
$this->response->setStatusCode($e->getCode());

// Is there a 404 Override available?
if ($override = $this->router->get404Override()) {
$override = $this->router->get404Override();

if ($override !== null) {
$returned = null;

if ($override instanceof Closure) {
Expand Down
2 changes: 1 addition & 1 deletion system/ComposerScripts.php
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ final class ComposerScripts
* This static method is called by Composer after every update event,
* i.e., `composer install`, `composer update`, `composer remove`.
*/
public static function postUpdate()
public static function postUpdate(): void
{
self::recursiveDelete(self::$path);

Expand Down
6 changes: 6 additions & 0 deletions system/Database/BaseBuilder.php
Original file line number Diff line number Diff line change
Expand Up @@ -3380,6 +3380,8 @@ public function resetQuery()
* Resets the query builder values. Called by the get() function
*
* @param array $qbResetItems An array of fields to reset
*
* @return void
*/
protected function resetRun(array $qbResetItems)
{
Expand All @@ -3390,6 +3392,8 @@ protected function resetRun(array $qbResetItems)

/**
* Resets the query builder values. Called by the get() function
*
* @return void
*/
protected function resetSelect()
{
Expand Down Expand Up @@ -3421,6 +3425,8 @@ protected function resetSelect()
* Resets the query builder "write" values.
*
* Called by the insert() update() insertBatch() updateBatch() and delete() functions
*
* @return void
*/
protected function resetWrite()
{
Expand Down
4 changes: 2 additions & 2 deletions system/Database/Config.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@
use Config\Database as DbConfig;

/**
* Class Config
*
* @see \CodeIgniter\Database\ConfigTest
*/
class Config extends BaseConfig
Expand Down Expand Up @@ -141,6 +139,8 @@ public static function seeder(?string $group = null)

/**
* Ensures the database Connection Manager/Factory is loaded and ready to use.
*
* @return void
*/
protected static function ensureFactory()
{
Expand Down
12 changes: 12 additions & 0 deletions system/Database/Exceptions/DataException.php
Original file line number Diff line number Diff line change
Expand Up @@ -65,21 +65,33 @@ public static function forInvalidArgument(string $argument)
return new static(lang('Database.invalidArgument', [$argument]));
}

/**
* @return DataException
*/
public static function forInvalidAllowedFields(string $model)
{
return new static(lang('Database.invalidAllowedFields', [$model]));
}

/**
* @return DataException
*/
public static function forTableNotFound(string $table)
{
return new static(lang('Database.tableNotFound', [$table]));
}

/**
* @return DataException
*/
public static function forEmptyInputGiven(string $argument)
{
return new static(lang('Database.forEmptyInputGiven', [$argument]));
}

/**
* @return DataException
*/
public static function forFindColumnHaveMultipleColumns()
{
return new static(lang('Database.forFindColumnHaveMultipleColumns'));
Expand Down
15 changes: 15 additions & 0 deletions system/Database/Forge.php
Original file line number Diff line number Diff line change
Expand Up @@ -984,6 +984,8 @@ protected function _processColumn(array $processedField): string

/**
* Performs a data type mapping between different databases.
*
* @return void
*/
protected function _attributeType(array &$attributes)
{
Expand All @@ -999,6 +1001,8 @@ protected function _attributeType(array &$attributes)
* if $attributes['TYPE'] is found in the array
* - array(TYPE => UTYPE) will change $field['type'],
* from TYPE to UTYPE in case of a match
*
* @return void
*/
protected function _attributeUnsigned(array &$attributes, array &$field)
{
Expand Down Expand Up @@ -1030,6 +1034,9 @@ protected function _attributeUnsigned(array &$attributes, array &$field)
$field['unsigned'] = ($this->unsigned === true) ? ' UNSIGNED' : '';
}

/**
* @return void
*/
protected function _attributeDefault(array &$attributes, array &$field)
{
if ($this->default === false) {
Expand All @@ -1051,13 +1058,19 @@ protected function _attributeDefault(array &$attributes, array &$field)
}
}

/**
* @return void
*/
protected function _attributeUnique(array &$attributes, array &$field)
{
if (! empty($attributes['UNIQUE']) && $attributes['UNIQUE'] === true) {
$field['unique'] = ' UNIQUE';
}
}

/**
* @return void
*/
protected function _attributeAutoIncrement(array &$attributes, array &$field)
{
if (! empty($attributes['AUTO_INCREMENT']) && $attributes['AUTO_INCREMENT'] === true
Expand Down Expand Up @@ -1254,6 +1267,8 @@ protected function _processForeignKeys(string $table, bool $asQuery = false): ar

/**
* Resets table creation vars
*
* @return void
*/
public function reset()
{
Expand Down
4 changes: 4 additions & 0 deletions system/Database/Migration.php
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,15 @@ public function getDBGroup(): ?string

/**
* Perform a migration step.
*
* @return void
*/
abstract public function up();

/**
* Revert a migration step.
*
* @return void
*/
abstract public function down();
}
10 changes: 10 additions & 0 deletions system/Database/MigrationRunner.php
Original file line number Diff line number Diff line change
Expand Up @@ -317,6 +317,8 @@ public function regress(int $targetBatch = 0, ?string $group = null)
*
* @param string $path Full path to a valid migration file
* @param string $path Namespace of the target migration
*
* @return bool
*/
public function force(string $path, string $namespace, ?string $group = null)
{
Expand Down Expand Up @@ -575,6 +577,8 @@ public function clearCliMessages()

/**
* Truncates the history table.
*
* @return void
*/
public function clearHistory()
{
Expand All @@ -587,6 +591,8 @@ public function clearHistory()
* Add a history to the table.
*
* @param object $migration
*
* @return void
*/
protected function addHistory($migration, int $batch)
{
Expand Down Expand Up @@ -614,6 +620,8 @@ protected function addHistory($migration, int $batch)
* Removes a single history
*
* @param object $history
*
* @return void
*/
protected function removeHistory($history)
{
Expand Down Expand Up @@ -752,6 +760,8 @@ public function getBatchEnd(int $batch): string
/**
* Ensures that we have created our migrations table
* in the database.
*
* @return void
*/
public function ensureTable()
{
Expand Down
2 changes: 2 additions & 0 deletions system/Database/Postgre/Connection.php
Original file line number Diff line number Diff line change
Expand Up @@ -517,6 +517,8 @@ public function insertID()

/**
* Build a DSN from the provided parameters
*
* @return void
*/
protected function buildDSN()
{
Expand Down
2 changes: 2 additions & 0 deletions system/Database/Query.php
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,8 @@ public function getOriginalQuery(): string
* Escapes and inserts any binds into the finalQueryString property.
*
* @see https://regex101.com/r/EUEhay/5
*
* @return void
*/
protected function compileBinds()
{
Expand Down
10 changes: 6 additions & 4 deletions system/Database/QueryInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ interface QueryInterface
*
* @param mixed $binds
*
* @return mixed
* @return $this
*/
public function setQuery(string $sql, $binds = null, bool $setEscape = true);

/**
* Returns the final, processed query string after binding, etal
* has been performed.
*
* @return mixed
* @return string
*/
public function getQuery();

Expand All @@ -43,7 +43,7 @@ public function getQuery();
* for it's start and end values. If no end value is present, will
* use the current time to determine total duration.
*
* @return mixed
* @return $this
*/
public function setDuration(float $start, ?float $end = null);

Expand All @@ -57,6 +57,8 @@ public function getDuration(int $decimals = 6): string;

/**
* Stores the error description that happened for this query.
*
* @return $this
*/
public function setError(int $code, string $error);

Expand All @@ -83,7 +85,7 @@ public function isWriteType(): bool;
/**
* Swaps out one table prefix for a new one.
*
* @return mixed
* @return $this
*/
public function swapPrefix(string $orig, string $swap);
}
2 changes: 2 additions & 0 deletions system/Database/ResultInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,8 @@ public function getFieldData(): array;

/**
* Frees the current result.
*
* @return void
*/
public function freeResult();

Expand Down
6 changes: 4 additions & 2 deletions system/Database/SQLite3/Table.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@
use stdClass;

/**
* Class Table
*
* Provides missing features for altering tables that are common
* in other supported databases, but are missing from SQLite.
* These are needed in order to support migrations during testing
Expand Down Expand Up @@ -345,6 +343,8 @@ protected function createTable()
* Copies data from our old table to the new one,
* taking care map data correctly based on any columns
* that have been renamed.
*
* @return void
*/
protected function copyData()
{
Expand Down Expand Up @@ -472,6 +472,8 @@ protected function formatKeys($keys)
/**
* Attempts to drop all indexes and constraints
* from the database for this table.
*
* @return void
*/
protected function dropIndexes()
{
Expand Down
2 changes: 2 additions & 0 deletions system/Database/Seeder.php
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,8 @@ public static function faker(): ?Generator
/**
* Loads the specified seeder and runs it.
*
* @return void
*
* @throws InvalidArgumentException
*/
public function call(string $class)
Expand Down
2 changes: 2 additions & 0 deletions system/Router/Router.php
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,8 @@ public function methodName(): string
/**
* Returns the 404 Override settings from the Collection.
* If the override is a string, will split to controller/index array.
*
* @return array{string, string}|(Closure(string): (ResponseInterface|string|void))|null
*/
public function get404Override()
{
Expand Down
17 changes: 17 additions & 0 deletions system/Session/Exceptions/SessionException.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,26 +17,41 @@

class SessionException extends FrameworkException
{
/**
* @return static
*/
public static function forMissingDatabaseTable()
{
return new static(lang('Session.missingDatabaseTable'));
}

/**
* @return static
*/
public static function forInvalidSavePath(?string $path = null)
{
return new static(lang('Session.invalidSavePath', [$path]));
}

/**
* @return static
*/
public static function forWriteProtectedSavePath(?string $path = null)
{
return new static(lang('Session.writeProtectedSavePath', [$path]));
}

/**
* @return static
*/
public static function forEmptySavepath()
{
return new static(lang('Session.emptySavePath'));
}

/**
* @return static
*/
public static function forInvalidSavePathFormat(string $path)
{
return new static(lang('Session.invalidSavePathFormat', [$path]));
Expand All @@ -45,6 +60,8 @@ public static function forInvalidSavePathFormat(string $path)
/**
* @deprecated
*
* @return static
*
* @codeCoverageIgnore
*/
public static function forInvalidSameSiteSetting(string $samesite)
Expand Down
2 changes: 2 additions & 0 deletions system/Session/Handlers/Database/PostgreHandler.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ class PostgreHandler extends DatabaseHandler
{
/**
* Sets SELECT clause
*
* @return void
*/
protected function setSelect(BaseBuilder $builder)
{
Expand Down
Loading
Loading