diff --git a/UPGRADES.md b/UPGRADES.md index 9b4e730b..90105ba7 100644 --- a/UPGRADES.md +++ b/UPGRADES.md @@ -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.