Skip to content

Fix docs for identifier config #784

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

Merged
LordSimal merged 1 commit into from
Apr 7, 2026
+87 −72
Merged

Fix docs for identifier config #784

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
25 changes: 10 additions & 15 deletions docs/en/authenticators.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,10 @@ You can also provide a fully custom identifier configuration if needed:
```php
$service->loadAuthenticator('Authentication.PrimaryKeySession', [
'identifier' => [
'Authentication.Token' => [
'tokenField' => 'id',
'dataField' => 'key',
'resolver' => 'Authentication.Orm',
],
'className' => 'Authentication.Token',
'tokenField' => 'id',
'dataField' => 'key',
'resolver' => 'Authentication.Orm',
],
]);
```
Expand Down Expand Up @@ -424,10 +423,9 @@ and similar SAML 1.1 implementations. An example configuration is:
// Configure a token identifier that maps `USER_ID` to the
// username column
$identifier = [
'Authentication.Token' => [
'tokenField' => 'username',
'dataField' => 'USER_NAME',
],
'className' => 'Authentication.Token',
'tokenField' => 'username',
'dataField' => 'USER_NAME',
];

$service->loadAuthenticator('Authentication.Environment', [
Expand Down Expand Up @@ -537,12 +535,9 @@ $service = new AuthenticationService();

// Define identifiers
$passwordIdentifier = [
'Authentication.Password' => [
'fields' => [
'username' => 'email',
'password' => 'password'
]
],
'className' => 'Authentication.Password',
'username' => 'email',
'password' => 'password'
];

// Load the authenticators leaving Basic as the last one.
Expand Down
103 changes: 49 additions & 54 deletions docs/en/identifiers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,22 @@ using the Password Identifier looks like:

```php
$identifier = [
'Authentication.Password' => [
'fields' => [
'username' => 'email',
'password' => 'passwd',
],
'resolver' => [
'className' => 'Authentication.Orm',
'userModel' => 'Users',
'finder' => 'active', // default: 'all'
],
'passwordHasher' => [
'className' => 'Authentication.Fallback',
'hashers' => [
'Authentication.Default' => [
'className' => 'Authentication.Legacy',
'hashType' => 'md5',
],
'className' => 'Authentication.Password',
'fields' => [
'username' => 'email',
'password' => 'passwd',
],
'resolver' => [
'className' => 'Authentication.Orm',
'userModel' => 'Users',
'finder' => 'active', // default: 'all'
],
'passwordHasher' => [
'className' => 'Authentication.Fallback',
'hashers' => [
'Authentication.Default' => [
'className' => 'Authentication.Legacy',
'hashType' => 'md5',
],
],
],
Expand Down Expand Up @@ -121,37 +120,35 @@ Callback identifiers can either return `null|ArrayAccess` for simple results, or
```php
// A simple callback identifier
$identifier = [
'Authentication.Callback' => [
'callback' => function($data) {
// do identifier logic

// Return an array of the identified user or null for failure.
if ($result) {
return $result;
}

return null;
},
]
'className' => 'Authentication.Callback',
'callback' => function($data) {
// do identifier logic

// Return an array of the identified user or null for failure.
if ($result) {
return $result;
}

return null;
},
];

// Using a result object to return error messages.
$identifier = [
'Authentication.Callback' => [
'callback' => function($data) {
// do identifier logic

if ($result) {
return new Result($result, Result::SUCCESS);
}

return new Result(
null,
Result::FAILURE_OTHER,
['message' => 'Removed user.']
);
},
],
'className' => 'Authentication.Callback',
'callback' => function($data) {
// do identifier logic

if ($result) {
return new Result($result, Result::SUCCESS);
}

return new Result(
null,
Result::FAILURE_OTHER,
['message' => 'Removed user.']
);
},
];
```

Expand Down Expand Up @@ -187,13 +184,12 @@ Resolver can be configured using `resolver` config option:

```php
$identifier = [
'Authentication.Password' => [
'resolver' => [
// can be a full class name: \Some\Other\Custom\Resolver::class
'className' => 'MyResolver',
// Pass additional options to the resolver constructor.
'option' => 'value',
],
'className' => 'Authentication.Password',
'resolver' => [
// can be a full class name: \Some\Other\Custom\Resolver::class
'className' => 'MyResolver',
// Pass additional options to the resolver constructor.
'option' => 'value',
],
];
```
Expand All @@ -203,8 +199,7 @@ Or pass the constructed resolver directly into the identifier configuration:
```php
$resolver = new \App\Identifier\Resolver\CustomResolver();
$identifier = [
'Authentication.Password' => [
'resolver' => $resolver,
],
'className' => 'Authentication.Password',
'resolver' => $resolver,
];
```
5 changes: 2 additions & 3 deletions docs/en/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,8 @@ public function getAuthenticationService(ServerRequestInterface $request): Authe
$service->loadAuthenticator('Authentication.Session');
$service->loadAuthenticator('Authentication.Form', [
'identifier' => [
'Authentication.Password' => [
'fields' => $fields,
],
'className' => 'Authentication.Password',
'fields' => $fields,
],
'fields' => $fields,
'loginUrl' => Router::url([
Expand Down
26 changes: 26 additions & 0 deletions docs/en/upgrade-3-to-4.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,17 @@ $authenticator = new FormAuthenticator(null);
$service->loadAuthenticator('Authentication.Form', [
'identifier' => 'Authentication.Password',
]);

// Option 4: Configure identifier in authenticator config with identifier options
$service->loadAuthenticator('Authentication.Form', [
'identifier' => [
'className' => 'Authentication.Password',
'fields' => [
'username' => 'email',
'password' => 'password',
],
],
]);
```

#### AuthenticationService Changes
Expand All @@ -62,6 +73,21 @@ $service->loadAuthenticator('Authentication.Form', [
]);
```

or

```php
$service = new AuthenticationService();
$service->loadAuthenticator('Authentication.Form', [
'identifier' => [
'className' => 'Authentication.Password',
'fields' => [
'username' => 'email',
'password' => 'password',
],
],
]);
```

### CREDENTIAL Constants Moved

The `CREDENTIAL_USERNAME` and `CREDENTIAL_PASSWORD` constants have been
Expand Down
Loading