Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Added @template-extends to solve Psalm issues #745

Merged
merged 1 commit into from
Oct 31, 2023
Merged

Added @template-extends to solve Psalm issues #745

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions src/Options/DBALConfiguration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@

/**
* Configuration options for a DBAL Connection
*
* @template-extends AbstractOptions<mixed>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we be more precise here? 🤔

Copy link
Member Author

@driehle driehle Oct 15, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would need to be the supertype of all options stored in the container. Not sure if that's desirable? Talking about all affected containers, most options are string, but there's also bool and some other objects. I don't really see the point to use template types for AbstractOptions anyways, but that's obviously not me to decide. 😇

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you add ... to the array, you should be able to cover the whole supertype

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instructions unclear 🙈
Which array? 🤔

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The template type to add here, in theory , is array{foo: bar, ...}

Copy link
Member Author

@driehle driehle Oct 15, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe I am misunderstanding AbstractOptions somehow, but it's technically an iterable<string, TValue>. Therefore, the template TValue does not reflect the configuration array, as your snippet suggests, but rather is the type applicable to each option value. That's the reason why I am questioning the usefulness of the template as such.

Here, in this class, we have three options:

  • resultCache as string
  • sqlLogger as ?string
  • types as array or mixed[], though this could probably easily made more specific using the syntax you suggested

Therefore, we could use @template-extends AbstractOptions<null|string|array>, but since the relation between different options (i.e. keys) and their types is not preserved, I don't see much advantage in doing so. What is the benefit of being able to inject an array as resultCache type-wise, if that's not an allowed value?

*/
class DBALConfiguration extends AbstractOptions
{
Expand Down
2 changes: 2 additions & 0 deletions src/Options/DBALConnection.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

/**
* DBAL Connection options
*
* @template-extends AbstractOptions<mixed>
*/
final class DBALConnection extends AbstractOptions
{
Expand Down
3 changes: 3 additions & 0 deletions src/Options/EntityManager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@

use Laminas\Stdlib\AbstractOptions;

/**
* @template-extends AbstractOptions<mixed>
*/
final class EntityManager extends AbstractOptions
{
/**
Expand Down
3 changes: 3 additions & 0 deletions src/Options/EntityResolver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@
use function class_exists;
use function sprintf;

/**
* @template-extends AbstractOptions<mixed>
*/
final class EntityResolver extends AbstractOptions
{
/**
Expand Down
4 changes: 3 additions & 1 deletion src/Options/SQLLoggerCollectorOptions.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@
use Laminas\Stdlib\AbstractOptions;

/**
* Configuration options for an collector
* Configuration options for a collector
*
* @template-extends AbstractOptions<mixed>
*/
final class SQLLoggerCollectorOptions extends AbstractOptions
{
Expand Down
2 changes: 2 additions & 0 deletions src/Options/SecondLevelCacheConfiguration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@

/**
* Configuration options for Second Level Cache
*
* @template-extends AbstractOptions<mixed>
*/
final class SecondLevelCacheConfiguration extends AbstractOptions
{
Expand Down
Loading