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

Jump to bottom

DOCS Document deprecated API and a few new features #580

Merged
merged 1 commit into from
Sep 13, 2024
Merged

DOCS Document deprecated API and a few new features #580

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
48 changes: 45 additions & 3 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 @@ -34,7 +34,13 @@ SilverStripe\ORM\FieldType\DBPolymorphicForeignKey:

### Other new features

- (fill this is as features are added)
- A new [`BaseKernel::getBooted()`](api:SilverStripe\Core\BaseKernel::getBooted()) method has been added for checking whether the kernel has been booted yet or not.
- A new [`CoreKernel::setBootDatabase()`](api:SilverStripe\Core\CoreKernel::setBootDatabase()) method has been added to replace the now deprecated [`DatabaselessKernel`](api:SilverStripe\Core\DatabaselessKernel) class.
- Two new methods have been added to [`ArrayLib`](api:SilverStripe\ORM\ArrayLib):
- [`ArrayLib::insertBefore()`](api:SilverStripe\ORM\ArrayLib::insertBefore()) for inserting a value before another value in an array
- [`ArrayLib::insertAfter()`](api:SilverStripe\ORM\ArrayLib::insertAfter()) for inserting a value after another value in an array
- A new [`DBDatetime::getTimeBetween()`](api:SilverStripe\ORM\FieldType\DBDatetime::getTimeBetween()) method has been added. This method returns the amount of time that has passed between two `DBDateTime` objects as a human-readable string.
- A new [`AbstractQueuedJob::getQueue()`](api:Symbiote\QueuedJobs\Services\AbstractQueuedJob::getQueue()) static method has been added to get the correct queue constant from a given string or int.
emteknetnz marked this conversation as resolved.
Show resolved Hide resolved

## API changes

Expand All @@ -55,11 +61,47 @@ SilverStripe\ORM\FieldType\DBPolymorphicForeignKey:
- [`SilverStripe\View\ViewableData`](api:SilverStripe\View\ViewableData) has been deprecated. It will be renamed to `SilverStripe\Model\ModelData`
- [`SilverStripe\View\ViewableData_Customised`](api:SilverStripe\View\ViewableData_Customised) has been deprecated. It will be renamed to `SilverStripe\Model\ModelDataCustomised`
- [`SilverStripe\View\ViewableData_Debugger`](api:SilverStripe\View\ViewableData_Debugger) has been deprecated. It will be renamed to `SilverStripe\Model\ModelDataDebugger`
- [`CliBypass`](api:SilverStripe\Control\Middleware\ConfirmationMiddleware\CliBypass) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`CliController`](api:SilverStripe\Control\CliController) has been deprecated. It will be replaced with `symfony/console` commands.
- [`DatabaselessKernel`](api:SilverStripe\Core\DatabaselessKernel) has been deprecated. Use [`CoreKernel::setBootDatabase()`](api:SilverStripe\Core\CoreKernel::setBootDatabase()) instead.
- [`BuildTask.segment`](api:SilverStripe\Dev\BuildTask->segment) has been deprecated. It will be replaced with a new `$commandName` property.
- [`BuildTask->description`](api:SilverStripe\Dev\BuildTask->description) has been deprecated. It will be replaced with a new static property with the same name.
- [`BuildTask::getDescription()`](api:SilverStripe\Dev\BuildTask::getDescription()) has been deprecated. It will be replaced with a new static method with the same name.
- [`DevBuildController`](api:SilverStripe\Dev\DevBuildController) has been deprecated. It will be replaced with a new `SilverStripe\Dev\Command\DbBuild` class.
- [`DevConfigController`](api:SilverStripe\Dev\DevConfigController) has been deprecated. It will be replaced with a new `SilverStripe\Dev\Command\ConfigDump` class.
- [`DatabaseAdmin`](api:SilverStripe\ORM\DatabaseAdmin) has been deprecated. It will be replaced with a new `SilverStripe\Dev\Command\DbBuild` class.
- [`DevelopmentAdmin::buildDefaults()`](api:SilverStripe\Dev\DevelopmentAdmin::buildDefaults()) has been deprecated. It will be replaced with a new `SilverStripe\Dev\Command\DbDefaults` class.
- [`DevelopmentAdmin::generatesecuretoken()`](api:SilverStripe\Dev\DevelopmentAdmin::generatesecuretoken()) has been deprecated. It will be replaced with a new `SilverStripe\Dev\Command\GenerateSecureToken` class.
- [`DevelopmentAdmin::getRegisteredController()`](api:SilverStripe\Dev\DevelopmentAdmin::getRegisteredController()) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`DevelopmentAdmin.registered_controllers`](api:SilverStripe\Dev\DevelopmentAdmin->registered_controllers) has been deprecated. It will be replaced with new `controllers` and `commands` configuration properties.
- [`CleanupTestDatabasesTask::canView()`](api:SilverStripe\Dev\Tasks\CleanupTestDatabasesTask::canView()) has been deprecated. It will be replaced with a new `canRunInBrowser()` method.
- [`HTTPOutputHandler`](api:SilverStripe\Logging\HTTPOutputHandler) has been deprecated. It will be renamed to `SilverStripe\Logging\ErrorOutputHandler`
Copy link
Member

