Skip to content

Commit

Permalink
Update upgrades.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dbhynds committed Dec 15, 2023
1 parent 70743a4 commit 6b946df
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions UPGRADES.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,23 @@
## 5.6 to 5.7

No breaking changes were introduced. However, going forward when processing a `LtiOidcLogin`, it is recommended to use the new `getRedirectUrl()` method:

```php
// Do this:
$redirect = $oidcLogin->getRedirectUrl($request);
// Then do the redirect yourself (Laravel):
return redirect($redirect);
// Or some other method
header('Location: '.$this->location, true, 302);
exit;

// Instead of the old method:
$redirect = $oidcLogin->doOidcLoginRedirect($request);
$redirect->doRedirect();
```

The `LtiOidcLogin::doOidcLoginRedirect()` method and `Redirect` object will be deprecated in the next major version.

## 5.5 to 5.6

No breaking changes were introduced. However, going forward when processing a `LtiMessageLaunch`, it is recommended to do `$message->initialize($request);` instead of the previous `$message->validate($request);` to support potential migrations.
Expand Down

0 comments on commit 6b946df

Please sign in to comment.