DOC Document deprecations related to CMSMain refactor (#651)

silverstripe · Dec 10, 2024 · 89f841c · 89f841c
1 parent f30b9b2
commit 89f841c
Showing 1 changed file with 46 additions and 0 deletions.
diff --git a/en/08_Changelogs/5.4.0.md b/en/08_Changelogs/5.4.0.md
@@ -210,6 +210,52 @@ The `SilverStripe\CMS\Model\SiteTree.DESCRIPTION` localisation key (along with t
 - [`CompositeValidator`](api:SilverStripe\Forms\CompositeValidator) has been deprecated. It will be renamed to `SilverStripe\Forms\Validation\CompositeValidator`.
 - [`UserFormsRequiredFields`](api:SilverStripe\UserForms\Form\UserFormsRequiredFields) has been deprecated. It will be renamed to `SilverStripe\UserForms\Form\UserFormsRequiredFieldsValidator`.
 - [`AWRequiredFields`](api:Symbiote\AdvancedWorkflow\Forms\AWRequiredFields) has been deprecated. It will be renamed to `Symbiote\AdvancedWorkflow\Forms\AWRequiredFieldsValidator`.
+- [`CMSPreviewable::CMSEditLink()`](api:SilverStripe\ORM\CMSPreviewable::CMSEditLink()) has been deprecated. It will be renamed to `getCMSEditLink()`.
+- [`CMSEditLinkExtension::CMSEditLink()`](api:SilverStripe\Admin\CMSEditLinkExtension::CMSEditLink()) has been deprecated. It will be replaced with `SilverStripe\ORM\DataObject::getCMSEditLink()` and `updateCMSEditLink()`.
+- [`LeftAndMain::currentPageID()`](api:SilverStripe\Admin\LeftAndMain::currentPageID()) has been deprecated. Use [`LeftAndMain::currentRecordID()`](api:SilverStripe\Admin\LeftAndMain::currentRecordID()) instead.
+- [`LeftAndMain::setCurrentPageID()`](api:SilverStripe\Admin\LeftAndMain::setCurrentPageID()) has been deprecated. Use [`LeftAndMain::setCurrentRecordID()`](api:SilverStripe\Admin\LeftAndMain::setCurrentRecordID()) instead.
+- [`LeftAndMain::currentPage()`](api:SilverStripe\Admin\LeftAndMain::currentPage()) has been deprecated. Use [`LeftAndMain::currentRecord()`](api:SilverStripe\Admin\LeftAndMain::currentRecord()) instead.
+- [`LeftAndMain::isCurrentPage()`](api:SilverStripe\Admin\LeftAndMain::isCurrentPage()) has been deprecated. Use [`LeftAndMain::isCurrentRecord()`](api:SilverStripe\Admin\LeftAndMain::isCurrentRecord()) instead.
+- [`LeftAndMain_SearchFilter::isPageIncluded()`](api:SilverStripe\Admin\LeftAndMain_SearchFilter::isPageIncluded()) has been deprecated. It will be renamed to `isRecordIncluded()`.
+- [`LeftAndMain_SearchFilter::getPageClasses()`](api:SilverStripe\Admin\LeftAndMain_SearchFilter::getPageClasses()) has been deprecated. It will be renamed to `getRecordClasses()`.
+- The [`SiteTree.need_permission`](api:SilverStripe\CMS\Model\SiteTree->need_permission) configuration property has been deprecated. Use [`SiteTree::canCreate()`](api:SilverStripe\CMS\Model\SiteTree::canCreate()) instead.
+- 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::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.
+- [`CMSMain::LinkPageSettings()`](api:SilverStripe\CMS\Controllers\CMSMain::LinkPageSettings()) has been deprecated. Use [`CMSMain::LinkRecordSettings()`](api:SilverStripe\CMS\Controllers\CMSMain::LinkRecordSettings()) instead.
+- [`CMSMain::LinkPageHistory()`](api:SilverStripe\CMS\Controllers\CMSMain::LinkPageHistory()) has been deprecated. Use [`CMSMain::LinkRecordHistory()`](api:SilverStripe\CMS\Controllers\CMSMain::LinkRecordHistory()) instead.
+- [`CMSMain::LinkPageAdd()`](api:SilverStripe\CMS\Controllers\CMSMain::LinkPageAdd()) has been deprecated. Use [`CMSMain::LinkRecordAdd()`](api:SilverStripe\CMS\Controllers\CMSMain::LinkRecordAdd()) instead.
+- [`CMSMain::LinkPreview()`](api:SilverStripe\CMS\Controllers\CMSMain::LinkPreview()) has been deprecated. Use [`SiteTree::CMSEditLink()`](api:SilverStripe\CMS\Model\SiteTree::CMSEditLink()) instead.
+- [`CMSMain::SiteTreeAsUL()`](api:SilverStripe\CMS\Controllers\CMSMain::SiteTreeAsUL()) has been deprecated. Use [`CMSMain::TreeAsUL()`](api:SilverStripe\CMS\Controllers\CMSMain::TreeAsUL()) instead.
+- [`CMSMain::getSiteTreeFor()`](api:SilverStripe\CMS\Controllers\CMSMain::getSiteTreeFor()) has been deprecated. Use [`CMSMain::getTreeFor()`](api:SilverStripe\CMS\Controllers\CMSMain::getTreeFor()) instead.
+- [`CMSMain::CanOrganiseSitetree()`](api:SilverStripe\CMS\Controllers\CMSMain::CanOrganiseSitetree()) has been deprecated. Use [`CMSMain::canOrganiseTree()`](api:SilverStripe\CMS\Controllers\CMSMain::canOrganiseTree()) instead.
+- [`CMSMain::getSearchContext()`](api:SilverStripe\CMS\Controllers\CMSMain::getSearchContext()) has been deprecated. It will be replaced with [`SiteTree::getDefaultSearchContext()`](api:SilverStripe\CMS\Model\SiteTree::getDefaultSearchContext()).
+- [`CMSMain::getPageTypes()`](api:SilverStripe\CMS\Controllers\CMSMain::getPageTypes()) has been deprecated. Use [`CMSMain::getRecordTypes()`](api:SilverStripe\CMS\Controllers\CMSMain::getRecordTypes()) instead.
+- [`CMSMain::PageTypes()`](api:SilverStripe\CMS\Controllers\CMSMain::PageTypes()) has been deprecated. Use [`CMSMain::RecordTypes()`](api:SilverStripe\CMS\Controllers\CMSMain::RecordTypes()) instead.
+- [`CMSMain::SiteTreeHints()`](api:SilverStripe\CMS\Controllers\CMSMain::SiteTreeHints()) has been deprecated. Use [`CMSMain::TreeHints()`](api:SilverStripe\CMS\Controllers\CMSMain::TreeHints()) instead.
+- [`CMSMain::performPublish()`](api:SilverStripe\CMS\Controllers\CMSMain::performPublish()) has been deprecated. Use [`RecursivePublishable::publishRecursive()`](api:SilverStripe\Versioned\RecursivePublishable::publishRecursive()) instead.
+- [`CMSPageAddController`](api:SilverStripe\CMS\Controllers\CMSPageAddController) has been deprecated. It will be replaced with `SilverStripe\CMS\Forms\CMSMainAddForm`.
+- [`CMSPagesController`](api:SilverStripe\CMS\Controllers\CMSPagesController) has been deprecated. It will be combined back into [`CMSMain`](api:SilverStripe\CMS\Controllers\CMSMain).
+- [`CMSSiteTreeFilter::getPageClasses()`](api:SilverStripe\CMS\Controllers\CMSSiteTreeFilter::getPageClasses()) has been deprecated. It will be renamed to `getRecordClasses()`.
+- [`CMSSiteTreeFilter::isPageIncluded()`](api:SilverStripe\CMS\Controllers\CMSSiteTreeFilter::isPageIncluded()) has been deprecated. It will be renamed to `isRecordIncluded()`.
+- [`LeftAndMainPageIconsExtension`](api:SilverStripe\CMS\Controllers\LeftAndMainPageIconsExtension) has been deprecated. It will be renamed to `SilverStripe\CMS\Controllers\LeftAndMainRecordIconsExtension`.
+- [`LeftAndMainPageIconsExtension::generatePageIconsCss()`](api:SilverStripe\CMS\Controllers\LeftAndMainPageIconsExtension::generatePageIconsCss()) has been deprecated. Use [`LeftAndMainPageIconsExtension::generateRecordIconsCss()`](api:SilverStripe\CMS\Controllers\LeftAndMainPageIconsExtension::generateRecordIconsCss()) instead.
+- [`CurrentPageIdentifier`](api:SilverStripe\CMS\Model\CurrentPageIdentifier) has been deprecated. It will be renamed to `SilverStripe\CMS\Model\CurrentRecordIdentifier`.
+- [`CurrentPageIdentifier::currentPageID()`](api:SilverStripe\CMS\Model\CurrentPageIdentifier::currentPageID()) has been deprecated. It will be renamed to `currentRecordID()`.
+- [`CurrentPageIdentifier::isCurrentPage()`](api:SilverStripe\CMS\Model\CurrentPageIdentifier::isCurrentPage()) has been deprecated. It will be renamed to `isCurrentRecord()`.
+- [`SiteTree::page_type_classes()`](api:SilverStripe\CMS\Model\SiteTree::page_type_classes()) has been deprecated. Will be replaced with `updateAllowedSubClasses()`.
+- [`SiteTree::setCreatableChildrenCache()`](api:SilverStripe\CMS\Model\SiteTree::setCreatableChildrenCache()) has been deprecated. It will be replaced with `SilverStripe\CMS\Controllers\CMSMain::setCreatableChildrenCache()`.
+- [`SiteTree::getCreatableChildrenCache()`](api:SilverStripe\CMS\Model\SiteTree::getCreatableChildrenCache()) has been deprecated. It will be replaced with `SilverStripe\CMS\Controllers\CMSMain::getCreatableChildrenCache()`.
+- [`SiteTree::getPermissionChecker()`](api:SilverStripe\CMS\Model\SiteTree::getPermissionChecker()) has been deprecated. It will be replaced with a non-static method of the same name.
+- [`SiteTree::flushMemberCache()`](api:SilverStripe\CMS\Model\SiteTree::flushMemberCache()) has been deprecated. It will be replaced with `SilverStripe\CMS\Controllers\CMSMain::clearCache()`.
+- [`SiteTree::creatableChildPages()`](api:SilverStripe\CMS\Model\SiteTree::creatableChildPages()) has been deprecated. It will be replaced with `SilverStripe\CMS\Controllers\CMSMain::getCreatableSubClasses()`.
+- [`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()`.
 
 ## Bug fixes