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

Add convenience method to get the identifier. #670

Merged
merged 1 commit into from
Jul 28, 2024
Merged

Add convenience method to get the identifier. #670

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
10 changes: 10 additions & 0 deletions src/Controller/Component/AuthenticationComponent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,16 @@ public function getResult(): ?ResultInterface
return $this->getAuthenticationService()->getResult();
}

/**
* Get the identifier (primary key) of the identity.
*
* @return array|string|int|null
*/
public function getIdentifier(): array|string|int|null
Copy link
Member

@dereuromark dereuromark Jul 26, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

The one not so nice thing about such a generic api is that array|scalar is always an issue for any app usage, in regards to developer or static analyzers.
Would be nice if there was a more concrete API to either get scalar or not, I always end up having to inline annotate everything that has such an API

  • getScalarIdentifier()
  • getArrayIdentifier() / getCompositeIdentifier()

etc as idea.

But I guess that is out of scope here. So no objections from me, just this remark.

Copy link
Member

Choose a reason for hiding this comment

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

The array part of this type is the problem imo. We've inherited that from the ORM though because we need to support composite primary keys 😢

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah the returns types are due to the possible pK values types. Addressing that would be a separate issue.

Copy link
Member

Choose a reason for hiding this comment

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

Well, there is an option to separate here as by my proposal, throwing exception in the other case.
Removing the need to delegate this check to the consumer.

But as mentioned, nothing that is important at this point. Just a though.

Copy link
Member

Choose a reason for hiding this comment

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

If we did narrow types here wouldn't we be left with partial support for composite primary keys? While the types are a bit annoying, I'd rather we have consistent support for composite primary keys over ergonomic types in one method.

{
return $this->getIdentity()?->getIdentifier();
}

/**
* Returns the identity used in the authentication attempt.
*
Expand Down
16 changes: 16 additions & 0 deletions tests/TestCase/Controller/Component/AuthenticationComponentTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,22 @@ public function testGetAuthenticationServiceInvalidServiceObject()
$component->getAuthenticationService();
}

public function testGetId(): void
{
$component = new AuthenticationComponent(new ComponentRegistry(new Controller($this->request)));
$this->assertNull($component->getIdentifier());

$request = $this->request
->withAttribute('identity', $this->identity)
->withAttribute('authentication', $this->service);

$controller = new Controller($request);
$registry = new ComponentRegistry($controller);
$component = new AuthenticationComponent($registry);

$this->assertSame($component->getIdentifier(), $this->identity->getIdentifier());
}

/**
* testGetIdentity
*
Expand Down
Loading