Skip to content

Commit

Permalink
DOC Document API deprecated in 4.13 (#180)
Browse files Browse the repository at this point in the history
  • Loading branch information
@GuySartorelli
GuySartorelli authored Mar 9, 2023
1 parent 9782a24 commit 31b6131
Showing 1 changed file with 52 additions and 8 deletions.
60 changes: 52 additions & 8 deletions en/04_Changelogs/4.13.0.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,61 @@ title: 4.13.0 (unreleased)
## Overview

- [API changes](#api-changes)
- [Removed API (by module, alphabetically)](#api-removed)
- [Deprecated API (by module, alphabetically)](#api-deprecated)

## API changes {#api-changes}

### Removed API (by module, alphabetically) {#api-removed}
### Deprecated API (by module, alphabetically) {#api-deprecated}

The following API have been deprecated in this minor release, and will be removed in a future major release. For API with a replacement, we recommend you update your code to use the replacement as part of your upgrade to Silverstripe CMS 4.13.0.

#### dnadesign/silverstripe-elemental

- Marked as deprecated class `DNADesign\Elemental\TopPage\TestState`. Will be removed without equivalent functionality to replace it in CMS 5.0.
- Marked as deprecated the following methods and they will be removed without equivalent functionality to replace it in CMS 5.0:
- `DNADesign\Elemental\TopPage::getTopPageUpdate()`
- `DNADesign\Elemental\TopPage::enableTopPageUpdate()`
- `DNADesign\Elemental\TopPage::disableTopPageUpdate()`
- `DNADesign\Elemental\TopPage::withTopPageUpdate()`
Deprecated class [`DNADesign\Elemental\TopPage\TestState`](api:DNADesign\Elemental\TopPage\TestState) Will be removed without equivalent functionality to replace it
Deprecated method [`DNADesign\Elemental\TopPage\DataExtension::getTopPageUpdate()`](api:DNADesign\Elemental\TopPage\DataExtension::getTopPageUpdate()) Will be removed without equivalent functionality to replace it
Deprecated method [`DNADesign\Elemental\TopPage\DataExtension::enableTopPageUpdate()`](api:DNADesign\Elemental\TopPage\DataExtension::enableTopPageUpdate()) Will be removed without equivalent functionality to replace it
Deprecated method [`DNADesign\Elemental\TopPage\DataExtension::disableTopPageUpdate()`](api:DNADesign\Elemental\TopPage\DataExtension::disableTopPageUpdate()) Will be removed without equivalent functionality to replace it
Deprecated method [`DNADesign\Elemental\TopPage\DataExtension::withTopPageUpdate()`](api:DNADesign\Elemental\TopPage\DataExtension::withTopPageUpdate()) Will be removed without equivalent functionality to replace it

#### silverstripe/cms

Deprecated class [`SilverStripe\CMS\Tasks\RemoveOrphanedPagesTask`](api:SilverStripe\CMS\Tasks\RemoveOrphanedPagesTask) Will be removed without equivalent functionality to replace it
Deprecated class [`SilverStripe\CMS\Tasks\MigrateSiteTreeLinkingTask`](api:SilverStripe\CMS\Tasks\MigrateSiteTreeLinkingTask) Will be removed without equivalent functionality to replace it
Deprecated class [`SilverStripe\CMS\Tasks\SiteTreeMaintenanceTask`](api:SilverStripe\CMS\Tasks\SiteTreeMaintenanceTask) Will be removed without equivalent functionality to replace it
Deprecated class [`SilverStripe\CMS\Controllers\SilverStripeNavigatorItem_Unversioned`](api:SilverStripe\CMS\Controllers\SilverStripeNavigatorItem_Unversioned) Will be renamed `SilverStripe\Admin\Navigator\SilverStripeNavigatorItem_Unversioned`
Deprecated class [`SilverStripe\CMS\Controllers\SilverStripeNavigatorItem_StageLink`](api:SilverStripe\CMS\Controllers\SilverStripeNavigatorItem_StageLink) Will be renamed `SilverStripe\VersionedAdmin\Navigator\SilverStripeNavigatorItem_StageLink`
Deprecated class [`SilverStripe\CMS\Controllers\SilverStripeNavigator`](api:SilverStripe\CMS\Controllers\SilverStripeNavigator) Will be renamed `SilverStripe\Admin\Navigator\SilverStripeNavigator`
Deprecated class [`SilverStripe\CMS\Controllers\SilverStripeNavigatorItem_LiveLink`](api:SilverStripe\CMS\Controllers\SilverStripeNavigatorItem_LiveLink) Will be renamed `SilverStripe\VersionedAdmin\Navigator\SilverStripeNavigatorItem_LiveLink`
Deprecated class [`SilverStripe\CMS\Controllers\SilverStripeNavigatorItem_ArchiveLink`](api:SilverStripe\CMS\Controllers\SilverStripeNavigatorItem_ArchiveLink) Will be renamed `SilverStripe\VersionedAdmin\Navigator\SilverStripeNavigatorItem_ArchiveLink`
Deprecated class [`SilverStripe\CMS\Controllers\SilverStripeNavigatorItem`](api:SilverStripe\CMS\Controllers\SilverStripeNavigatorItem) Will be renamed `SilverStripe\Admin\Navigator\SilverStripeNavigatorItem`

#### silverstripe/framework

Deprecated class [`SilverStripe\ORM\Map_Iterator`](api:SilverStripe\ORM\Map_Iterator) Will be removed without equivalent functionality to replace it
Deprecated class [`SilverStripe\ORM\Connect\PDOConnector`](api:SilverStripe\ORM\Connect\PDOConnector) Will be removed without equivalent functionality to replace it
Deprecated class [`SilverStripe\ORM\Connect\PDOQuery`](api:SilverStripe\ORM\Connect\PDOQuery) Will be removed without equivalent functionality to replace it
Deprecated class [`SilverStripe\ORM\Connect\PDOStatementHandle`](api:SilverStripe\ORM\Connect\PDOStatementHandle) Will be removed without equivalent functionality to replace it
Deprecated class [`SilverStripe\Dev\TestSession_STResponseWrapper`](api:SilverStripe\Dev\TestSession_STResponseWrapper) Will be removed without equivalent functionality to replace it
Deprecated class [`SilverStripe\Dev\CSVParser`](api:SilverStripe\Dev\CSVParser) Use League\Csv\Reader instead
Deprecated class [`SilverStripe\View\Parsers\Diff`](api:SilverStripe\View\Parsers\Diff) Will be replaced with `SilverStripe\View\Parsers\HtmlDiff`
Deprecated method [`SilverStripe\ORM\DataList::getGenerator()`](api:SilverStripe\ORM\DataList::getGenerator()) Will be removed without equivalent functionality to replace it
Deprecated method [`SilverStripe\ORM\Connect\Query::rewind()`](api:SilverStripe\ORM\Connect\Query::rewind()) Will be replaced by `getIterator()` in CMS 5
Deprecated method [`SilverStripe\ORM\Connect\Query::current()`](api:SilverStripe\ORM\Connect\Query::current()) Will be replaced by `getIterator()` in CMS 5
Deprecated method [`SilverStripe\ORM\Connect\Query::first()`](api:SilverStripe\ORM\Connect\Query::first()) Will be replaced by `getIterator()` in CMS 5
Deprecated method [`SilverStripe\ORM\Connect\Query::key()`](api:SilverStripe\ORM\Connect\Query::key()) Will be replaced by `getIterator()` in CMS 5
Deprecated method [`SilverStripe\ORM\Connect\Query::next()`](api:SilverStripe\ORM\Connect\Query::next()) Will be replaced by `getIterator()` in CMS 5
Deprecated method [`SilverStripe\ORM\Connect\Query::valid()`](api:SilverStripe\ORM\Connect\Query::valid()) Will be removed without equivalent functionality to replace it
Deprecated method [`SilverStripe\ORM\Connect\Query::nextRecord()`](api:SilverStripe\ORM\Connect\Query::nextRecord()) Will be replaced by `getIterator()` in CMS 5
Deprecated method [`SilverStripe\ORM\Connect\Query::seek()`](api:SilverStripe\ORM\Connect\Query::seek()) Will be replaced by `getIterator()` in CMS 5
Deprecated method [`SilverStripe\ORM\Connect\MySQLStatement::seek()`](api:SilverStripe\ORM\Connect\MySQLStatement::seek()) Will be replaced by `getIterator()` in CMS 5
Deprecated method [`SilverStripe\ORM\Connect\MySQLStatement::nextRecord()`](api:SilverStripe\ORM\Connect\MySQLStatement::nextRecord()) Will be replaced by `getIterator()` in CMS 5
Deprecated method [`SilverStripe\ORM\Connect\MySQLQuery::seek()`](api:SilverStripe\ORM\Connect\MySQLQuery::seek()) Will be replaced by `getIterator()` in CMS 5
Deprecated method [`SilverStripe\ORM\Connect\MySQLQuery::nextRecord()`](api:SilverStripe\ORM\Connect\MySQLQuery::nextRecord()) Will be replaced by `getIterator()` in CMS 5
Deprecated method [`SilverStripe\Core\BaseKernel::sessionEnvironment()`](api:SilverStripe\Core\BaseKernel::sessionEnvironment()) Will be removed without equivalent functionality to replace it
Deprecated method [`SilverStripe\Dev\TestMailer::saveEmail()`](api:SilverStripe\Dev\TestMailer::saveEmail()) Will be removed without equivalent functionality to replace it
Deprecated method [`SilverStripe\View\Parsers\Diff::cleanHTML()`](api:SilverStripe\View\Parsers\Diff::cleanHTML()) Will be removed without equivalent functionality
Deprecated method [`SilverStripe\View\Parsers\Diff::compareHTML()`](api:SilverStripe\View\Parsers\Diff::compareHTML()) Will be replaced with `SilverStripe\View\Parsers\HtmlDiff::compareHTML()`
Deprecated method [`SilverStripe\View\Parsers\Diff::getHTMLChunks()`](api:SilverStripe\View\Parsers\Diff::getHTMLChunks()) Will be removed without equivalent functionality
Deprecated method [`SilverStripe\Control\Email\Email::mergeConfiguredEmails()`](api:SilverStripe\Control\Email\Email::mergeConfiguredEmails()) Will be removed without equivalent functionality to replace it
Deprecated method [`SilverStripe\Control\HTTP::get_cache_age()`](api:SilverStripe\Control\HTTP::get_cache_age()) Will be removed without equivalent functionality to replace it
Deprecated config [`SilverStripe\Control\Director.alternate_public_dir`](api:SilverStripe\Control\Director.alternate_public_dir) Will be removed without equivalent functionality to replace it

0 comments on commit 31b6131

Please sign in to comment.