Skip to content
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

DOC Document newly deprecated API #662

Merged
merged 1 commit into from
Jan 7, 2025
Merged

DOC Document newly deprecated API #662

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
9 changes: 7 additions & 2 deletions en/08_Changelogs/5.4.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tidying this up while I'm here to be consistent with the other deprecation messages in this list

- [`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.
Expand Down Expand Up @@ -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.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tidying this up while I'm here - that method exists so we should link to it

- [`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

Expand Down
Loading