Skip to content

Commit

Permalink
DOC Document deprecations for template layer refactor (silverstripe#594)
Browse files Browse the repository at this point in the history
  • Loading branch information
GuySartorelli authored and catharsisjelly committed Nov 1, 2024
1 parent c8a1be1 commit 1d1037a
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions en/08_Changelogs/5.4.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,44 @@ SilverStripe\ORM\FieldType\DBPolymorphicForeignKey:
- [`ContentReviewEmails::isValidEmail()`](api:SilverStripe\ContentReview\Tasks\ContentReviewEmails::isValidEmail()) has been deprecated. Use [`Email::is_valid_address()`](api:SilverStripe\Control\Email\Email::is_valid_address()) instead.
- The [`DBField.defaultVal`](api:SilverStripe\ORM\FieldType\DBField->defaultVal) property has been deprecated. Use [`DBField::getDefaultValue()`](api:SilverStripe\ORM\FieldType\DBField::getDefaultValue()) and [`DBField::setDefaultValue()`](api:SilverStripe\ORM\FieldType\DBField::setDefaultValue()) instead.
- [`DBFile::validate()`](api:SilverStripe\Assets\Storage\DBFile::validate()) has been deprecated. Use [`DBFile::validateFilename()`](api:SilverStripe\Assets\Storage\DBFile::validateFilename()) instead.
- [`ContentController::Menu()`](api:SilverStripe\CMS\Controllers\ContentController::Menu()) has been deprecated. Use [`ContentController::getMenu()`](api:SilverStripe\CMS\Controllers\ContentController::getMenu()) instead if calling the method in PHP. You can continue to use `$Menu` in templates, including passing arguments to it.
- [`GridFieldDataColumns::getValueFromRelation()`](api:SilverStripe\Forms\GridField\GridFieldDataColumns::getValueFromRelation()) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`ViewableData::castingClass()`](api:SilverStripe\View\ViewableData::castingClass()) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`ViewableData::escapeTypeForField()`](api:SilverStripe\View\ViewableData::escapeTypeForField()) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`ViewableData::objCacheName()`](api:SilverStripe\View\ViewableData::objCacheName()) has been deprecated. It will be made private. The corresponding [`ViewableData::objCacheSet()`](api:SilverStripe\View\ViewableData::objCacheSet()) and [`ViewableData::objCacheGet()`](api:SilverStripe\View\ViewableData::objCacheGet()) methods will change method signature to not require passing in the cache key.
- The `$cacheName` parameter for the [`ViewableData::obj()`](api:SilverStripe\View\ViewableData::obj()) method has been deprecated. It will be removed without equivalent functionality to replace it.
- [`ViewableData::cachedCall()`](api:SilverStripe\View\ViewableData::cachedCall()) has been deprecated. Use [`ViewableData::obj()`](api:SilverStripe\View\ViewableData::obj()) instead.
- [`ViewableData::XML_val()`](api:SilverStripe\View\ViewableData::XML_val()) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`ViewableData::getXMLValues()`](api:SilverStripe\View\ViewableData::getXMLValues()) has been deprecated. It will be removed without equivalent functionality to replace it.
- The `$parser` parameter for the [`SSViewer::__construct()`](api:SilverStripe\View\SSViewer::__construct()) method has been deprecated. It will be removed without equivalent functionality to replace it.
- [`SSViewer::flush()`](api:SilverStripe\View\SSViewer::flush()) has been deprecated. It will be replaced with `SilverStripe\View\SSTemplateEngine::flush()`.
- [`SSViewer::fromString()`](api:SilverStripe\View\SSViewer::fromString()) has been deprecated. It will be replaced with `SilverStripe\View\SSTemplateEngine::renderString()`.
- [`SSViewer::topLevel()`](api:SilverStripe\View\SSViewer::topLevel()) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`SSViewer::chooseTemplate()`](api:SilverStripe\View\SSViewer::chooseTemplate()) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`SSViewer::setTemplate()`](api:SilverStripe\View\SSViewer::setTemplate()) has been deprecated. It will be replaced with `SilverStripe\View\SSTemplateEngine::setTemplate()`.
- [`SSViewer::setParser()`](api:SilverStripe\View\SSViewer::setParser()) has been deprecated. It will be replaced with `SilverStripe\View\SSTemplateEngine::setParser()`.
- [`SSViewer::getParser()`](api:SilverStripe\View\SSViewer::getParser()) has been deprecated. It will be replaced with `SilverStripe\View\SSTemplateEngine::getParser()`.
- [`SSViewer::hasTemplate()`](api:SilverStripe\View\SSViewer::hasTemplate()) has been deprecated. It will be replaced with `SilverStripe\View\SSTemplateEngine::hasTemplate()`.
- [`SSViewer::exists()`](api:SilverStripe\View\SSViewer::exists()) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`SSViewer::getTemplateFileByType()`](api:SilverStripe\View\SSViewer::getTemplateFileByType()) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`SSViewer::flush_template_cache()`](api:SilverStripe\View\SSViewer::flush_template_cache()) has been deprecated. It will be replaced with `SilverStripe\View\SSTemplateEngine::flushTemplateCache()`.
- [`SSViewer::flush_cacheblock_cache()`](api:SilverStripe\View\SSViewer::flush_cacheblock_cache()) has been deprecated. It will be replaced with `SilverStripe\View\SSTemplateEngine::flushCacheBlockCache()`.
- [`SSViewer::setPartialCacheStore()`](api:SilverStripe\View\SSViewer::setPartialCacheStore()) has been deprecated. It will be replaced with `SilverStripe\View\SSTemplateEngine::setPartialCacheStore()`.
- [`SSViewer::getPartialCacheStore()`](api:SilverStripe\View\SSViewer::getPartialCacheStore()) has been deprecated. It will be replaced with `SilverStripe\View\SSTemplateEngine::getPartialCacheStore()`.
- [`SSViewer::includeGeneratedTemplate()`](api:SilverStripe\View\SSViewer::includeGeneratedTemplate()) has been deprecated. It will be replaced with `SilverStripe\View\SSTemplateEngine::includeGeneratedTemplate()`.
- The `$inheritedScope` parameter for the [SSViewer::process()](api:SilverStripe\View\SSViewer::process()) method has been deprecated. It will be removed without equivalent functionality to replace it.
- [`SSViewer::getSubtemplateFor()`](api:SilverStripe\View\SSViewer::getSubtemplateFor()) has been deprecated. It will be replaced with `SilverStripe\View\SSTemplateEngine::getSubtemplateFor()`.
- [`SSViewer::parseTemplateContent()`](api:SilverStripe\View\SSViewer::parseTemplateContent()) has been deprecated. It will be replaced with `SilverStripe\View\SSTemplateEngine::parseTemplateContent()`.
- [`SSViewer::templates()`](api:SilverStripe\View\SSViewer::templates()) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`SSViewer::setTemplateFile()`](api:SilverStripe\View\SSViewer::setTemplateFile()) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`SSViewer::get_base_tag()`](api:SilverStripe\View\SSViewer::get_base_tag()) has been deprecated. Use [`SSViewer::getBaseTag()`](api:SilverStripe\View\SSViewer::getBaseTag()) instead.
- [`SSViewer_DataPresenter`](api:SilverStripe\View\SSViewer_DataPresenter) has been deprecated. It will be merged back into [`SSViewer_Scope`](api:SilverStripe\View\SSViewer_Scope).
- [`SSViewer_FromString`](api:SilverStripe\View\SSViewer_FromString) has been deprecated. It will be replaced with `SilverStripe\View\SSTemplateEngine::renderString()`.
- [`SSViewer_Scope::getItem()`](api:SilverStripe\View\SSViewer_Scope::getItem()) has been deprecated. Use [`SSViewer_Scope::getCurrentItem()`](api:SilverStripe\View\SSViewer_Scope::getCurrentItem()) instead.
- [`SSViewer_Scope::obj()`](api:SilverStripe\View\SSViewer_Scope::obj()) has been deprecated. It will be renamed `scopeToIntermediateValue()`.
- [`SSViewer::execute_template()`](api:SilverStripe\View\SSViewer::execute_template()) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`SSViewer::execute_string()`](api:SilverStripe\View\SSViewer::execute_string()) has been deprecated. It will be removed without equivalent functionality to replace it.
- [`ThemeResourceLoader::findTemplate()`](api:SilverStripe\View\ThemeResourceLoader::findTemplate()) has been deprecated. It will be removed without equivalent functionality to replace it.

## Bug fixes

Expand Down

0 comments on commit 1d1037a

Please sign in to comment.