archtechx/tenancy
1
0
Fork 0
mirror of https://github.com/archtechx/tenancy.git synced 2026-05-06 18:04:03 +00:00
Code Activity

Improve ValidatesDatabaseParameters comments, delete extra early return

Browse source
This commit is contained in:
lukinovec 2026-04-30 10:44:36 +02:00
parent 322257f456
commit 46f73c42ad
1 changed files with 12 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

22
src/Database/Concerns/ValidatesDatabaseParameters.php
View file

@ -10,7 +10,7 @@ use InvalidArgumentException;
* Provides methods to validate database parameters (e.g. database names, usernames, passwords) * Provides methods to validate database parameters (e.g. database names, usernames, passwords)
* before using them in SQL statements (or in file paths in the case of SQLiteDatabaseManager). * before using them in SQL statements (or in file paths in the case of SQLiteDatabaseManager).
* *
* Used where parameters can be provided by users, and where parameter binding isn't possible. * Used where parameters can be provided by users, and where parameter binding cannot be used.
* *
* @mixin \Stancl\Tenancy\Database\TenantDatabaseManagers\TenantDatabaseManager * @mixin \Stancl\Tenancy\Database\TenantDatabaseManagers\TenantDatabaseManager
* @mixin \Stancl\Tenancy\Database\TenantDatabaseManagers\SQLiteDatabaseManager * @mixin \Stancl\Tenancy\Database\TenantDatabaseManagers\SQLiteDatabaseManager
@ -18,7 +18,10 @@ use InvalidArgumentException;
trait ValidatesDatabaseParameters trait ValidatesDatabaseParameters
{ {
/** /**
* Characters allowed in the parameters. * Characters allowed in parameters.
*
* Used as the default allowlist for validateParameter(), which validates non-password
* parameters such as database names or usernames.
*/ */
protected static function parameterAllowlist(): string protected static function parameterAllowlist(): string
{ {
@ -45,21 +48,19 @@ trait ValidatesDatabaseParameters
* *
* By default, only the characters in static::parameterAllowlist() are allowed. * By default, only the characters in static::parameterAllowlist() are allowed.
* *
* Null parameters are skipped.
*
* @throws InvalidArgumentException * @throws InvalidArgumentException
*/ */
protected function validateParameter(string|array|null $parameters, string|null $allowlist = null): void protected function validateParameter(string|array|null $parameters, string|null $allowlist = null): void
{ {
if (is_null($parameters)) {
// Return early if there's nothing to validate
// (e.g. when $databaseConfig->getUsername() of an
// improperly created tenant is passed).
return;
}
$allowlist = $allowlist ?? static::parameterAllowlist(); $allowlist = $allowlist ?? static::parameterAllowlist();
foreach ((array) $parameters as $parameter) { foreach ((array) $parameters as $parameter) {
if (is_null($parameter)) { if (is_null($parameter)) {
// Skip if there's nothing to validate
// (e.g. when $tenant->database()->getUsername() of an
// improperly created tenant is passed).
continue; continue;
} }
@ -74,7 +75,8 @@ trait ValidatesDatabaseParameters
/** /**
* Ensure password only contains allowed characters before used in SQL statements. * Ensure password only contains allowed characters before used in SQL statements.
* *
* Used as a shorthand for calling validateParameter() with the less strict allowlist. * Used as a shorthand for calling validateParameter() with the less strict allowlist
* to validate database user passwords.
* *
* @throws InvalidArgumentException * @throws InvalidArgumentException
*/ */