Choose a reason for hiding this comment

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

A little weird that you also have HTTPOutputHandler.isCli() deprecated, which has a replacement - either don't deprecate it or mention it here

Copy link
Member Author

Choose a reason for hiding this comment

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

There's a lot of deprecations here, so forgetting one is understandable I think lol.
Added.

- [`Build`](api:SilverStripe\GraphQL\Dev\Build) has been deprecated. It will be replaced with a new `SilverStripe\GraphQL\Dev\SchemaBuild` class.
- [`DevelopmentAdmin`](api:SilverStripe\GraphQL\Dev\DevelopmentAdmin) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`DevBuildExtension`](api:SilverStripe\GraphQL\Extensions\DevBuildExtension) has been deprecated. It will be renamed to `SilverStripe\GraphQL\Extensions\DbBuildExtension`
- [`LDAPGroupSyncTask::log()`](api:SilverStripe\LDAP\Tasks\LDAPGroupSyncTask::log()) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`LDAPMemberSyncTask::log()`](api:SilverStripe\LDAP\Tasks\LDAPMemberSyncTask::log()) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`LDAPMigrateExistingMembersTask::log()`](api:SilverStripe\LDAP\Tasks\LDAPMigrateExistingMembersTask::log()) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`SubsiteCopyPagesTask::log()`](api:SilverStripe\Subsites\Tasks\SubsiteCopyPagesTask::log()) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`CheckExternalLinksTask::log()`](api:SilverStripe\ExternalLinks\Tasks\CheckExternalLinksTask::log()) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`CheckExternalLinksTask::setSilent()`](api:SilverStripe\ExternalLinks\Tasks\CheckExternalLinksTask::setSilent()) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`CheckExternalLinksTask->silent`](api:SilverStripe\ExternalLinks\Tasks\CheckExternalLinksTask->silent) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`RealMeSetupTask::message()`](api:SilverStripe\RealMe\Task\RealMeSetupTask::message()) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`StaticCacheFullBuildTask::log()`](api:SilverStripe\StaticPublishQueue\Task\StaticCacheFullBuildTask::log()) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`ContentReviewOwnerMigrationTask`](api:SilverStripe\ContentReview\Tasks\ContentReviewOwnerMigrationTask) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`CronTaskController`](api:SilverStripe\CronTask\Controllers\CronTaskController) has been deprecated. It will be replaced with a new `SilverStripe\CronTask\Cli\CronTaskCommand` class.
- [`Clear`](api:SilverStripe\GraphQLDevTools\Clear) has been deprecated. It will be replaced with a new `SilverStripe\GraphQLDevTools\SchemaClear` class.
- [`ConvertTranslatableTask`](api:TractorCow\Fluent\Task\ConvertTranslatableTask) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`Exception`](api:TractorCow\Fluent\Task\ConvertTranslatableTask\Exception) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`UpdatePackageInfoTask->supportedAddonsLoader`](api:BringYourOwnIdeas\Maintenance\Tasks\UpdatePackageInfoTask->supportedAddonsLoader) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`UpdatePackageInfoTask::getSupportedAddonsLoader()`](api:BringYourOwnIdeas\Maintenance\Tasks\UpdatePackageInfoTask::getSupportedAddonsLoader()) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`UpdatePackageInfoTask::setSupportedAddonsLoader()`](api:BringYourOwnIdeas\Maintenance\Tasks\UpdatePackageInfoTask::setSupportedAddonsLoader()) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`ProcessJobQueueChildTask`](api:Symbiote\QueuedJobs\Tasks\ProcessJobQueueChildTask) has been deprecated. It will be replaced with a new `Symbiote\QueuedJobs\Cli\ProcessJobQueueChildCommand` class.
- [`ProcessJobQueueTask::getQueue()`](api:Symbiote\QueuedJobs\Tasks\ProcessJobQueueTask::getQueue()) has been deprecated. Use [`AbstractQueuedJob::getQueue()`](api:Symbiote\QueuedJobs\Services\AbstractQueuedJob::getQueue()) instead.
- [`HTTPOutputHandler::isCli()`](api:SilverStripe\Logging\HTTPOutputHandler::isCli()) has been deprecated. Use [`Director::is_cli()`](api:SilverStripe\Control\Director::is_cli()) instead instead.

## Bug fixes

- (fill this is as bug fixes are added)

This release includes a number of bug fixes to improve a broad range of areas. Check the change logs for full details of these fixes split by module. Thank you to the community members that helped contribute these fixes as part of the release!

<!--- Changes below this line will be automatically regenerated -->
Expand Down
Loading