Skip to content

Commit 28f21e7

Browse files
authored
BC-break: remove deprecated single-string format for endpoints (#2131)
1 parent 8094447 commit 28f21e7

File tree

2 files changed

+3
-41
lines changed

2 files changed

+3
-41
lines changed

docs/simplesamlphp-metadata-endpoints.md

Lines changed: 1 addition & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -12,32 +12,7 @@ Endpoint | Indexed | Default binding
1212
`SingleLogoutService` | N | HTTP-Redirect
1313
`SingleSignOnService` | N | HTTP-Redirect
1414

15-
The various endpoints can be specified in three different ways:
16-
17-
* A single string.
18-
* Array of strings.
19-
* Array of arrays.
20-
21-
A single string
22-
---------------
23-
24-
'AssertionConsumerService' => 'https://sp.example.org/ACS',
25-
26-
This is the simplest endpoint format.
27-
It can be used when there is only a single endpoint that uses the default binding.
28-
29-
Array of strings
30-
----------------
31-
32-
'AssertionConsumerService' => [
33-
'https://site1.example.org/ACS',
34-
'https://site2.example.org/ACS',
35-
],
36-
37-
This endpoint format can be used to represent multiple endpoints, all of which use the default binding.
38-
39-
Array of arrays
40-
---------------
15+
The various endpoints can be specified in the following format:
4116

4217
'AssertionConsumerService' => [
4318
[

src/SimpleSAML/Configuration.php

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1210,28 +1210,15 @@ public function getEndpoints(string $endpointType): array
12101210

12111211

12121212
$eps = $this->configuration[$endpointType];
1213-
if (is_string($eps)) {
1214-
// for backwards-compatibility
1215-
$eps = [$eps];
1216-
} elseif (!is_array($eps)) {
1213+
if (!is_array($eps)) {
12171214
throw new Exception($loc . ': Expected array or string.');
12181215
}
12191216

12201217

12211218
foreach ($eps as $i => &$ep) {
12221219
$iloc = $loc . '[' . var_export($i, true) . ']';
12231220

1224-
if (is_string($ep)) {
1225-
// for backwards-compatibility
1226-
$ep = [
1227-
'Location' => $ep,
1228-
'Binding' => $this->getDefaultBinding($endpointType),
1229-
];
1230-
$responseLocation = $this->getOptionalString($endpointType . 'Response', null);
1231-
if ($responseLocation !== null) {
1232-
$ep['ResponseLocation'] = $responseLocation;
1233-
}
1234-
} elseif (!is_array($ep)) {
1221+
if (!is_array($ep)) {
12351222
throw new Exception($iloc . ': Expected a string or an array.');
12361223
}
12371224

0 commit comments

Comments
 (0)