Skip to content

Commit faafc17

Browse files
authored
Merge pull request #251 from simon-mundy/qa/final-typed-constants
Make public constants final and type NAMED_ADAPTER_KEY
2 parents 8b240cd + d5bcec9 commit faafc17

11 files changed

Lines changed: 39 additions & 45 deletions

File tree

‎analyzer-baseline.toml‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -138,12 +138,6 @@ code = "imprecise-type"
138138
message = "Type `array` in return type of `getDependencies` is imprecise, equivalent to `array<array-key, mixed>`."
139139
count = 1
140140

141-
[[issues]]
142-
file = "src/ConfigProvider.php"
143-
code = "missing-constant-type"
144-
message = "Class constant `NAMED_ADAPTER_KEY` is missing a type hint."
145-
count = 1
146-
147141
[[issues]]
148142
file = "src/Container/AbstractAdapterInterfaceFactory.php"
149143
code = "imprecise-type"

‎src/Adapter/AdapterInterface.php‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,20 +17,20 @@ interface AdapterInterface
1717
/**
1818
* Query Mode Constants
1919
*/
20-
public const string QUERY_MODE_EXECUTE = 'execute';
21-
public const string QUERY_MODE_PREPARE = 'prepare';
20+
final public const string QUERY_MODE_EXECUTE = 'execute';
21+
final public const string QUERY_MODE_PREPARE = 'prepare';
2222

2323
/**
2424
* Prepare Type Constants
2525
*/
26-
public const string PREPARE_TYPE_POSITIONAL = 'positional';
27-
public const string PREPARE_TYPE_NAMED = 'named';
26+
final public const string PREPARE_TYPE_POSITIONAL = 'positional';
27+
final public const string PREPARE_TYPE_NAMED = 'named';
2828

29-
public const string FUNCTION_FORMAT_PARAMETER_NAME = 'formatParameterName';
30-
public const string FUNCTION_QUOTE_IDENTIFIER = 'quoteIdentifier';
31-
public const string FUNCTION_QUOTE_VALUE = 'quoteValue';
29+
final public const string FUNCTION_FORMAT_PARAMETER_NAME = 'formatParameterName';
30+
final public const string FUNCTION_QUOTE_IDENTIFIER = 'quoteIdentifier';
31+
final public const string FUNCTION_QUOTE_VALUE = 'quoteValue';
3232

33-
public const string VALUE_QUOTE_SEPARATOR = 'quoteSeparator';
33+
final public const string VALUE_QUOTE_SEPARATOR = 'quoteSeparator';
3434

