mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-22 14:05:37 +02:00
Compare commits
2 Commits
985a3d3b5f
...
a6b0f6be15
| Author | SHA1 | Date | |
|---|---|---|---|
|
a6b0f6be15 | ||
|
044d44be8d |
@ -36,9 +36,8 @@
|
||||
"psr/container": "^1.1 || ^2.0",
|
||||
"psr/http-message": "^1",
|
||||
"sebastian/diff": "^4.0",
|
||||
"silverstripe/config": "^2.2",
|
||||
"silverstripe/config": "^2",
|
||||
"silverstripe/assets": "^2.3",
|
||||
"silverstripe/supported-modules": "^1.1",
|
||||
"silverstripe/vendor-plugin": "^2",
|
||||
"sminnee/callbacklist": "^0.1.1",
|
||||
"symfony/cache": "^6.1",
|
||||
|
||||
@ -4,6 +4,7 @@ namespace SilverStripe\Control;
|
||||
|
||||
use SilverStripe\Core\ClassInfo;
|
||||
use SilverStripe\Dev\Debug;
|
||||
use SilverStripe\Dev\Deprecation;
|
||||
use SilverStripe\ORM\FieldType\DBHTMLText;
|
||||
use SilverStripe\Security\Member;
|
||||
use SilverStripe\Security\Security;
|
||||
@ -19,6 +20,7 @@ use SilverStripe\View\TemplateGlobalProvider;
|
||||
*/
|
||||
class Controller extends RequestHandler implements TemplateGlobalProvider
|
||||
{
|
||||
|
||||
/**
|
||||
* An array of arguments extracted from the URL.
|
||||
*
|
||||
@ -454,7 +456,8 @@ class Controller extends RequestHandler implements TemplateGlobalProvider
|
||||
$class = static::class;
|
||||
while ($class != 'SilverStripe\\Control\\RequestHandler') {
|
||||
$templateName = strtok($class ?? '', '_') . '_' . $action;
|
||||
if (SSViewer::hasTemplate($templateName)) {
|
||||
$templateExists = Deprecation::withSuppressedNotice(fn() => SSViewer::hasTemplate($templateName));
|
||||
if ($templateExists) {
|
||||
return $class;
|
||||
}
|
||||
|
||||
@ -486,7 +489,7 @@ class Controller extends RequestHandler implements TemplateGlobalProvider
|
||||
$parentClass = get_parent_class($parentClass ?? '');
|
||||
}
|
||||
|
||||
return SSViewer::hasTemplate($templates);
|
||||
return Deprecation::withSuppressedNotice(fn() => SSViewer::hasTemplate($templates));
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@ -12,6 +12,7 @@ use SilverStripe\Core\Environment;
|
||||
use SilverStripe\Core\Extensible;
|
||||
use SilverStripe\Core\Injector\Injectable;
|
||||
use SilverStripe\Core\Injector\Injector;
|
||||
use SilverStripe\Dev\Deprecation;
|
||||
use SilverStripe\ORM\FieldType\DBField;
|
||||
use SilverStripe\View\ArrayData;
|
||||
use SilverStripe\View\Requirements;
|
||||
@ -402,9 +403,11 @@ class Email extends SymfonyEmail
|
||||
return $this->HTMLTemplate;
|
||||
}
|
||||
|
||||
return ThemeResourceLoader::inst()->findTemplate(
|
||||
SSViewer::get_templates_by_class(static::class, '', Email::class),
|
||||
SSViewer::get_themes()
|
||||
return Deprecation::withSuppressedNotice(
|
||||
fn() => ThemeResourceLoader::inst()->findTemplate(
|
||||
SSViewer::get_templates_by_class(static::class, '', Email::class),
|
||||
SSViewer::get_themes()
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
@ -3,14 +3,11 @@
|
||||
namespace SilverStripe\Dev;
|
||||
|
||||
use BadMethodCallException;
|
||||
use RuntimeException;
|
||||
use SilverStripe\Control\Director;
|
||||
use SilverStripe\Core\Environment;
|
||||
use SilverStripe\Core\Injector\InjectionCreator;
|
||||
use SilverStripe\Core\Injector\InjectorLoader;
|
||||
use SilverStripe\Core\Manifest\Module;
|
||||
use SilverStripe\Core\Path;
|
||||
use SilverStripe\SupportedModules\MetaData;
|
||||
|
||||
/**
|
||||
* Handles raising an notice when accessing a deprecated method, class, configuration, or behaviour.
|
||||
@ -80,18 +77,6 @@ class Deprecation
|
||||
*/
|
||||
private static bool $showNoReplacementNotices = false;
|
||||
|
||||
/**
|
||||
* @internal
|
||||
*/
|
||||
private static bool $showNoticesCalledFromSupportedCode = false;
|
||||
|
||||
/**
|
||||
* Cache of supported module directories, read from silverstripe/supported-modules repositories.json
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
private static array $supportedModuleDirectories = [];
|
||||
|
||||
/**
|
||||
* Enable throwing deprecation warnings. By default, this excludes warnings for
|
||||
* deprecated code which is called by core Silverstripe modules.
|
||||
@ -161,12 +146,6 @@ class Deprecation
|
||||
if (!$level) {
|
||||
$level = 1;
|
||||
}
|
||||
$called = Deprecation::get_called_from_trace($backtrace, $level);
|
||||
return ($called['class'] ?? '') . ($called['type'] ?? '') . ($called['function'] ?? '');
|
||||
}
|
||||
|
||||
private static function get_called_from_trace(array $backtrace, int $level): array
|
||||
{
|
||||
$newLevel = $level;
|
||||
// handle closures inside withSuppressedNotice()
|
||||
if (Deprecation::$insideNoticeSuppression
|
||||
@ -184,51 +163,8 @@ class Deprecation
|
||||
if ($level == 4 && ($backtrace[$newLevel]['class'] ?? '') === InjectionCreator::class) {
|
||||
$newLevel = $newLevel + 4;
|
||||
}
|
||||
// handle noticeWithNoReplacment()
|
||||
foreach ($backtrace as $trace) {
|
||||
if (($trace['class'] ?? '') === Deprecation::class
|
||||
&& ($trace['function'] ?? '') === 'noticeWithNoReplacment'
|
||||
) {
|
||||
$newLevel = $newLevel + 1;
|
||||
break;
|
||||
}
|
||||
}
|
||||
$called = $backtrace[$newLevel] ?? [];
|
||||
return $called;
|
||||
}
|
||||
|
||||
private static function isCalledFromSupportedCode(array $backtrace): bool
|
||||
{
|
||||
$called = Deprecation::get_called_from_trace($backtrace, 1);
|
||||
$file = $called['file'] ?? '';
|
||||
if (!$file) {
|
||||
return false;
|
||||
}
|
||||
return Deprecation::fileIsInSupportedModule($file);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check whether a file (path to file) is in a supported module
|
||||
*/
|
||||
public static function fileIsInSupportedModule(string $file): bool
|
||||
{
|
||||
// Cache the supported modules list
|
||||
if (count(Deprecation::$supportedModuleDirectories) === 0) {
|
||||
// Do not make a network request when fetching metadata which could slow down a website
|
||||
// While there is a small risk of the list being out of date, there is minimal downside to this
|
||||
$metaData = MetaData::getAllRepositoryMetaData(fromRemote: false);
|
||||
$dirs = array_map(fn($module) => "/vendor/{$module['packagist']}/", $metaData['supportedModules']);
|
||||
// This is a special case for silverstripe-framework when running in CI
|
||||
// Needed because module is run in the root folder rather than in the vendor folder
|
||||
$dirs[] = '/silverstripe-framework/';
|
||||
Deprecation::$supportedModuleDirectories = $dirs;
|
||||
}
|
||||
foreach (Deprecation::$supportedModuleDirectories as $dir) {
|
||||
if (str_contains($file, $dir)) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
return ($called['class'] ?? '') . ($called['type'] ?? '') . ($called['function'] ?? '');
|
||||
}
|
||||
|
||||
public static function isEnabled(): bool
|
||||
@ -309,22 +245,6 @@ class Deprecation
|
||||
return Deprecation::$shouldShowForCli;
|
||||
}
|
||||
|
||||
/**
|
||||
* If true, deprecation warnings will be shown for deprecated code which is called by core Silverstripe modules.
|
||||
*/
|
||||
public static function getShowNoticesCalledFromSupportedCode(): bool
|
||||
{
|
||||
return Deprecation::$showNoticesCalledFromSupportedCode;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set whether deprecation warnings will be shown for deprecated code which is called by core Silverstripe modules.
|
||||
*/
|
||||
public static function setShowNoticesCalledFromSupportedCode(bool $value): void
|
||||
{
|
||||
Deprecation::$showNoticesCalledFromSupportedCode = $value;
|
||||
}
|
||||
|
||||
public static function outputNotices(): void
|
||||
{
|
||||
if (!Deprecation::isEnabled()) {
|
||||
@ -338,13 +258,9 @@ class Deprecation
|
||||
$arr = array_shift(Deprecation::$userErrorMessageBuffer);
|
||||
$message = $arr['message'];
|
||||
$calledWithNoticeSuppression = $arr['calledWithNoticeSuppression'];
|
||||
$isCalledFromSupportedCode = $arr['isCalledFromSupportedCode'];
|
||||
if ($calledWithNoticeSuppression && !Deprecation::$showNoReplacementNotices) {
|
||||
continue;
|
||||
}
|
||||
if ($isCalledFromSupportedCode && !Deprecation::$showNoticesCalledFromSupportedCode) {
|
||||
continue;
|
||||
}
|
||||
Deprecation::$isTriggeringError = true;
|
||||
user_error($message, E_USER_DEPRECATED);
|
||||
Deprecation::$isTriggeringError = false;
|
||||
@ -378,10 +294,6 @@ class Deprecation
|
||||
$data = [
|
||||
'key' => sha1($string),
|
||||
'message' => $string,
|
||||
// Setting to `false` as here as any SCOPE_CONFIG notices from supported modules have
|
||||
// already been filtered out if needed if they came from a supported module in
|
||||
// SilverStripe\Config\Transformer\YamlTransformer::checkForDeprecatedConfig()
|
||||
'isCalledFromSupportedCode' => false,
|
||||
'calledWithNoticeSuppression' => Deprecation::$insideNoticeSuppression
|
||||
];
|
||||
} else {
|
||||
@ -410,13 +322,13 @@ class Deprecation
|
||||
|
||||
$level = Deprecation::$insideNoticeSuppression ? 4 : 2;
|
||||
$string .= " Called from " . Deprecation::get_called_method_from_trace($backtrace, $level) . '.';
|
||||
|
||||
if ($caller) {
|
||||
$string = $caller . ' is deprecated.' . ($string ? ' ' . $string : '');
|
||||
}
|
||||
$data = [
|
||||
'key' => sha1($string),
|
||||
'message' => $string,
|
||||
'isCalledFromSupportedCode' => Deprecation::isCalledFromSupportedCode($backtrace),
|
||||
'calledWithNoticeSuppression' => Deprecation::$insideNoticeSuppression
|
||||
];
|
||||
}
|
||||
@ -448,23 +360,6 @@ class Deprecation
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Shorthand method to create a suppressed notice for something with no immediate replacement.
|
||||
* If $message is empty, then a standardised message will be used
|
||||
*/
|
||||
public static function noticeWithNoReplacment(
|
||||
string $atVersion,
|
||||
string $message = '',
|
||||
int $scope = Deprecation::SCOPE_METHOD
|
||||
): void {
|
||||
if ($message === '') {
|
||||
$message = 'Will be removed without equivalent functionality to replace it.';
|
||||
}
|
||||
Deprecation::withSuppressedNotice(
|
||||
fn() => Deprecation::notice($atVersion, $message, $scope)
|
||||
);
|
||||
}
|
||||
|
||||
private static function varAsBoolean($val): bool
|
||||
{
|
||||
if (is_string($val)) {
|
||||
|
||||
@ -17,6 +17,7 @@ use SilverStripe\View\ArrayData;
|
||||
use SilverStripe\View\SSViewer;
|
||||
use LogicException;
|
||||
use SilverStripe\Control\HTTPResponse_Exception;
|
||||
use SilverStripe\Dev\Deprecation;
|
||||
|
||||
/**
|
||||
* This class is is responsible for adding objects to another object's has_many
|
||||
@ -283,7 +284,7 @@ class GridFieldAddExistingAutocompleter extends AbstractGridFieldComponent imple
|
||||
$json = [];
|
||||
Config::nest();
|
||||
SSViewer::config()->set('source_file_comments', false);
|
||||
$viewer = SSViewer::fromString($this->resultsFormat);
|
||||
$viewer = Deprecation::withSuppressedNotice(fn() => SSViewer::fromString($this->resultsFormat));
|
||||
foreach ($results as $result) {
|
||||
if (!$result->canView()) {
|
||||
continue;
|
||||
|
||||
@ -240,7 +240,7 @@ class GridFieldDataColumns extends AbstractGridFieldComponent implements GridFie
|
||||
$methodName = $fieldNameParts[$idx];
|
||||
// Last mmethod call from $columnName return what that method is returning
|
||||
if ($idx == sizeof($fieldNameParts ?? []) - 1) {
|
||||
return $tmpItem->XML_val($methodName);
|
||||
return Deprecation::withSuppressedNotice(fn() => $tmpItem->XML_val($methodName));
|
||||
}
|
||||
// else get the object from this $methodName
|
||||
$tmpItem = $tmpItem->$methodName();
|
||||
|
||||
@ -8,6 +8,7 @@ use SilverStripe\Forms\TextareaField;
|
||||
use SilverStripe\ORM\DataObject;
|
||||
use SilverStripe\ORM\DataObjectInterface;
|
||||
use Exception;
|
||||
use SilverStripe\Dev\Deprecation;
|
||||
use SilverStripe\View\Parsers\HTMLValue;
|
||||
|
||||
/**
|
||||
@ -129,7 +130,9 @@ class HTMLEditorField extends TextareaField
|
||||
*/
|
||||
public function saveInto(DataObjectInterface $record)
|
||||
{
|
||||
if ($record->hasField($this->name) && $record->escapeTypeForField($this->name) != 'xml') {
|
||||
if ($record->hasField($this->name)
|
||||
&& Deprecation::withSuppressedNotice(fn () => $record->escapeTypeForField($this->name)) != 'xml'
|
||||
) {
|
||||
throw new Exception(
|
||||
'HTMLEditorField->saveInto(): This field should save into a HTMLText or HTMLVarchar field.'
|
||||
);
|
||||
|
||||
@ -13,8 +13,7 @@ class DBBoolean extends DBField
|
||||
{
|
||||
public function __construct($name = null, $defaultVal = 0)
|
||||
{
|
||||
$defaultValue = $defaultVal ? 1 : 0;
|
||||
$this->setDefaultValue($defaultValue);
|
||||
$this->defaultVal = ($defaultVal) ? 1 : 0;
|
||||
|
||||
parent::__construct($name);
|
||||
}
|
||||
@ -26,7 +25,7 @@ class DBBoolean extends DBField
|
||||
'precision' => 1,
|
||||
'sign' => 'unsigned',
|
||||
'null' => 'not null',
|
||||
'default' => $this->getDefaultValue(),
|
||||
'default' => $this->defaultVal,
|
||||
'arrayValue' => $this->arrayValue
|
||||
];
|
||||
$values = ['type' => 'boolean', 'parts' => $parts];
|
||||
|
||||
@ -122,7 +122,6 @@ abstract class DBField extends ViewableData implements DBIndexable
|
||||
* @var $default mixed Default-value in the database.
|
||||
* Might be overridden on DataObject-level, but still useful for setting defaults on
|
||||
* already existing records after a db-build.
|
||||
* @deprecated 5.4.0 Use getDefaultValue() and setDefaultValue() instead
|
||||
*/
|
||||
protected $defaultVal;
|
||||
|
||||
|
||||
@ -13,8 +13,7 @@ class DBFloat extends DBField
|
||||
|
||||
public function __construct($name = null, $defaultVal = 0)
|
||||
{
|
||||
$defaultValue = is_float($defaultVal) ? $defaultVal : (float) 0;
|
||||
$this->setDefaultValue($defaultValue);
|
||||
$this->defaultVal = is_float($defaultVal) ? $defaultVal : (float) 0;
|
||||
|
||||
parent::__construct($name);
|
||||
}
|
||||
@ -24,7 +23,7 @@ class DBFloat extends DBField
|
||||
$parts = [
|
||||
'datatype' => 'float',
|
||||
'null' => 'not null',
|
||||
'default' => $this->getDefaultValue(),
|
||||
'default' => $this->defaultVal,
|
||||
'arrayValue' => $this->arrayValue
|
||||
];
|
||||
$values = ['type' => 'float', 'parts' => $parts];
|
||||
|
||||
@ -15,8 +15,7 @@ class DBInt extends DBField
|
||||
|
||||
public function __construct($name = null, $defaultVal = 0)
|
||||
{
|
||||
$defaultValue = is_int($defaultVal) ? $defaultVal : 0;
|
||||
$this->setDefaultValue($defaultValue);
|
||||
$this->defaultVal = is_int($defaultVal) ? $defaultVal : 0;
|
||||
|
||||
parent::__construct($name);
|
||||
}
|
||||
@ -44,7 +43,7 @@ class DBInt extends DBField
|
||||
'datatype' => 'int',
|
||||
'precision' => 11,
|
||||
'null' => 'not null',
|
||||
'default' => $this->getDefaultValue(),
|
||||
'default' => $this->defaultVal,
|
||||
'arrayValue' => $this->arrayValue
|
||||
];
|
||||
$values = ['type' => 'int', 'parts' => $parts];
|
||||
|
||||
@ -193,11 +193,11 @@ class SSViewer implements Flushable
|
||||
public function __construct($templates, TemplateParser $parser = null)
|
||||
{
|
||||
if ($parser) {
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'The $parser parameter is deprecated and will be removed');
|
||||
$this->setParser($parser);
|
||||
Deprecation::notice('5.4.0', 'The $parser parameter is deprecated and will be removed');
|
||||
Deprecation::withSuppressedNotice(fn() => $this->setParser($parser));
|
||||
}
|
||||
|
||||
$this->setTemplate($templates);
|
||||
Deprecation::withSuppressedNotice(fn() => $this->setTemplate($templates));
|
||||
|
||||
if (!$this->chosen) {
|
||||
$message = 'None of the following templates could be found: ';
|
||||
@ -220,9 +220,11 @@ class SSViewer implements Flushable
|
||||
*/
|
||||
public static function flush()
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::flush()');
|
||||
SSViewer::flush_template_cache(true);
|
||||
SSViewer::flush_cacheblock_cache(true);
|
||||
Deprecation::withSuppressedNotice(function () {
|
||||
Deprecation::notice('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::flush()');
|
||||
SSViewer::flush_template_cache(true);
|
||||
SSViewer::flush_cacheblock_cache(true);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
@ -235,8 +237,8 @@ class SSViewer implements Flushable
|
||||
*/
|
||||
public static function fromString($content, $cacheTemplate = null)
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::renderString()');
|
||||
$viewer = SSViewer_FromString::create($content);
|
||||
Deprecation::notice('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::renderString()');
|
||||
$viewer = Deprecation::withSuppressedNotice(fn() => SSViewer_FromString::create($content));
|
||||
if ($cacheTemplate !== null) {
|
||||
$viewer->setCacheTemplate($cacheTemplate);
|
||||
}
|
||||
@ -342,7 +344,7 @@ class SSViewer implements Flushable
|
||||
*/
|
||||
public static function topLevel()
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be removed without equivalent functionality to replace it.');
|
||||
Deprecation::notice('5.4.0', 'Will be removed without equivalent functionality to replace it.');
|
||||
if (SSViewer::$topLevel) {
|
||||
return SSViewer::$topLevel[sizeof(SSViewer::$topLevel)-1];
|
||||
}
|
||||
@ -404,7 +406,7 @@ class SSViewer implements Flushable
|
||||
*/
|
||||
public function setTemplate($templates)
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::setTemplate()');
|
||||
Deprecation::notice('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::setTemplate()');
|
||||
$this->templates = $templates;
|
||||
$this->chosen = $this->chooseTemplate($templates);
|
||||
$this->subTemplates = [];
|
||||
@ -419,8 +421,10 @@ class SSViewer implements Flushable
|
||||
*/
|
||||
public static function chooseTemplate($templates)
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be removed without equivalent functionality to replace it');
|
||||
return ThemeResourceLoader::inst()->findTemplate($templates, SSViewer::get_themes());
|
||||
Deprecation::notice('5.4.0', 'Will be removed without equivalent functionality to replace it');
|
||||
return Deprecation::withSuppressedNotice(
|
||||
fn() => ThemeResourceLoader::inst()->findTemplate($templates, SSViewer::get_themes())
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
@ -431,7 +435,7 @@ class SSViewer implements Flushable
|
||||
*/
|
||||
public function setParser(TemplateParser $parser)
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::setParser()');
|
||||
Deprecation::notice('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::setParser()');
|
||||
$this->parser = $parser;
|
||||
}
|
||||
|
||||
@ -443,9 +447,11 @@ class SSViewer implements Flushable
|
||||
*/
|
||||
public function getParser()
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::getParser()');
|
||||
Deprecation::notice('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::getParser()');
|
||||
if (!$this->parser) {
|
||||
$this->setParser(Injector::inst()->get('SilverStripe\\View\\SSTemplateParser'));
|
||||
Deprecation::withSuppressedNotice(
|
||||
fn() => $this->setParser(Injector::inst()->get('SilverStripe\\View\\SSTemplateParser'))
|
||||
);
|
||||
}
|
||||
return $this->parser;
|
||||
}
|
||||
@ -460,8 +466,10 @@ class SSViewer implements Flushable
|
||||
*/
|
||||
public static function hasTemplate($templates)
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::hasTemplate()');
|
||||
return (bool)ThemeResourceLoader::inst()->findTemplate($templates, SSViewer::get_themes());
|
||||
Deprecation::notice('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::hasTemplate()');
|
||||
return Deprecation::withSuppressedNotice(
|
||||
fn() => (bool)ThemeResourceLoader::inst()->findTemplate($templates, SSViewer::get_themes())
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
@ -481,7 +489,7 @@ class SSViewer implements Flushable
|
||||
*/
|
||||
public function exists()
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be removed without equivalent functionality to replace it');
|
||||
Deprecation::notice('5.4.0', 'Will be removed without equivalent functionality to replace it');
|
||||
return $this->chosen;
|
||||
}
|
||||
|
||||
@ -493,8 +501,10 @@ class SSViewer implements Flushable
|
||||
*/
|
||||
public static function getTemplateFileByType($identifier, $type = null)
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be removed without equivalent functionality to replace it');
|
||||
return ThemeResourceLoader::inst()->findTemplate(['type' => $type, $identifier], SSViewer::get_themes());
|
||||
Deprecation::notice('5.4.0', 'Will be removed without equivalent functionality to replace it');
|
||||
return Deprecation::withSuppressedNotice(
|
||||
fn() => ThemeResourceLoader::inst()->findTemplate(['type' => $type, $identifier], SSViewer::get_themes())
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
@ -508,7 +518,7 @@ class SSViewer implements Flushable
|
||||
*/
|
||||
public static function flush_template_cache($force = false)
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::flushTemplateCache()');
|
||||
Deprecation::notice('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::flushTemplateCache()');
|
||||
if (!SSViewer::$template_cache_flushed || $force) {
|
||||
$dir = dir(TEMP_PATH);
|
||||
while (false !== ($file = $dir->read())) {
|
||||
@ -531,7 +541,7 @@ class SSViewer implements Flushable
|
||||
*/
|
||||
public static function flush_cacheblock_cache($force = false)
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::flushCacheBlockCache()');
|
||||
Deprecation::notice('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::flushCacheBlockCache()');
|
||||
if (!SSViewer::$cacheblock_cache_flushed || $force) {
|
||||
$cache = Injector::inst()->get(CacheInterface::class . '.cacheblock');
|
||||
$cache->clear();
|
||||
@ -549,7 +559,7 @@ class SSViewer implements Flushable
|
||||
*/
|
||||
public function setPartialCacheStore($cache)
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::setPartialCacheStore()');
|
||||
Deprecation::notice('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::setPartialCacheStore()');
|
||||
$this->partialCacheStore = $cache;
|
||||
}
|
||||
|
||||
@ -561,7 +571,7 @@ class SSViewer implements Flushable
|
||||
*/
|
||||
public function getPartialCacheStore()
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::getPartialCacheStore()');
|
||||
Deprecation::notice('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::getPartialCacheStore()');
|
||||
if ($this->partialCacheStore) {
|
||||
return $this->partialCacheStore;
|
||||
}
|
||||
@ -595,7 +605,7 @@ class SSViewer implements Flushable
|
||||
*/
|
||||
protected function includeGeneratedTemplate($cacheFile, $item, $overlay, $underlay, $inheritedScope = null)
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::includeGeneratedTemplate()');
|
||||
Deprecation::notice('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::includeGeneratedTemplate()');
|
||||
if (isset($_GET['showtemplate']) && $_GET['showtemplate'] && Permission::check('ADMIN')) {
|
||||
$lines = file($cacheFile ?? '');
|
||||
echo "<h2>Template: $cacheFile</h2>";
|
||||
@ -606,8 +616,10 @@ class SSViewer implements Flushable
|
||||
echo "</pre>";
|
||||
}
|
||||
|
||||
$cache = $this->getPartialCacheStore();
|
||||
$scope = new SSViewer_DataPresenter($item, $overlay, $underlay, $inheritedScope);
|
||||
$cache = Deprecation::withSuppressedNotice(fn() => $this->getPartialCacheStore());
|
||||
$scope = Deprecation::withSuppressedNotice(
|
||||
fn() => new SSViewer_DataPresenter($item, $overlay, $underlay, $inheritedScope)
|
||||
);
|
||||
$val = '';
|
||||
|
||||
// Placeholder for values exposed to $cacheFile
|
||||
@ -636,7 +648,9 @@ class SSViewer implements Flushable
|
||||
public function process($item, $arguments = null, $inheritedScope = null)
|
||||
{
|
||||
if ($inheritedScope !== null) {
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'The $inheritedScope parameter is deprecated and will be removed');
|
||||
Deprecation::withSuppressedNotice(
|
||||
fn() => Deprecation::notice('5.4.0', 'The $inheritedScope parameter is deprecated and will be removed')
|
||||
);
|
||||
}
|
||||
// Set hashlinks and temporarily modify global state
|
||||
$rewrite = $this->getRewriteHashLinks();
|
||||
@ -653,7 +667,7 @@ class SSViewer implements Flushable
|
||||
|
||||
if (!file_exists($cacheFile ?? '') || filemtime($cacheFile ?? '') < $lastEdited) {
|
||||
$content = file_get_contents($template ?? '');
|
||||
$content = $this->parseTemplateContent($content, $template);
|
||||
$content = Deprecation::withSuppressedNotice(fn() => $this->parseTemplateContent($content, $template));
|
||||
|
||||
$fh = fopen($cacheFile ?? '', 'w');
|
||||
fwrite($fh, $content ?? '');
|
||||
@ -666,7 +680,7 @@ class SSViewer implements Flushable
|
||||
// through $Content and $Layout placeholders.
|
||||
foreach (['Content', 'Layout'] as $subtemplate) {
|
||||
// Detect sub-template to use
|
||||
$sub = $this->getSubtemplateFor($subtemplate);
|
||||
$sub = Deprecation::withSuppressedNotice(fn() => $this->getSubtemplateFor($subtemplate));
|
||||
if (!$sub) {
|
||||
continue;
|
||||
}
|
||||
@ -677,17 +691,19 @@ class SSViewer implements Flushable
|
||||
// Disable requirements - this will be handled by the parent template
|
||||
$subtemplateViewer->includeRequirements(false);
|
||||
// Select the right template
|
||||
$subtemplateViewer->setTemplate($sub);
|
||||
Deprecation::withSuppressedNotice(fn() => $subtemplateViewer->setTemplate($sub));
|
||||
|
||||
// Render if available
|
||||
if ($subtemplateViewer->exists()) {
|
||||
if (Deprecation::withSuppressedNotice(fn() => $subtemplateViewer->exists())) {
|
||||
return $subtemplateViewer->process($item, $arguments);
|
||||
}
|
||||
return null;
|
||||
};
|
||||
}
|
||||
|
||||
$output = $this->includeGeneratedTemplate($cacheFile, $item, $arguments, $underlay, $inheritedScope);
|
||||
$output = Deprecation::withSuppressedNotice(
|
||||
fn() => $this->includeGeneratedTemplate($cacheFile, $item, $arguments, $underlay, $inheritedScope)
|
||||
);
|
||||
|
||||
if ($this->includeRequirements) {
|
||||
$output = Requirements::includeInHTML($output);
|
||||
@ -728,7 +744,7 @@ PHP;
|
||||
*/
|
||||
protected function getSubtemplateFor($subtemplate)
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::getSubtemplateFor()');
|
||||
Deprecation::notice('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::getSubtemplateFor()');
|
||||
// Get explicit subtemplate name
|
||||
if (isset($this->subTemplates[$subtemplate])) {
|
||||
return $this->subTemplates[$subtemplate];
|
||||
@ -770,10 +786,10 @@ PHP;
|
||||
*/
|
||||
public static function execute_template($template, $data, $arguments = null, $scope = null, $globalRequirements = false)
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment(
|
||||
Deprecation::withSuppressedNotice(fn() => Deprecation::notice(
|
||||
'5.4.0',
|
||||
'Will be replaced with SilverStripe\View\SSTemplateEngine::execute_template()'
|
||||
);
|
||||
));
|
||||
$v = SSViewer::create($template);
|
||||
|
||||
if ($globalRequirements) {
|
||||
@ -807,8 +823,8 @@ PHP;
|
||||
*/
|
||||
public static function execute_string($content, $data, $arguments = null, $globalRequirements = false)
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::renderString()');
|
||||
$v = SSViewer::fromString($content);
|
||||
Deprecation::notice('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::renderString()');
|
||||
$v = Deprecation::withSuppressedNotice(fn() => SSViewer::fromString($content));
|
||||
|
||||
if ($globalRequirements) {
|
||||
$v->includeRequirements(false);
|
||||
@ -836,7 +852,7 @@ PHP;
|
||||
*/
|
||||
public function parseTemplateContent($content, $template = "")
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::parseTemplateContent()');
|
||||
Deprecation::notice('5.4.0', 'Will be replaced with SilverStripe\View\SSTemplateEngine::parseTemplateContent()');
|
||||
return $this->getParser()->compileString(
|
||||
$content,
|
||||
$template,
|
||||
@ -853,7 +869,7 @@ PHP;
|
||||
*/
|
||||
public function templates()
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be removed without equivalent functionality to replace it');
|
||||
Deprecation::notice('5.4.0', 'Will be removed without equivalent functionality to replace it');
|
||||
return array_merge(['main' => $this->chosen], $this->subTemplates);
|
||||
}
|
||||
|
||||
@ -864,7 +880,7 @@ PHP;
|
||||
*/
|
||||
public function setTemplateFile($type, $file)
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be removed without equivalent functionality to replace it');
|
||||
Deprecation::notice('5.4.0', 'Will be removed without equivalent functionality to replace it');
|
||||
if (!$type || $type == 'main') {
|
||||
$this->chosen = $file;
|
||||
} else {
|
||||
@ -883,7 +899,7 @@ PHP;
|
||||
*/
|
||||
public static function get_base_tag($contentGeneratedSoFar)
|
||||
{
|
||||
Deprecation::notice('5.4.0', 'Use getBaseTag() instead');
|
||||
Deprecation::withSuppressedNotice(fn() => Deprecation::notice('5.4.0', 'Use getBaseTag() instead'));
|
||||
// Is the document XHTML?
|
||||
$isXhtml = preg_match('/<!DOCTYPE[^>]+xhtml/i', $contentGeneratedSoFar ?? '');
|
||||
return static::getBaseTag($isXhtml);
|
||||
|
||||
@ -66,7 +66,7 @@ class SSViewer_DataPresenter extends SSViewer_Scope
|
||||
array $underlay = null,
|
||||
SSViewer_Scope $inheritedScope = null
|
||||
) {
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be merged into ' . SSViewer_Scope::class, Deprecation::SCOPE_CLASS);
|
||||
Deprecation::notice('5.4.0', 'Will be merged into ' . SSViewer_Scope::class, Deprecation::SCOPE_CLASS);
|
||||
parent::__construct($item, $inheritedScope);
|
||||
|
||||
$this->overlay = $overlay ?: [];
|
||||
|
||||
@ -39,13 +39,13 @@ class SSViewer_FromString extends SSViewer
|
||||
*/
|
||||
public function __construct($content, TemplateParser $parser = null)
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment(
|
||||
Deprecation::notice(
|
||||
'5.4.0',
|
||||
'Will be replaced with SilverStripe\View\SSTemplateEngine::renderString()',
|
||||
Deprecation::SCOPE_CLASS
|
||||
);
|
||||
if ($parser) {
|
||||
$this->setParser($parser);
|
||||
Deprecation::withSuppressedNotice(fn() => $this->setParser($parser));
|
||||
}
|
||||
|
||||
$this->content = $content;
|
||||
@ -60,13 +60,17 @@ class SSViewer_FromString extends SSViewer
|
||||
$cacheFile = TEMP_PATH . DIRECTORY_SEPARATOR . ".cache.$hash";
|
||||
|
||||
if (!file_exists($cacheFile ?? '') || isset($_GET['flush'])) {
|
||||
$content = $this->parseTemplateContent($this->content, "string sha1=$hash");
|
||||
$content = Deprecation::withSuppressedNotice(
|
||||
fn() => $this->parseTemplateContent($this->content, "string sha1=$hash")
|
||||
);
|
||||
$fh = fopen($cacheFile ?? '', 'w');
|
||||
fwrite($fh, $content ?? '');
|
||||
fclose($fh);
|
||||
}
|
||||
|
||||
$val = $this->includeGeneratedTemplate($cacheFile, $item, $arguments, null, $scope);
|
||||
$val = Deprecation::withSuppressedNotice(
|
||||
fn() => $this->includeGeneratedTemplate($cacheFile, $item, $arguments, null, $scope)
|
||||
);
|
||||
|
||||
if ($this->cacheTemplate !== null) {
|
||||
$cacheTemplate = $this->cacheTemplate;
|
||||
|
||||
@ -138,7 +138,7 @@ class SSViewer_Scope
|
||||
|
||||
public function getCurrentItem()
|
||||
{
|
||||
return $this->getItem();
|
||||
return Deprecation::withSuppressedNotice(fn() => $this->getItem());
|
||||
}
|
||||
|
||||
/**
|
||||
@ -210,7 +210,9 @@ class SSViewer_Scope
|
||||
*/
|
||||
public function obj($name, $arguments = [], $cache = false, $cacheName = null)
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be renamed scopeToIntermediateValue()');
|
||||
Deprecation::withSuppressedNotice(
|
||||
fn() => Deprecation::notice('5.4.0', 'Will be renamed scopeToIntermediateValue()')
|
||||
);
|
||||
switch ($name) {
|
||||
case 'Up':
|
||||
if ($this->upIndex === null) {
|
||||
@ -362,7 +364,7 @@ class SSViewer_Scope
|
||||
{
|
||||
$on = $this->getCurrentItem();
|
||||
if ($on instanceof ViewableData && $name === 'XML_val') {
|
||||
$retval = $on->XML_val(...$arguments);
|
||||
$retval = Deprecation::withSuppressedNotice(fn() => $on->XML_val(...$arguments));
|
||||
} else {
|
||||
$retval = $on ? $on->$name(...$arguments) : null;
|
||||
}
|
||||
|
||||
@ -187,7 +187,7 @@ class ThemeResourceLoader implements Flushable, TemplateGlobalProvider
|
||||
*/
|
||||
public function findTemplate($template, $themes = null)
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be removed without equivalent functionality to replace it.');
|
||||
Deprecation::notice('5.4.0', 'Will be removed without equivalent functionality to replace it.');
|
||||
if ($themes === null) {
|
||||
$themes = SSViewer::get_themes();
|
||||
}
|
||||
@ -214,7 +214,7 @@ class ThemeResourceLoader implements Flushable, TemplateGlobalProvider
|
||||
foreach ($templateList as $i => $template) {
|
||||
// Check if passed list of templates in array format
|
||||
if (is_array($template)) {
|
||||
$path = $this->findTemplate($template, $themes);
|
||||
$path = Deprecation::withSuppressedNotice(fn() => $this->findTemplate($template, $themes));
|
||||
if ($path) {
|
||||
$this->getCache()->set($cacheKey, $path);
|
||||
return $path;
|
||||
|
||||
@ -430,7 +430,7 @@ class ViewableData implements IteratorAggregate
|
||||
*/
|
||||
public function castingClass($field)
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be removed without equivalent functionality to replace it.');
|
||||
Deprecation::notice('5.4.0', 'Will be removed without equivalent functionality to replace it.');
|
||||
// Strip arguments
|
||||
$spec = $this->castingHelper($field);
|
||||
return trim(strtok($spec ?? '', '(') ?? '');
|
||||
@ -445,8 +445,9 @@ class ViewableData implements IteratorAggregate
|
||||
*/
|
||||
public function escapeTypeForField($field)
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be removed without equivalent functionality to replace it.');
|
||||
$class = $this->castingClass($field) ?: $this->config()->get('default_cast');
|
||||
Deprecation::notice('5.4.0', 'Will be removed without equivalent functionality to replace it.');
|
||||
$class = Deprecation::withSuppressedNotice(fn() => $this->castingClass($field))
|
||||
?: $this->config()->get('default_cast');
|
||||
|
||||
/** @var DBField $type */
|
||||
$type = Injector::inst()->get($class, true);
|
||||
@ -496,7 +497,7 @@ class ViewableData implements IteratorAggregate
|
||||
*/
|
||||
protected function objCacheName($fieldName, $arguments)
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be made private');
|
||||
Deprecation::notice('5.4.0', 'Will be made private');
|
||||
return $arguments
|
||||
? $fieldName . ":" . var_export($arguments, true)
|
||||
: $fieldName;
|
||||
@ -553,10 +554,10 @@ class ViewableData implements IteratorAggregate
|
||||
public function obj($fieldName, $arguments = [], $cache = false, $cacheName = null)
|
||||
{
|
||||
if ($cacheName !== null) {
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'The $cacheName parameter has been deprecated and will be removed');
|
||||
Deprecation::notice('5.4.0', 'The $cacheName parameter has been deprecated and will be removed');
|
||||
}
|
||||
if (!$cacheName && $cache) {
|
||||
$cacheName = $this->objCacheName($fieldName, $arguments);
|
||||
$cacheName = Deprecation::withSuppressedNotice(fn() => $this->objCacheName($fieldName, $arguments));
|
||||
}
|
||||
|
||||
// Check pre-cached value
|
||||
@ -632,7 +633,7 @@ class ViewableData implements IteratorAggregate
|
||||
*/
|
||||
public function XML_val($field, $arguments = [], $cache = false)
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be removed without equivalent functionality to replace it');
|
||||
Deprecation::notice('5.4.0', 'Will be removed without equivalent functionality to replace it');
|
||||
$result = $this->obj($field, $arguments, $cache);
|
||||
// Might contain additional formatting over ->XML(). E.g. parse shortcodes, nl2br()
|
||||
return $result->forTemplate();
|
||||
@ -647,11 +648,10 @@ class ViewableData implements IteratorAggregate
|
||||
*/
|
||||
public function getXMLValues($fields)
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('5.4.0', 'Will be removed without equivalent functionality to replace it');
|
||||
$result = [];
|
||||
|
||||
foreach ($fields as $field) {
|
||||
$result[$field] = $this->XML_val($field);
|
||||
$result[$field] = Deprecation::withSuppressedNotice(fn() => $this->XML_val($field));
|
||||
}
|
||||
|
||||
return $result;
|
||||
|
||||
@ -9,6 +9,7 @@ use SilverStripe\View\ThemeResourceLoader;
|
||||
use SilverStripe\View\ThemeManifest;
|
||||
use SilverStripe\Dev\SapphireTest;
|
||||
use SilverStripe\Core\Manifest\ModuleManifest;
|
||||
use SilverStripe\Dev\Deprecation;
|
||||
|
||||
/**
|
||||
* Tests for the {@link TemplateLoader} class.
|
||||
@ -73,41 +74,46 @@ class ThemeResourceLoaderTest extends SapphireTest
|
||||
{
|
||||
$this->assertEquals(
|
||||
"$this->base/module/templates/Page.ss",
|
||||
$this->loader->findTemplate('Page', ['$default'])
|
||||
Deprecation::withSuppressedNotice(fn() => $this->loader->findTemplate('Page', ['$default']))
|
||||
);
|
||||
|
||||
$this->assertEquals(
|
||||
"$this->base/module/templates/Layout/Page.ss",
|
||||
$this->loader->findTemplate(['type' => 'Layout', 'Page'], ['$default'])
|
||||
Deprecation::withSuppressedNotice(
|
||||
fn() => $this->loader->findTemplate(['type' => 'Layout', 'Page'], ['$default'])
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
public function testFindNestedThemeTemplates()
|
||||
{
|
||||
// Without including the theme this template cannot be found
|
||||
$this->assertEquals(null, $this->loader->findTemplate('NestedThemePage', ['$default']));
|
||||
$this->assertEquals(
|
||||
null,
|
||||
Deprecation::withSuppressedNotice(fn() => $this->loader->findTemplate('NestedThemePage', ['$default']))
|
||||
);
|
||||
|
||||
// With a nested theme available then it is available
|
||||
$this->assertEquals(
|
||||
"{$this->base}/module/themes/subtheme/templates/NestedThemePage.ss",
|
||||
$this->loader->findTemplate(
|
||||
Deprecation::withSuppressedNotice(fn() => $this->loader->findTemplate(
|
||||
'NestedThemePage',
|
||||
[
|
||||
'silverstripe/module:subtheme',
|
||||
'$default'
|
||||
]
|
||||
)
|
||||
))
|
||||
);
|
||||
|
||||
// Can also be found if excluding $default theme
|
||||
$this->assertEquals(
|
||||
"{$this->base}/module/themes/subtheme/templates/NestedThemePage.ss",
|
||||
$this->loader->findTemplate(
|
||||
Deprecation::withSuppressedNotice(fn() => $this->loader->findTemplate(
|
||||
'NestedThemePage',
|
||||
[
|
||||
'silverstripe/module:subtheme',
|
||||
]
|
||||
)
|
||||
))
|
||||
);
|
||||
}
|
||||
|
||||
@ -116,7 +122,7 @@ class ThemeResourceLoaderTest extends SapphireTest
|
||||
// Test that "type" is respected properly
|
||||
$this->assertEquals(
|
||||
"{$this->base}/module/templates/MyNamespace/Layout/MyClass.ss",
|
||||
$this->loader->findTemplate(
|
||||
Deprecation::withSuppressedNotice(fn() => $this->loader->findTemplate(
|
||||
[
|
||||
[
|
||||
'type' => 'Layout',
|
||||
@ -133,13 +139,13 @@ class ThemeResourceLoaderTest extends SapphireTest
|
||||
'theme',
|
||||
'$default',
|
||||
]
|
||||
)
|
||||
))
|
||||
);
|
||||
|
||||
// Non-typed template can be found even if looking for typed theme at a lower priority
|
||||
$this->assertEquals(
|
||||
"{$this->base}/module/templates/MyNamespace/MyClass.ss",
|
||||
$this->loader->findTemplate(
|
||||
Deprecation::withSuppressedNotice(fn() => $this->loader->findTemplate(
|
||||
[
|
||||
[
|
||||
'type' => 'Layout',
|
||||
@ -156,7 +162,7 @@ class ThemeResourceLoaderTest extends SapphireTest
|
||||
'theme',
|
||||
'$default',
|
||||
]
|
||||
)
|
||||
))
|
||||
);
|
||||
}
|
||||
|
||||
@ -165,30 +171,32 @@ class ThemeResourceLoaderTest extends SapphireTest
|
||||
// Items given as full paths are returned directly
|
||||
$this->assertEquals(
|
||||
"$this->base/themes/theme/templates/Page.ss",
|
||||
$this->loader->findTemplate("$this->base/themes/theme/templates/Page.ss", ['theme'])
|
||||
Deprecation::withSuppressedNotice(
|
||||
fn() => $this->loader->findTemplate("$this->base/themes/theme/templates/Page.ss", ['theme'])
|
||||
)
|
||||
);
|
||||
|
||||
$this->assertEquals(
|
||||
"$this->base/themes/theme/templates/Page.ss",
|
||||
$this->loader->findTemplate(
|
||||
Deprecation::withSuppressedNotice(fn() => $this->loader->findTemplate(
|
||||
[
|
||||
"$this->base/themes/theme/templates/Page.ss",
|
||||
"Page"
|
||||
],
|
||||
['theme']
|
||||
)
|
||||
))
|
||||
);
|
||||
|
||||
// Ensure checks for file_exists
|
||||
$this->assertEquals(
|
||||
"$this->base/themes/theme/templates/Page.ss",
|
||||
$this->loader->findTemplate(
|
||||
Deprecation::withSuppressedNotice(fn() => $this->loader->findTemplate(
|
||||
[
|
||||
"$this->base/themes/theme/templates/NotAPage.ss",
|
||||
"$this->base/themes/theme/templates/Page.ss",
|
||||
],
|
||||
['theme']
|
||||
)
|
||||
))
|
||||
);
|
||||
}
|
||||
|
||||
@ -199,12 +207,14 @@ class ThemeResourceLoaderTest extends SapphireTest
|
||||
{
|
||||
$this->assertEquals(
|
||||
"$this->base/themes/theme/templates/Page.ss",
|
||||
$this->loader->findTemplate('Page', ['theme'])
|
||||
Deprecation::withSuppressedNotice(fn() => $this->loader->findTemplate('Page', ['theme']))
|
||||
);
|
||||
|
||||
$this->assertEquals(
|
||||
"$this->base/themes/theme/templates/Layout/Page.ss",
|
||||
$this->loader->findTemplate(['type' => 'Layout', 'Page'], ['theme'])
|
||||
Deprecation::withSuppressedNotice(
|
||||
fn() => $this->loader->findTemplate(['type' => 'Layout', 'Page'], ['theme'])
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
@ -221,12 +231,14 @@ class ThemeResourceLoaderTest extends SapphireTest
|
||||
|
||||
$this->assertEquals(
|
||||
"$this->base/myproject/templates/Page.ss",
|
||||
$this->loader->findTemplate('Page', ['$default'])
|
||||
Deprecation::withSuppressedNotice(fn() => $this->loader->findTemplate('Page', ['$default']))
|
||||
);
|
||||
|
||||
$this->assertEquals(
|
||||
"$this->base/myproject/templates/Layout/Page.ss",
|
||||
$this->loader->findTemplate(['type' => 'Layout', 'Page'], ['$default'])
|
||||
Deprecation::withSuppressedNotice(
|
||||
fn() => $this->loader->findTemplate(['type' => 'Layout', 'Page'], ['$default'])
|
||||
)
|
||||
);
|
||||
|
||||
$this->removeTestTemplates($templates);
|
||||
@ -239,12 +251,16 @@ class ThemeResourceLoaderTest extends SapphireTest
|
||||
{
|
||||
$this->assertEquals(
|
||||
"$this->base/themes/theme/templates/CustomThemePage.ss",
|
||||
$this->loader->findTemplate('CustomThemePage', ['theme', '$default'])
|
||||
Deprecation::withSuppressedNotice(
|
||||
fn() => $this->loader->findTemplate('CustomThemePage', ['theme', '$default'])
|
||||
)
|
||||
);
|
||||
|
||||
$this->assertEquals(
|
||||
"$this->base/module/templates/Layout/CustomThemePage.ss",
|
||||
$this->loader->findTemplate(['type' => 'Layout', 'CustomThemePage'], ['theme', '$default'])
|
||||
Deprecation::withSuppressedNotice(
|
||||
fn() => $this->loader->findTemplate(['type' => 'Layout', 'CustomThemePage'], ['theme', '$default'])
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
@ -390,7 +406,7 @@ class ThemeResourceLoaderTest extends SapphireTest
|
||||
|
||||
$loader = new ThemeResourceLoader();
|
||||
$loader->setCache($mockCache);
|
||||
$loader->findTemplate('Page', ['$default']);
|
||||
Deprecation::withSuppressedNotice(fn() => $loader->findTemplate('Page', ['$default']));
|
||||
}
|
||||
|
||||
public function testFindTemplateWithCacheHit()
|
||||
@ -402,6 +418,9 @@ class ThemeResourceLoaderTest extends SapphireTest
|
||||
|
||||
$loader = new ThemeResourceLoader();
|
||||
$loader->setCache($mockCache);
|
||||
$this->assertSame('mock_template.ss', $loader->findTemplate('Page', ['$default']));
|
||||
$this->assertSame(
|
||||
'mock_template.ss',
|
||||
Deprecation::withSuppressedNotice(fn() => $loader->findTemplate('Page', ['$default']))
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
@ -23,8 +23,6 @@ class DeprecationTest extends SapphireTest
|
||||
|
||||
private bool $noticesWereEnabled = false;
|
||||
|
||||
private bool $showSupportedNoticesWasEnabled = false;
|
||||
|
||||
protected function setup(): void
|
||||
{
|
||||
// Use custom error handler for two reasons:
|
||||
@ -33,7 +31,6 @@ class DeprecationTest extends SapphireTest
|
||||
// https://github.com/laminas/laminas-di/pull/30#issuecomment-927585210
|
||||
parent::setup();
|
||||
$this->noticesWereEnabled = Deprecation::isEnabled();
|
||||
$this->showSupportedNoticesWasEnabled = Deprecation::getShowNoticesCalledFromSupportedCode();
|
||||
$this->oldHandler = set_error_handler(function (int $errno, string $errstr, string $errfile, int $errline) {
|
||||
if ($errno === E_USER_DEPRECATED) {
|
||||
if (str_contains($errstr, 'SilverStripe\\Dev\\Tests\\DeprecationTest')) {
|
||||
@ -49,8 +46,6 @@ class DeprecationTest extends SapphireTest
|
||||
// Fallback to default PHP error handler
|
||||
return false;
|
||||
});
|
||||
// This is required to clear out the notice from instantiating DeprecationTestObject in TableBuilder::buildTables().
|
||||
Deprecation::outputNotices();
|
||||
}
|
||||
|
||||
protected function tearDown(): void
|
||||
@ -60,7 +55,6 @@ class DeprecationTest extends SapphireTest
|
||||
} else {
|
||||
Deprecation::disable();
|
||||
}
|
||||
Deprecation::setShowNoticesCalledFromSupportedCode($this->showSupportedNoticesWasEnabled);
|
||||
restore_error_handler();
|
||||
$this->oldHandler = null;
|
||||
parent::tearDown();
|
||||
@ -72,18 +66,6 @@ class DeprecationTest extends SapphireTest
|
||||
return 'abc';
|
||||
}
|
||||
|
||||
private function myDeprecatedMethodNoReplacement(): string
|
||||
{
|
||||
Deprecation::noticeWithNoReplacment('1.2.3');
|
||||
return 'abc';
|
||||
}
|
||||
|
||||
private function enableDeprecationNotices(bool $showNoReplacementNotices = false): void
|
||||
{
|
||||
Deprecation::enable($showNoReplacementNotices);
|
||||
Deprecation::setShowNoticesCalledFromSupportedCode(true);
|
||||
}
|
||||
|
||||
public function testNotice()
|
||||
{
|
||||
$message = implode(' ', [
|
||||
@ -93,7 +75,7 @@ class DeprecationTest extends SapphireTest
|
||||
]);
|
||||
$this->expectDeprecation();
|
||||
$this->expectDeprecationMessage($message);
|
||||
$this->enableDeprecationNotices();
|
||||
Deprecation::enable();
|
||||
$ret = $this->myDeprecatedMethod();
|
||||
$this->assertSame('abc', $ret);
|
||||
// call outputNotices() directly because the regular shutdown function that emits
|
||||
@ -101,29 +83,6 @@ class DeprecationTest extends SapphireTest
|
||||
Deprecation::outputNotices();
|
||||
}
|
||||
|
||||
public function testNoticeNoReplacement()
|
||||
{
|
||||
$message = implode(' ', [
|
||||
'SilverStripe\Dev\Tests\DeprecationTest->myDeprecatedMethodNoReplacement is deprecated.',
|
||||
'Will be removed without equivalent functionality to replace it.',
|
||||
'Called from SilverStripe\Dev\Tests\DeprecationTest->testNoticeNoReplacement.'
|
||||
]);
|
||||
$this->expectDeprecation();
|
||||
$this->expectDeprecationMessage($message);
|
||||
$this->enableDeprecationNotices(true);
|
||||
$ret = $this->myDeprecatedMethodNoReplacement();
|
||||
$this->assertSame('abc', $ret);
|
||||
Deprecation::outputNotices();
|
||||
}
|
||||
|
||||
public function testNoticeNoReplacementNoSupressed()
|
||||
{
|
||||
$this->enableDeprecationNotices();
|
||||
$ret = $this->myDeprecatedMethodNoReplacement();
|
||||
$this->assertSame('abc', $ret);
|
||||
Deprecation::outputNotices();
|
||||
}
|
||||
|
||||
public function testCallUserFunc()
|
||||
{
|
||||
$message = implode(' ', [
|
||||
@ -133,7 +92,7 @@ class DeprecationTest extends SapphireTest
|
||||
]);
|
||||
$this->expectDeprecation();
|
||||
$this->expectDeprecationMessage($message);
|
||||
$this->enableDeprecationNotices();
|
||||
Deprecation::enable();
|
||||
$ret = call_user_func([$this, 'myDeprecatedMethod']);
|
||||
$this->assertSame('abc', $ret);
|
||||
Deprecation::outputNotices();
|
||||
@ -148,7 +107,7 @@ class DeprecationTest extends SapphireTest
|
||||
]);
|
||||
$this->expectDeprecation();
|
||||
$this->expectDeprecationMessage($message);
|
||||
$this->enableDeprecationNotices();
|
||||
Deprecation::enable();
|
||||
$ret = call_user_func_array([$this, 'myDeprecatedMethod'], []);
|
||||
$this->assertSame('abc', $ret);
|
||||
Deprecation::outputNotices();
|
||||
@ -156,7 +115,7 @@ class DeprecationTest extends SapphireTest
|
||||
|
||||
public function testwithSuppressedNoticeDefault()
|
||||
{
|
||||
$this->enableDeprecationNotices();
|
||||
Deprecation::enable();
|
||||
$ret = Deprecation::withSuppressedNotice(function () {
|
||||
return $this->myDeprecatedMethod();
|
||||
});
|
||||
@ -173,7 +132,7 @@ class DeprecationTest extends SapphireTest
|
||||
]);
|
||||
$this->expectDeprecation();
|
||||
$this->expectDeprecationMessage($message);
|
||||
$this->enableDeprecationNotices(true);
|
||||
Deprecation::enable(true);
|
||||
$ret = Deprecation::withSuppressedNotice(function () {
|
||||
return $this->myDeprecatedMethod();
|
||||
});
|
||||
@ -190,7 +149,7 @@ class DeprecationTest extends SapphireTest
|
||||
]);
|
||||
$this->expectDeprecation();
|
||||
$this->expectDeprecationMessage($message);
|
||||
$this->enableDeprecationNotices(true);
|
||||
Deprecation::enable(true);
|
||||
$ret = Deprecation::withSuppressedNotice(function () {
|
||||
return call_user_func([$this, 'myDeprecatedMethod']);
|
||||
});
|
||||
@ -207,7 +166,7 @@ class DeprecationTest extends SapphireTest
|
||||
]);
|
||||
$this->expectDeprecation();
|
||||
$this->expectDeprecationMessage($message);
|
||||
$this->enableDeprecationNotices(true);
|
||||
Deprecation::enable(true);
|
||||
Deprecation::withSuppressedNotice(function () {
|
||||
Deprecation::notice('123', 'My message.');
|
||||
});
|
||||
@ -223,7 +182,7 @@ class DeprecationTest extends SapphireTest
|
||||
]);
|
||||
$this->expectDeprecation();
|
||||
$this->expectDeprecationMessage($message);
|
||||
$this->enableDeprecationNotices(true);
|
||||
Deprecation::enable(true);
|
||||
// using this syntax because my IDE was complaining about DeprecationTestObject not existing
|
||||
// when trying to use `new DeprecationTestObject();`
|
||||
$class = DeprecationTestObject::class;
|
||||
@ -240,7 +199,7 @@ class DeprecationTest extends SapphireTest
|
||||
]);
|
||||
$this->expectDeprecation();
|
||||
$this->expectDeprecationMessage($message);
|
||||
$this->enableDeprecationNotices(true);
|
||||
Deprecation::enable(true);
|
||||
Injector::inst()->get(DeprecationTestObject::class);
|
||||
Deprecation::outputNotices();
|
||||
}
|
||||
@ -258,50 +217,6 @@ class DeprecationTest extends SapphireTest
|
||||
Deprecation::outputNotices();
|
||||
}
|
||||
|
||||
public function testshowNoticesCalledFromSupportedCode()
|
||||
{
|
||||
$this->expectNotToPerformAssertions();
|
||||
$this->enableDeprecationNotices(true);
|
||||
// showNoticesCalledFromSupportedCode is set to true by default for these unit tests
|
||||
// as it is testing code within vendor/silverstripe
|
||||
// This test is to ensure that the method works as expected when we disable this
|
||||
// and we should expect no exceptions to be thrown
|
||||
//
|
||||
// Note specifically NOT testing the following because it's counted as being called
|
||||
// from phpunit itself, which is not considered supported code
|
||||
// Deprecation::withSuppressedNotice(function () {
|
||||
// Deprecation::notice('123', 'My message.');
|
||||
// });
|
||||
Deprecation::setShowNoticesCalledFromSupportedCode(false);
|
||||
// notice()
|
||||
$this->myDeprecatedMethod();
|
||||
// noticeNoReplacement()
|
||||
$this->myDeprecatedMethodNoReplacement();
|
||||
// callUserFunc()
|
||||
call_user_func([$this, 'myDeprecatedMethod']);
|
||||
// callUserFuncArray()
|
||||
call_user_func_array([$this, 'myDeprecatedMethod'], []);
|
||||
// withSuppressedNotice()
|
||||
Deprecation::withSuppressedNotice(
|
||||
fn() => $this->myDeprecatedMethod()
|
||||
);
|
||||
// withSuppressedNoticeTrue()
|
||||
Deprecation::withSuppressedNotice(function () {
|
||||
$this->myDeprecatedMethod();
|
||||
});
|
||||
// withSuppressedNoticeTrueCallUserFunc()
|
||||
Deprecation::withSuppressedNotice(function () {
|
||||
call_user_func([$this, 'myDeprecatedMethod']);
|
||||
});
|
||||
// classWithSuppressedNotice()
|
||||
$class = DeprecationTestObject::class;
|
||||
new $class();
|
||||
// classWithInjectorwithSuppressedNotice()
|
||||
Injector::inst()->get(DeprecationTestObject::class);
|
||||
// Output notices - there should be none
|
||||
Deprecation::outputNotices();
|
||||
}
|
||||
|
||||
// The following tests would be better to put in the silverstripe/config module, however this is not
|
||||
// possible to do in a clean way as the config for the DeprecationTestObject will not load if it
|
||||
// is inside the silverstripe/config directory, as there is no _config.php file or _config folder.
|
||||
@ -316,7 +231,7 @@ class DeprecationTest extends SapphireTest
|
||||
]);
|
||||
$this->expectDeprecation();
|
||||
$this->expectDeprecationMessage($message);
|
||||
$this->enableDeprecationNotices();
|
||||
Deprecation::enable();
|
||||
Config::inst()->get(DeprecationTestObject::class, 'first_config');
|
||||
Deprecation::outputNotices();
|
||||
}
|
||||
@ -329,7 +244,7 @@ class DeprecationTest extends SapphireTest
|
||||
]);
|
||||
$this->expectDeprecation();
|
||||
$this->expectDeprecationMessage($message);
|
||||
$this->enableDeprecationNotices();
|
||||
Deprecation::enable();
|
||||
Config::inst()->get(DeprecationTestObject::class, 'second_config');
|
||||
Deprecation::outputNotices();
|
||||
}
|
||||
@ -339,7 +254,7 @@ class DeprecationTest extends SapphireTest
|
||||
$message = 'Config SilverStripe\Dev\Tests\DeprecationTest\DeprecationTestObject.third_config is deprecated.';
|
||||
$this->expectDeprecation();
|
||||
$this->expectDeprecationMessage($message);
|
||||
$this->enableDeprecationNotices();
|
||||
Deprecation::enable();
|
||||
Config::inst()->get(DeprecationTestObject::class, 'third_config');
|
||||
Deprecation::outputNotices();
|
||||
}
|
||||
@ -352,7 +267,7 @@ class DeprecationTest extends SapphireTest
|
||||
]);
|
||||
$this->expectDeprecation();
|
||||
$this->expectDeprecationMessage($message);
|
||||
$this->enableDeprecationNotices();
|
||||
Deprecation::enable();
|
||||
Config::modify()->set(DeprecationTestObject::class, 'first_config', 'abc');
|
||||
Deprecation::outputNotices();
|
||||
}
|
||||
@ -365,7 +280,7 @@ class DeprecationTest extends SapphireTest
|
||||
]);
|
||||
$this->expectDeprecation();
|
||||
$this->expectDeprecationMessage($message);
|
||||
$this->enableDeprecationNotices();
|
||||
Deprecation::enable();
|
||||
Config::modify()->merge(DeprecationTestObject::class, 'array_config', ['abc']);
|
||||
Deprecation::outputNotices();
|
||||
}
|
||||
@ -451,7 +366,7 @@ class DeprecationTest extends SapphireTest
|
||||
switch ($varName) {
|
||||
case 'SS_DEPRECATION_ENABLED':
|
||||
if ($configVal) {
|
||||
$this->enableDeprecationNotices();
|
||||
Deprecation::enable();
|
||||
} else {
|
||||
Deprecation::disable();
|
||||
}
|
||||
@ -627,7 +542,7 @@ class DeprecationTest extends SapphireTest
|
||||
private function setEnabledViaStatic(bool $enabled): void
|
||||
{
|
||||
if ($enabled) {
|
||||
$this->enableDeprecationNotices();
|
||||
Deprecation::enable();
|
||||
} else {
|
||||
Deprecation::disable();
|
||||
}
|
||||
|
||||
@ -5,6 +5,7 @@ namespace SilverStripe\View\Tests;
|
||||
use SilverStripe\Dev\SapphireTest;
|
||||
use SilverStripe\Control\ContentNegotiator;
|
||||
use SilverStripe\Control\HTTPResponse;
|
||||
use SilverStripe\Dev\Deprecation;
|
||||
use SilverStripe\View\SSViewer;
|
||||
use SilverStripe\View\Tests\SSViewerTest\TestFixture;
|
||||
|
||||
@ -17,7 +18,7 @@ class ContentNegotiatorTest extends SapphireTest
|
||||
*/
|
||||
private function render($templateString, $data = null)
|
||||
{
|
||||
$t = SSViewer::fromString($templateString);
|
||||
$t = Deprecation::withSuppressedNotice(fn() => SSViewer::fromString($templateString));
|
||||
if (!$data) {
|
||||
$data = new TestFixture();
|
||||
}
|
||||
|
||||
@ -9,6 +9,7 @@ use SilverStripe\Versioned\Versioned;
|
||||
use Psr\SimpleCache\CacheInterface;
|
||||
use SilverStripe\Dev\SapphireTest;
|
||||
use SilverStripe\Control\Director;
|
||||
use SilverStripe\Dev\Deprecation;
|
||||
use SilverStripe\View\SSTemplateParseException;
|
||||
use SilverStripe\View\SSViewer;
|
||||
use Symfony\Component\Cache\Adapter\FilesystemAdapter;
|
||||
@ -64,7 +65,7 @@ class SSViewerCacheBlockTest extends SapphireTest
|
||||
$data = $this->data->customise($data);
|
||||
}
|
||||
|
||||
return SSViewer::execute_string($template, $data);
|
||||
return Deprecation::withSuppressedNotice(fn() => SSViewer::execute_string($template, $data));
|
||||
}
|
||||
|
||||
public function testParsing()
|
||||
@ -177,13 +178,13 @@ class SSViewerCacheBlockTest extends SapphireTest
|
||||
$data->setEntropy('default');
|
||||
$this->assertEquals(
|
||||
'default Stage.Stage',
|
||||
SSViewer::execute_string('<% cached %>$Inspect<% end_cached %>', $data)
|
||||
Deprecation::withSuppressedNotice(fn() => SSViewer::execute_string('<% cached %>$Inspect<% end_cached %>', $data))
|
||||
);
|
||||
$data = new SSViewerCacheBlockTest\VersionedModel();
|
||||
$data->setEntropy('first');
|
||||
$this->assertEquals(
|
||||
'first Stage.Stage',
|
||||
SSViewer::execute_string('<% cached %>$Inspect<% end_cached %>', $data)
|
||||
Deprecation::withSuppressedNotice(fn() => SSViewer::execute_string('<% cached %>$Inspect<% end_cached %>', $data))
|
||||
);
|
||||
|
||||
// Run without caching in live to prove data is uncached
|
||||
|
||||
@ -13,6 +13,7 @@ use SilverStripe\Control\Director;
|
||||
use SilverStripe\Control\HTTPResponse;
|
||||
use SilverStripe\Core\Convert;
|
||||
use SilverStripe\Core\Injector\Injector;
|
||||
use SilverStripe\Dev\Deprecation;
|
||||
use SilverStripe\Dev\SapphireTest;
|
||||
use SilverStripe\i18n\i18n;
|
||||
use SilverStripe\ORM\ArrayList;
|
||||
@ -196,7 +197,7 @@ class SSViewerTest extends SapphireTest
|
||||
*/
|
||||
public function render($templateString, $data = null, $cacheTemplate = false)
|
||||
{
|
||||
$t = SSViewer::fromString($templateString, $cacheTemplate);
|
||||
$t = Deprecation::withSuppressedNotice(fn() => SSViewer::fromString($templateString, $cacheTemplate));
|
||||
if (!$data) {
|
||||
$data = new SSViewerTest\TestFixture();
|
||||
}
|
||||
@ -1304,29 +1305,29 @@ after'
|
||||
// Value casted as "Text"
|
||||
$this->assertEquals(
|
||||
'<b>html</b>',
|
||||
$t = SSViewer::fromString('$TextValue')->process($vd)
|
||||
Deprecation::withSuppressedNotice(fn() => SSViewer::fromString('$TextValue'))->process($vd)
|
||||
);
|
||||
$this->assertEquals(
|
||||
'<b>html</b>',
|
||||
$t = SSViewer::fromString('$TextValue.RAW')->process($vd)
|
||||
Deprecation::withSuppressedNotice(fn() => SSViewer::fromString('$TextValue.RAW'))->process($vd)
|
||||
);
|
||||
$this->assertEquals(
|
||||
'<b>html</b>',
|
||||
$t = SSViewer::fromString('$TextValue.XML')->process($vd)
|
||||
Deprecation::withSuppressedNotice(fn() => SSViewer::fromString('$TextValue.XML'))->process($vd)
|
||||
);
|
||||
|
||||
// Value casted as "HTMLText"
|
||||
$this->assertEquals(
|
||||
'<b>html</b>',
|
||||
$t = SSViewer::fromString('$HTMLValue')->process($vd)
|
||||
Deprecation::withSuppressedNotice(fn() => SSViewer::fromString('$HTMLValue'))->process($vd)
|
||||
);
|
||||
$this->assertEquals(
|
||||
'<b>html</b>',
|
||||
$t = SSViewer::fromString('$HTMLValue.RAW')->process($vd)
|
||||
Deprecation::withSuppressedNotice(fn() => SSViewer::fromString('$HTMLValue.RAW'))->process($vd)
|
||||
);
|
||||
$this->assertEquals(
|
||||
'<b>html</b>',
|
||||
$t = SSViewer::fromString('$HTMLValue.XML')->process($vd)
|
||||
Deprecation::withSuppressedNotice(fn() => SSViewer::fromString('$HTMLValue.XML'))->process($vd)
|
||||
);
|
||||
|
||||
// Uncasted value (falls back to ViewableData::$default_cast="Text")
|
||||
@ -1334,15 +1335,15 @@ after'
|
||||
$vd->UncastedValue = '<b>html</b>';
|
||||
$this->assertEquals(
|
||||
'<b>html</b>',
|
||||
$t = SSViewer::fromString('$UncastedValue')->process($vd)
|
||||
Deprecation::withSuppressedNotice(fn() => SSViewer::fromString('$UncastedValue'))->process($vd)
|
||||
);
|
||||
$this->assertEquals(
|
||||
'<b>html</b>',
|
||||
$t = SSViewer::fromString('$UncastedValue.RAW')->process($vd)
|
||||
Deprecation::withSuppressedNotice(fn() => SSViewer::fromString('$UncastedValue.RAW'))->process($vd)
|
||||
);
|
||||
$this->assertEquals(
|
||||
'<b>html</b>',
|
||||
$t = SSViewer::fromString('$UncastedValue.XML')->process($vd)
|
||||
Deprecation::withSuppressedNotice(fn() => SSViewer::fromString('$UncastedValue.XML'))->process($vd)
|
||||
);
|
||||
}
|
||||
|
||||
@ -2039,7 +2040,9 @@ EOC;
|
||||
public function testLoopIteratorIterator()
|
||||
{
|
||||
$list = new PaginatedList(new ArrayList());
|
||||
$viewer = new SSViewer_FromString('<% loop List %>$ID - $FirstName<br /><% end_loop %>');
|
||||
$viewer = Deprecation::withSuppressedNotice(
|
||||
fn() => new SSViewer_FromString('<% loop List %>$ID - $FirstName<br /><% end_loop %>')
|
||||
);
|
||||
$result = $viewer->process(new ArrayData(['List' => $list]));
|
||||
$this->assertEquals($result, '');
|
||||
}
|
||||
@ -2182,7 +2185,9 @@ EOC;
|
||||
}
|
||||
);
|
||||
|
||||
$template = new SSViewer_FromString("<% test %><% end_test %>", $parser);
|
||||
$template = Deprecation::withSuppressedNotice(
|
||||
fn() => new SSViewer_FromString("<% test %><% end_test %>", $parser)
|
||||
);
|
||||
$template->process(new SSViewerTest\TestFixture());
|
||||
|
||||
$this->assertEquals(1, $count);
|
||||
@ -2199,7 +2204,7 @@ EOC;
|
||||
}
|
||||
);
|
||||
|
||||
$template = new SSViewer_FromString("<% test %>", $parser);
|
||||
$template = Deprecation::withSuppressedNotice(fn() => new SSViewer_FromString("<% test %>", $parser));
|
||||
$template->process(new SSViewerTest\TestFixture());
|
||||
|
||||
$this->assertEquals(1, $count);
|
||||
|
||||
@ -3,6 +3,7 @@
|
||||
namespace SilverStripe\View\Tests;
|
||||
|
||||
use ReflectionMethod;
|
||||
use SilverStripe\Dev\Deprecation;
|
||||
use SilverStripe\ORM\FieldType\DBField;
|
||||
use SilverStripe\Dev\SapphireTest;
|
||||
use SilverStripe\View\ArrayData;
|
||||
@ -77,12 +78,12 @@ class ViewableDataTest extends SapphireTest
|
||||
{
|
||||
$caster = new ViewableDataTest\Castable();
|
||||
|
||||
$this->assertEquals('casted', $caster->XML_val('alwaysCasted'));
|
||||
$this->assertEquals('casted', $caster->XML_val('noCastingInformation'));
|
||||
$this->assertEquals('casted', Deprecation::withSuppressedNotice(fn() => $caster->XML_val('alwaysCasted')));
|
||||
$this->assertEquals('casted', Deprecation::withSuppressedNotice(fn() => $caster->XML_val('noCastingInformation')));
|
||||
|
||||
// Test automatic escaping is applied even to fields with no 'casting'
|
||||
$this->assertEquals('casted', $caster->XML_val('unsafeXML'));
|
||||
$this->assertEquals('<foo>', $caster->XML_val('castedUnsafeXML'));
|
||||
$this->assertEquals('casted', Deprecation::withSuppressedNotice(fn() => $caster->XML_val('unsafeXML')));
|
||||
$this->assertEquals('<foo>', Deprecation::withSuppressedNotice(fn() => $caster->XML_val('castedUnsafeXML')));
|
||||
}
|
||||
|
||||
public function testArrayCustomise()
|
||||
@ -95,11 +96,11 @@ class ViewableDataTest extends SapphireTest
|
||||
]
|
||||
);
|
||||
|
||||
$this->assertEquals('test', $viewableData->XML_val('test'));
|
||||
$this->assertEquals('casted', $viewableData->XML_val('alwaysCasted'));
|
||||
$this->assertEquals('test', Deprecation::withSuppressedNotice(fn() => $viewableData->XML_val('test')));
|
||||
$this->assertEquals('casted', Deprecation::withSuppressedNotice(fn() => $viewableData->XML_val('alwaysCasted')));
|
||||
|
||||
$this->assertEquals('overwritten', $newViewableData->XML_val('test'));
|
||||
$this->assertEquals('overwritten', $newViewableData->XML_val('alwaysCasted'));
|
||||
$this->assertEquals('overwritten', Deprecation::withSuppressedNotice(fn() => $newViewableData->XML_val('test')));
|
||||
$this->assertEquals('overwritten', Deprecation::withSuppressedNotice(fn() => $newViewableData->XML_val('alwaysCasted')));
|
||||
|
||||
$this->assertEquals('castable', $viewableData->forTemplate());
|
||||
$this->assertEquals('castable', $newViewableData->forTemplate());
|
||||
@ -110,11 +111,11 @@ class ViewableDataTest extends SapphireTest
|
||||
$viewableData = new ViewableDataTest\Castable();
|
||||
$newViewableData = $viewableData->customise(new ViewableDataTest\RequiresCasting());
|
||||
|
||||
$this->assertEquals('test', $viewableData->XML_val('test'));
|
||||
$this->assertEquals('casted', $viewableData->XML_val('alwaysCasted'));
|
||||
$this->assertEquals('test', Deprecation::withSuppressedNotice(fn() => $viewableData->XML_val('test')));
|
||||
$this->assertEquals('casted', Deprecation::withSuppressedNotice(fn() => $viewableData->XML_val('alwaysCasted')));
|
||||
|
||||
$this->assertEquals('overwritten', $newViewableData->XML_val('test'));
|
||||
$this->assertEquals('casted', $newViewableData->XML_val('alwaysCasted'));
|
||||
$this->assertEquals('overwritten', Deprecation::withSuppressedNotice(fn() => $newViewableData->XML_val('test')));
|
||||
$this->assertEquals('casted', Deprecation::withSuppressedNotice(fn() => $newViewableData->XML_val('alwaysCasted')));
|
||||
|
||||
$this->assertEquals('castable', $viewableData->forTemplate());
|
||||
$this->assertEquals('casted', $newViewableData->forTemplate());
|
||||
@ -147,7 +148,7 @@ class ViewableDataTest extends SapphireTest
|
||||
foreach ($expected as $field => $class) {
|
||||
$this->assertEquals(
|
||||
$class,
|
||||
$obj->castingClass($field),
|
||||
Deprecation::withSuppressedNotice(fn() => $obj->castingClass($field)),
|
||||
"castingClass() returns correct results for ::\$$field"
|
||||
);
|
||||
}
|
||||
@ -159,7 +160,7 @@ class ViewableDataTest extends SapphireTest
|
||||
|
||||
// Save a literal string into cache
|
||||
$cache = true;
|
||||
$uncastedData = $obj->obj('noCastingInformation', null, false, $cache);
|
||||
$uncastedData = $obj->obj('noCastingInformation', null, $cache);
|
||||
|
||||
// Fetch the cached string as an object
|
||||
$forceReturnedObject = true;
|
||||
@ -184,15 +185,15 @@ class ViewableDataTest extends SapphireTest
|
||||
$objCached->Test = 'AAA';
|
||||
$objNotCached->Test = 'AAA';
|
||||
|
||||
$this->assertEquals('AAA', $objCached->obj('Test', null, true, true));
|
||||
$this->assertEquals('AAA', $objNotCached->obj('Test', null, true, true));
|
||||
$this->assertEquals('AAA', $objCached->obj('Test', null, true));
|
||||
$this->assertEquals('AAA', $objNotCached->obj('Test', null, true));
|
||||
|
||||
$objCached->Test = 'BBB';
|
||||
$objNotCached->Test = 'BBB';
|
||||
|
||||
// Cached data must be always the same
|
||||
$this->assertEquals('AAA', $objCached->obj('Test', null, true, true));
|
||||
$this->assertEquals('BBB', $objNotCached->obj('Test', null, true, true));
|
||||
$this->assertEquals('AAA', $objCached->obj('Test', null, true));
|
||||
$this->assertEquals('BBB', $objNotCached->obj('Test', null, true));
|
||||
}
|
||||
|
||||
public function testSetFailover()
|
||||
|
||||
@ -8,6 +8,7 @@ use SilverStripe\Core\Manifest\ClassManifest;
|
||||
use SilverStripe\Core\Manifest\ClassLoader;
|
||||
use SilverStripe\Core\Manifest\ModuleLoader;
|
||||
use SilverStripe\Core\Manifest\ModuleManifest;
|
||||
use SilverStripe\Dev\Deprecation;
|
||||
use SilverStripe\i18n\i18n;
|
||||
use SilverStripe\i18n\Messages\MessageProvider;
|
||||
use SilverStripe\i18n\Messages\Symfony\ModuleYamlLoader;
|
||||
@ -73,7 +74,7 @@ trait i18nTestManifest
|
||||
{
|
||||
// force SSViewer_DataPresenter to cache global template vars before we switch to the
|
||||
// test-project class manifest (since it will lose visibility of core classes)
|
||||
$presenter = new SSViewer_DataPresenter(new ViewableData());
|
||||
$presenter = Deprecation::withSuppressedNotice(fn() => new SSViewer_DataPresenter(new ViewableData()));
|
||||
unset($presenter);
|
||||
|
||||
// Switch to test manifest
|
||||
|
||||
Loading…
Reference in New Issue
Block a user