From cc3379a15c3349ab033f715f2a74d16604726dac Mon Sep 17 00:00:00 2001 From: Guy Sartorelli <36352093+GuySartorelli@users.noreply.github.com> Date: Tue, 7 Jan 2025 13:48:46 +1300 Subject: [PATCH] DOC Document newly deprecated API (#662) --- en/08_Changelogs/5.4.0.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/en/08_Changelogs/5.4.0.md b/en/08_Changelogs/5.4.0.md index 910b175d..e7154d5b 100644 --- a/en/08_Changelogs/5.4.0.md +++ b/en/08_Changelogs/5.4.0.md @@ -222,7 +222,7 @@ The `SilverStripe\CMS\Model\SiteTree.DESCRIPTION` localisation key (along with t - The [`SiteTree.icon`](api:SilverStripe\CMS\Model\SiteTree->icon) configuration property has been deprecated. It will be renamed to `cms_icon`. - The [`SiteTree.icon_class`](api:SilverStripe\CMS\Model\SiteTree->icon_class) configuration property has been deprecated. It will be renamed to `cms_icon_class`. This applies to all subclasses of `SiteTree` as well. - [`CMSMain::PageList()`](api:SilverStripe\CMS\Controllers\CMSMain::PageList()) has been deprecated. It will be renamed to `RecordList()`. -- [`CMSMain::PageListSidebar()`](api:SilverStripe\CMS\Controllers\CMSMain::PageListSidebar()) has been deprecated. It will be removed without equivalent functionality. +- [`CMSMain::PageListSidebar()`](api:SilverStripe\CMS\Controllers\CMSMain::PageListSidebar()) has been deprecated. It will be removed without equivalent functionality to replace it. - [`CMSMain::LinkPages()`](api:SilverStripe\CMS\Controllers\CMSMain::LinkPages()) has been deprecated. Use [`CMSMain::LinkRecords()`](api:SilverStripe\CMS\Controllers\CMSMain::LinkRecords()) instead. - [`CMSMain::LinkPagesWithSearch()`](api:SilverStripe\CMS\Controllers\CMSMain::LinkPagesWithSearch()) has been deprecated. Use [`CMSMain::LinkRecordsWithSearch()`](api:SilverStripe\CMS\Controllers\CMSMain::LinkRecordsWithSearch()) instead. - [`CMSMain::LinkPageEdit()`](api:SilverStripe\CMS\Controllers\CMSMain::LinkPageEdit()) has been deprecated. Use [`CMSMain::LinkRecordEdit()`](api:SilverStripe\CMS\Controllers\CMSMain::LinkRecordEdit()) instead. @@ -256,7 +256,12 @@ The `SilverStripe\CMS\Model\SiteTree.DESCRIPTION` localisation key (along with t - [`SiteTree::getIconClass()`](api:SilverStripe\CMS\Model\SiteTree::getIconClass()) has been deprecated. It will be replaced with `SilverStripe\CMS\Controllers\CMSMain::getRecordIconCssClass()`. - [`SiteTree::getPageIconURL()`](api:SilverStripe\CMS\Model\SiteTree::getPageIconURL()) has been deprecated. It will be replaced with `SilverStripe\CMS\Controllers\CMSMain::getRecordIconUrl()`. - [`SiteTree::generateChildrenCacheKey()`](api:SilverStripe\CMS\Model\SiteTree::generateChildrenCacheKey()) has been deprecated. It will be replaced with `SilverStripe\CMS\Controllers\CMSMain::generateChildrenCacheKey()`. -- [`Form::validationResult()`](api:SilverStripe\Forms\Form::validationResult()) has been deprecated. Use `SilverStripe\Forms\Form::validate()` instead. +- [`Form::validationResult()`](api:SilverStripe\Forms\Form::validationResult()) has been deprecated. Use [`Form::validate()`](api:SilverStripe\Forms\Form::validate()) instead. +- [`Director::get_session_environment_type()`](api:SilverStripe\Control\Director::get_session_environment_type()) has been deprecated. Use [`Director::get_environment_type()`](api:SilverStripe\Control\Director::get_environment_type()) instead. +- Use of the `CUSTOM_INCLUDE_PATH` constant to change the PHP include path has been deprecated and will not work in a future major release. +- [`SessionEnvTypeSwitcher`](api:SilverStripe\Control\Middleware\URLSpecialsMiddleware\SessionEnvTypeSwitcher) has been deprecated. It will be removed without equivalent functionality to replace it. +- [`VersionProvider::getComposerLockPath()`](api:SilverStripe\Core\Manifest\VersionProvider::getComposerLockPath()) has been deprecated. It will be removed without equivalent functionality to replace it. +- [`FlushInvalidatedResource::getResource()`](api:SilverStripe\i18n\Messages\Symfony\FlushInvalidatedResource::getResource()) has been deprecated. It will be removed without equivalent functionality to replace it. ## Bug fixes