3535
/**
3636
* @param ParameterContainer|array<array-key, mixed> $initialParameters

‎src/Adapter/Driver/DriverInterface.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
*/
1212
interface DriverInterface
1313
{
14-
public const string PARAMETERIZATION_POSITIONAL = 'positional';
15-
public const string PARAMETERIZATION_NAMED = 'named';
14+
final public const string PARAMETERIZATION_POSITIONAL = 'positional';
15+
final public const string PARAMETERIZATION_NAMED = 'named';
1616

1717
/**
1818
* Check environment

‎src/Adapter/Driver/Pdo/Result.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@
2828
*/
2929
class Result implements Iterator, ResultInterface
3030
{
31-
public const string STATEMENT_MODE_SCROLLABLE = 'scrollable';
32-
public const string STATEMENT_MODE_FORWARD = 'forward';
31+
final public const string STATEMENT_MODE_SCROLLABLE = 'scrollable';
32+
final public const string STATEMENT_MODE_FORWARD = 'forward';
3333

3434
protected string $statementMode = self::STATEMENT_MODE_FORWARD;
3535

@@ -41,7 +41,7 @@ class Result implements Iterator, ResultInterface
4141
*
4242
* @var list<int>
4343
*/
44-
public const array VALID_FETCH_MODES = [
44+
final public const array VALID_FETCH_MODES = [
4545
PDO::FETCH_LAZY, // 1
4646
PDO::FETCH_ASSOC, // 2
4747
PDO::FETCH_NUM, // 3

‎src/Adapter/ParameterContainer.php‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@
3232
*/
3333
class ParameterContainer implements Iterator, ArrayAccess, Countable
3434
{
35-
public const string TYPE_AUTO = 'auto';
36-
public const string TYPE_NULL = 'null';
37-
public const string TYPE_DOUBLE = 'double';
38-
public const string TYPE_INTEGER = 'integer';
39-
public const string TYPE_BINARY = 'binary';
40-
public const string TYPE_STRING = 'string';
41-
public const string TYPE_LOB = 'lob';
35+
final public const string TYPE_AUTO = 'auto';
36+
final public const string TYPE_NULL = 'null';
37+
final public const string TYPE_DOUBLE = 'double';
38+
final public const string TYPE_INTEGER = 'integer';
39+
final public const string TYPE_BINARY = 'binary';
40+
final public const string TYPE_STRING = 'string';
41+
final public const string TYPE_LOB = 'lob';
4242

4343
/**
4444
* Data

‎src/ConfigProvider.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
final readonly class ConfigProvider
88
{
9-
public const NAMED_ADAPTER_KEY = 'adapters';
9+
public const string NAMED_ADAPTER_KEY = 'adapters';
1010

1111
public function getDependencies(): array
1212
{

‎src/Metadata/Source/AbstractSource.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@
9898
*/
9999
abstract class AbstractSource implements MetadataInterface
100100
{
101-
public const string DEFAULT_SCHEMA = '__DEFAULT_SCHEMA__';
101+
final public const string DEFAULT_SCHEMA = '__DEFAULT_SCHEMA__';
102102

103103
protected string $defaultSchema;
104104

‎src/ResultSet/ResultSet.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
class ResultSet extends AbstractResultSet implements ArrayObjectResultSetInterface
1919
{
2020
/** @deprecated use ResultSetReturnType */
21-
public const string TYPE_ARRAYOBJECT = 'arrayobject';
22-
public const string TYPE_ARRAY = 'array';
21+
final public const string TYPE_ARRAYOBJECT = 'arrayobject';
22+
final public const string TYPE_ARRAY = 'array';
2323

2424
private readonly ResultSetReturnType $returnType;
2525

‎src/Sql/SqlInterface.php‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ interface SqlInterface
1818
*
1919
* @see ArgumentType
2020
*/
21-
public const string TYPE_IDENTIFIER = 'identifier';
21+
final public const string TYPE_IDENTIFIER = 'identifier';
2222

23-
public const string TYPE_VALUE = 'value';
23+
final public const string TYPE_VALUE = 'value';
2424

25-
public const string TYPE_LITERAL = 'literal';
25+
final public const string TYPE_LITERAL = 'literal';
2626

27-
public const string TYPE_SELECT = 'select';
27+
final public const string TYPE_SELECT = 'select';
2828

2929
/**
3030
* Get SQL string for statement

‎src/TableGateway/Feature/EventFeatureEventsInterface.php‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,18 @@
1616
*/
1717
interface EventFeatureEventsInterface
1818
{
19-
public const string EVENT_PRE_INITIALIZE = 'preInitialize';
20-
public const string EVENT_POST_INITIALIZE = 'postInitialize';
19+
final public const string EVENT_PRE_INITIALIZE = 'preInitialize';
20+
final public const string EVENT_POST_INITIALIZE = 'postInitialize';
2121

22-
public const string EVENT_PRE_SELECT = 'preSelect';
23-
public const string EVENT_POST_SELECT = 'postSelect';
22+
final public const string EVENT_PRE_SELECT = 'preSelect';
23+
final public const string EVENT_POST_SELECT = 'postSelect';
2424

25-
public const string EVENT_PRE_INSERT = 'preInsert';
26-
public const string EVENT_POST_INSERT = 'postInsert';
25+
final public const string EVENT_PRE_INSERT = 'preInsert';
26+
final public const string EVENT_POST_INSERT = 'postInsert';
2727

28-
public const string EVENT_PRE_DELETE = 'preDelete';
29-
public const string EVENT_POST_DELETE = 'postDelete';
28+
final public const string EVENT_PRE_DELETE = 'preDelete';
29+
final public const string EVENT_POST_DELETE = 'postDelete';
3030

31-
public const string EVENT_PRE_UPDATE = 'preUpdate';
32-
public const string EVENT_POST_UPDATE = 'postUpdate';
31+
final public const string EVENT_PRE_UPDATE = 'preUpdate';
32+
final public const string EVENT_POST_UPDATE = 'postUpdate';
3333
}

0 commit comments

Comments
 (0)