makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-08 04:18:52 +00:00
Code Issues Projects Releases Packages Wiki Activity

[ticket/16741] Clean up functions, add missing docblocks and return type hints

Browse source 
PHPBB3-16741
This commit is contained in:
Marc Alexander 2022-01-17 17:09:38 +01:00
parent 5e6065ff9e
commit 81cddb2bc6
No known key found for this signature in database
GPG key ID: 50E0D2423696F995
4 changed files with 30 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
phpBB/phpbb/db/doctrine/comparator.php
View file

@ -26,7 +26,7 @@ class comparator extends \Doctrine\DBAL\Schema\Comparator
if ($diff === false) if ($diff === false)
{ {
return $diff; return false;
} }
if (!is_array($diff->changedColumns)) if (!is_array($diff->changedColumns))

40
phpBB/phpbb/db/doctrine/postgresql_platform.php
View file

@ -36,7 +36,7 @@ class postgresql_platform extends PostgreSQLPlatform
/** /**
* {@inheritdoc} * {@inheritdoc}
*/ */
public function getIdentitySequenceName($tableName, $columnName) public function getIdentitySequenceName($tableName, $columnName): string
{ {
return $tableName . '_seq'; return $tableName . '_seq';
} }
@ -44,7 +44,7 @@ class postgresql_platform extends PostgreSQLPlatform
/** /**
* {@inheritDoc} * {@inheritDoc}
*/ */
public function getIntegerTypeDeclarationSQL(array $column) public function getIntegerTypeDeclarationSQL(array $column): string
{ {
return 'INT'; return 'INT';
} }
@ -52,7 +52,7 @@ class postgresql_platform extends PostgreSQLPlatform
/** /**
* {@inheritDoc} * {@inheritDoc}
*/ */
public function getBigIntTypeDeclarationSQL(array $column) public function getBigIntTypeDeclarationSQL(array $column): string
{ {
return 'BIGINT'; return 'BIGINT';
} }
@ -60,7 +60,7 @@ class postgresql_platform extends PostgreSQLPlatform
/** /**
* {@inheritDoc} * {@inheritDoc}
*/ */
public function getSmallIntTypeDeclarationSQL(array $column) public function getSmallIntTypeDeclarationSQL(array $column): string
{ {
return 'SMALLINT'; return 'SMALLINT';
} }
@ -68,7 +68,7 @@ class postgresql_platform extends PostgreSQLPlatform
/** /**
* {@inheritDoc} * {@inheritDoc}
*/ */
public function getDefaultValueDeclarationSQL($column) public function getDefaultValueDeclarationSQL($column): string
{ {
if ($this->isSerialColumn($column)) if ($this->isSerialColumn($column))
{ {
@ -81,7 +81,7 @@ class postgresql_platform extends PostgreSQLPlatform
/** /**
* {@inheritDoc} * {@inheritDoc}
*/ */
public function supportsIdentityColumns() public function supportsIdentityColumns(): bool
{ {
return false; return false;
} }
@ -89,7 +89,7 @@ class postgresql_platform extends PostgreSQLPlatform
/** /**
* {@inheritDoc} * {@inheritDoc}
*/ */
protected function _getCreateTableSQL($name, array $columns, array $options = []) protected function _getCreateTableSQL($name, array $columns, array $options = []): array
{ {
$sql = []; $sql = [];
$post_sql = []; $post_sql = [];
@ -113,7 +113,9 @@ class postgresql_platform extends PostgreSQLPlatform
} }
/** /**
* @param array $column * Return if column is a "serial" column, i.e. type supporting auto-increment
*
* @param array $column Column data
* @return bool * @return bool
*/ */
private function isSerialColumn(array $column): bool private function isSerialColumn(array $column): bool
@ -123,6 +125,12 @@ class postgresql_platform extends PostgreSQLPlatform
&& $this->isNumericType($column['type']); && $this->isNumericType($column['type']);
} }
/**
* Return if supplied type is of numeric type
*
* @param Type $type
* @return bool
*/
private function isNumericType(Type $type): bool private function isNumericType(Type $type): bool
{ {
return $type instanceof IntegerType || $type instanceof BigIntType || $type instanceof SmallIntType; return $type instanceof IntegerType || $type instanceof BigIntType || $type instanceof SmallIntType;
@ -131,21 +139,21 @@ class postgresql_platform extends PostgreSQLPlatform
/** /**
* {@inheritDoc} * {@inheritDoc}
*/ */
public function getListSequencesSQL($database) public function getListSequencesSQL($database): string
{ {
return "SELECT sequence_name AS relname, return "SELECT sequence_name AS relname,
sequence_schema AS schemaname, sequence_schema AS schemaname,
1 AS min_value, 1 AS min_value,
1 AS increment_by 1 AS increment_by
FROM information_schema.sequences FROM information_schema.sequences
WHERE sequence_schema NOT LIKE 'pg\_%' WHERE sequence_schema NOT LIKE 'pg\_%'
AND sequence_schema <> 'information_schema'"; AND sequence_schema <> 'information_schema'";
} }
/** /**
* {@inheritDoc} * {@inheritDoc}
*/ */
public function getDropIndexSQL($index, $table = null) public function getDropIndexSQL($index, $table = null): string
{ {
// If we have a primary or a unique index, we need to drop the constraint // If we have a primary or a unique index, we need to drop the constraint
// instead of the index itself or postgreSQL will reject the query. // instead of the index itself or postgreSQL will reject the query.

3
phpBB/phpbb/db/doctrine/table_helper.php
View file

@ -122,6 +122,9 @@ class table_helper
} }
} }
/**
* Private constructor. Call methods of table_helper statically.
*/
private function __construct() private function __construct()
{ {
} }

4
phpBB/phpbb/db/tools/doctrine.php
View file

@ -178,7 +178,7 @@ class doctrine implements tools_interface
{ {
if (empty($schema_changes)) if (empty($schema_changes))
{ {
return; return true;
} }
return $this->alter_schema( return $this->alter_schema(
@ -668,7 +668,7 @@ class doctrine implements tools_interface
{ {
if ($safe_check && $table->hasColumn($column_name)) if ($safe_check && $table->hasColumn($column_name))
{ {
return; return false;
} }
$dbms_name = $this->get_schema_manager()->getDatabasePlatform()->getName(); $dbms_name = $this->get_schema_manager()->getDatabasePlatform()->getName();