From f013314a727457078b37267ead0df883a1a251b2 Mon Sep 17 00:00:00 2001 From: Guy Sartorelli Date: Thu, 26 Sep 2024 16:16:04 +1200 Subject: [PATCH] API Refactor template layer into its own module Includes the following large-scale changes: - Impoved barrier between model and view layers - Improved casting of scalar to relevant DBField types - Improved capabilities for rendering arbitrary data in templates --- _config/view.yml | 6 + src/Control/ContentNegotiator.php | 2 +- src/Control/Controller.php | 36 +- src/Control/RSS/RSSFeed_Entry.php | 10 +- src/Dev/Backtrace.php | 6 +- src/Forms/DropdownField.php | 2 +- src/Forms/FieldGroup.php | 2 +- src/Forms/Form.php | 4 +- src/Forms/FormField.php | 15 +- src/Forms/FormScaffolder.php | 4 +- .../GridFieldAddExistingAutocompleter.php | 5 +- src/Forms/HTMLEditor/HTMLEditorField.php | 21 +- src/Forms/TreeDropdownField.php | 20 +- src/Forms/TreeMultiselectField.php | 8 +- src/Model/List/ListDecorator.php | 4 +- src/Model/ModelData.php | 237 +- src/Model/ModelDataCustomised.php | 20 +- src/ORM/DataList.php | 3 +- src/ORM/DataObject.php | 17 +- src/ORM/EagerLoadedList.php | 2 +- src/ORM/FieldType/DBComposite.php | 4 +- src/ORM/FieldType/DBField.php | 5 - src/ORM/FieldType/DBVarchar.php | 2 +- src/ORM/Filters/SearchFilter.php | 2 +- src/ORM/Relation.php | 5 +- src/ORM/UnsavedRelationList.php | 5 +- src/PolyExecution/PolyOutput.php | 3 - src/Security/Member.php | 6 +- src/Security/PermissionCheckboxSetField.php | 10 +- src/View/CastingService.php | 100 + src/View/Dev/SSViewerTestState.php | 2 +- .../Exception/MissingTemplateException.php | 11 + src/View/SSTemplateEngine.php | 425 +++ src/View/SSTemplateParser.peg | 48 +- src/View/SSTemplateParser.php | 48 +- src/View/SSViewer.php | 606 +---- src/View/SSViewer_DataPresenter.php | 449 ---- src/View/SSViewer_FromString.php | 72 +- src/View/SSViewer_Scope.php | 455 +++- src/View/TemplateEngine.php | 61 + src/View/ViewLayerData.php | 217 ++ .../TestComponent.php | 2 +- .../TestComponent_ItemRequest.php | 2 +- tests/php/Forms/TreeDropdownFieldTest.php | 2 +- tests/php/Forms/TreeMultiselectFieldTest.php | 4 + tests/php/Model/ModelDataTest.php | 21 +- tests/php/Model/ModelDataTest/NotCached.php | 2 +- tests/php/ORM/Filters/EndsWithFilterTest.php | 14 - .../ORM/Filters/PartialMatchFilterTest.php | 14 - .../php/ORM/Filters/StartsWithFilterTest.php | 14 - tests/php/ORM/LabelFieldTest.php | 2 +- tests/php/View/ContentNegotiatorTest.php | 4 +- tests/php/View/RequirementsTest.php | 27 + tests/php/View/SSTemplateEngineTest.php | 2190 ++++++++++++++++ .../CacheTestData.php | 2 +- .../LevelTestData.php | 2 +- .../View/SSTemplateEngineTest/TestFixture.php | 85 + .../TestGlobalProvider.php | 51 + .../TestObject.php | 12 +- .../TestViewableData.php | 2 +- .../css/RequirementsTest_a.css | 0 .../css/RequirementsTest_b.css | 0 .../css/RequirementsTest_c.css | 0 .../css/RequirementsTest_print_a.css | 0 .../css/RequirementsTest_print_b.css | 0 .../i18n/en-gb.js | 0 .../i18n/en-us.js | 0 .../i18n/en.js | 0 .../i18n/en_GB.js | 0 .../i18n/en_US.js | 0 .../i18n/fr-ca.js | 0 .../i18n/fr.js | 0 .../i18n/fr_CA.js | 0 .../i18n/mi.js | 0 .../javascript/RequirementsTest_a.js | 0 .../javascript/RequirementsTest_b.js | 0 .../javascript/RequirementsTest_c.js | 0 .../javascript/bad.js | 0 .../public/css/RequirementsTest_d.css | 0 .../public/css/RequirementsTest_e.css | 0 .../public/css/RequirementsTest_print_d.css | 0 .../public/css/RequirementsTest_print_e.css | 0 .../css/deep/deeper/RequirementsTest_p.css | 0 .../public/javascript/RequirementsTest_d.js | 0 .../public/javascript/RequirementsTest_e.js | 0 .../SSTemplateEngineTestCommentsInclude.ss} | 0 ...mplateEngineTestIncludeObjectArguments.ss} | 0 ...gineTestIncludeScopeInheritanceInclude.ss} | 0 ...tIncludeScopeInheritanceWithArgsInLoop.ss} | 0 ...deScopeInheritanceWithArgsInNestedWith.ss} | 0 ...tIncludeScopeInheritanceWithArgsInWith.ss} | 0 ...estIncludeScopeInheritanceWithUpAndTop.ss} | 0 ...TemplateEngineTestIncludeWithArguments.ss} | 0 .../SSTemplateEngineTestProcessHead.ss} | 0 .../SSTemplateEngineTestRecursiveInclude.ss} | 2 +- .../SSTemplateEngineTestTypePreservation.ss} | 0 .../templates/Namespace/IncludedOnceBase.ss | 0 .../templates/Namespace/IncludedTwice.ss | 0 .../Namespace/Includes/IncludedOnceSub.ss | 0 .../Namespace/Includes/IncludedTwice.ss | 0 .../Namespace/Includes/NamespaceInclude.ss | 0 .../templates/RSSFeedTest.ss | 0 .../RequirementsTest_Conditionals.ss | 0 ...SSTemplateEngineTestCommentsFullSource.ss} | 0 ...gineTestCommentsFullSourceHTML4Doctype.ss} | 0 ...mplateEngineTestCommentsFullSourceIfIE.ss} | 0 ...ineTestCommentsFullSourceIfIENoDoctype.ss} | 0 ...eEngineTestCommentsFullSourceNoDoctype.ss} | 0 ...emplateEngineTestCommentsPartialSource.ss} | 0 ...SSTemplateEngineTestCommentsWithInclude.ss | 1 + ...mplateEngineTestIncludeScopeInheritance.ss | 3 + ...gineTestIncludeScopeInheritanceWithArgs.ss | 3 + .../SSTemplateEngineTestLoopArray.ss} | 0 .../SSTemplateEngineTestPartialTemplate.ss} | 0 .../templates/SSTemplateEngineTestProcess.ss | 6 + .../themes/layouttest/templates/Controller.ss | 0 .../layouttest/templates/Layout/Page.ss | 0 .../layouttest/templates/Layout/Shortcodes.ss | 0 .../themes/layouttest/templates/Page.ss | 0 .../SSTemplateEngineTestModel_Controller.ss | 1 + tests/php/View/SSViewerTest.php | 2319 +---------------- .../View/SSViewerTest/DummyTemplateEngine.php | 45 + tests/php/View/SSViewerTest/TestFixture.php | 72 - .../View/SSViewerTest/TestGlobalProvider.php | 51 - .../SSViewerTestCommentsWithInclude.ss | 1 - .../SSViewerTestIncludeScopeInheritance.ss | 3 - ...ewerTestIncludeScopeInheritanceWithArgs.ss | 3 - .../templates/SSViewerTestProcess.ss | 6 - .../SSViewerTestModel_Controller.ss | 1 - tests/php/i18n/i18nTestManifest.php | 6 +- 130 files changed, 4075 insertions(+), 3860 deletions(-) create mode 100644 _config/view.yml create mode 100644 src/View/CastingService.php create mode 100644 src/View/Exception/MissingTemplateException.php create mode 100644 src/View/SSTemplateEngine.php delete mode 100644 src/View/SSViewer_DataPresenter.php create mode 100644 src/View/TemplateEngine.php create mode 100644 src/View/ViewLayerData.php create mode 100644 tests/php/View/SSTemplateEngineTest.php rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/CacheTestData.php (92%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/LevelTestData.php (92%) create mode 100644 tests/php/View/SSTemplateEngineTest/TestFixture.php create mode 100644 tests/php/View/SSTemplateEngineTest/TestGlobalProvider.php rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/TestObject.php (70%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/TestViewableData.php (93%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/css/RequirementsTest_a.css (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/css/RequirementsTest_b.css (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/css/RequirementsTest_c.css (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/css/RequirementsTest_print_a.css (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/css/RequirementsTest_print_b.css (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/i18n/en-gb.js (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/i18n/en-us.js (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/i18n/en.js (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/i18n/en_GB.js (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/i18n/en_US.js (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/i18n/fr-ca.js (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/i18n/fr.js (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/i18n/fr_CA.js (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/i18n/mi.js (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/javascript/RequirementsTest_a.js (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/javascript/RequirementsTest_b.js (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/javascript/RequirementsTest_c.js (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/javascript/bad.js (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/public/css/RequirementsTest_d.css (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/public/css/RequirementsTest_e.css (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/public/css/RequirementsTest_print_d.css (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/public/css/RequirementsTest_print_e.css (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/public/css/deep/deeper/RequirementsTest_p.css (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/public/javascript/RequirementsTest_d.js (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/public/javascript/RequirementsTest_e.js (100%) rename tests/php/View/{SSViewerTest/templates/Includes/SSViewerTestCommentsInclude.ss => SSTemplateEngineTest/templates/Includes/SSTemplateEngineTestCommentsInclude.ss} (100%) rename tests/php/View/{SSViewerTest/templates/Includes/SSViewerTestIncludeObjectArguments.ss => SSTemplateEngineTest/templates/Includes/SSTemplateEngineTestIncludeObjectArguments.ss} (100%) rename tests/php/View/{SSViewerTest/templates/Includes/SSViewerTestIncludeScopeInheritanceInclude.ss => SSTemplateEngineTest/templates/Includes/SSTemplateEngineTestIncludeScopeInheritanceInclude.ss} (100%) rename tests/php/View/{SSViewerTest/templates/Includes/SSViewerTestIncludeScopeInheritanceWithArgsInLoop.ss => SSTemplateEngineTest/templates/Includes/SSTemplateEngineTestIncludeScopeInheritanceWithArgsInLoop.ss} (100%) rename tests/php/View/{SSViewerTest/templates/Includes/SSViewerTestIncludeScopeInheritanceWithArgsInNestedWith.ss => SSTemplateEngineTest/templates/Includes/SSTemplateEngineTestIncludeScopeInheritanceWithArgsInNestedWith.ss} (100%) rename tests/php/View/{SSViewerTest/templates/Includes/SSViewerTestIncludeScopeInheritanceWithArgsInWith.ss => SSTemplateEngineTest/templates/Includes/SSTemplateEngineTestIncludeScopeInheritanceWithArgsInWith.ss} (100%) rename tests/php/View/{SSViewerTest/templates/Includes/SSViewerTestIncludeScopeInheritanceWithUpAndTop.ss => SSTemplateEngineTest/templates/Includes/SSTemplateEngineTestIncludeScopeInheritanceWithUpAndTop.ss} (100%) rename tests/php/View/{SSViewerTest/templates/Includes/SSViewerTestIncludeWithArguments.ss => SSTemplateEngineTest/templates/Includes/SSTemplateEngineTestIncludeWithArguments.ss} (100%) rename tests/php/View/{SSViewerTest/templates/Includes/SSViewerTestProcessHead.ss => SSTemplateEngineTest/templates/Includes/SSTemplateEngineTestProcessHead.ss} (100%) rename tests/php/View/{SSViewerTest/templates/Includes/SSViewerTestRecursiveInclude.ss => SSTemplateEngineTest/templates/Includes/SSTemplateEngineTestRecursiveInclude.ss} (58%) rename tests/php/View/{SSViewerTest/templates/Includes/SSViewerTestTypePreservation.ss => SSTemplateEngineTest/templates/Includes/SSTemplateEngineTestTypePreservation.ss} (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/templates/Namespace/IncludedOnceBase.ss (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/templates/Namespace/IncludedTwice.ss (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/templates/Namespace/Includes/IncludedOnceSub.ss (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/templates/Namespace/Includes/IncludedTwice.ss (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/templates/Namespace/Includes/NamespaceInclude.ss (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/templates/RSSFeedTest.ss (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/templates/RequirementsTest_Conditionals.ss (100%) rename tests/php/View/{SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsFullSource.ss => SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsFullSource.ss} (100%) rename tests/php/View/{SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsFullSourceHTML4Doctype.ss => SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsFullSourceHTML4Doctype.ss} (100%) rename tests/php/View/{SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsFullSourceIfIE.ss => SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsFullSourceIfIE.ss} (100%) rename tests/php/View/{SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsFullSourceIfIENoDoctype.ss => SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsFullSourceIfIENoDoctype.ss} (100%) rename tests/php/View/{SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsFullSourceNoDoctype.ss => SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsFullSourceNoDoctype.ss} (100%) rename tests/php/View/{SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsPartialSource.ss => SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsPartialSource.ss} (100%) create mode 100644 tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsWithInclude.ss create mode 100644 tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestIncludeScopeInheritance.ss create mode 100644 tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestIncludeScopeInheritanceWithArgs.ss rename tests/php/View/{SSViewerTest/templates/SSViewerTestLoopArray.ss => SSTemplateEngineTest/templates/SSTemplateEngineTestLoopArray.ss} (100%) rename tests/php/View/{SSViewerTest/templates/SSViewerTestPartialTemplate.ss => SSTemplateEngineTest/templates/SSTemplateEngineTestPartialTemplate.ss} (100%) create mode 100644 tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestProcess.ss rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/themes/layouttest/templates/Controller.ss (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/themes/layouttest/templates/Layout/Page.ss (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/themes/layouttest/templates/Layout/Shortcodes.ss (100%) rename tests/php/View/{SSViewerTest => SSTemplateEngineTest}/themes/layouttest/templates/Page.ss (100%) create mode 100644 tests/php/View/SSTemplateEngineTest/themes/layouttest/templates/TestNamespace/SSTemplateEngineTestModel_Controller.ss create mode 100644 tests/php/View/SSViewerTest/DummyTemplateEngine.php delete mode 100644 tests/php/View/SSViewerTest/TestFixture.php delete mode 100644 tests/php/View/SSViewerTest/TestGlobalProvider.php delete mode 100644 tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsWithInclude.ss delete mode 100644 tests/php/View/SSViewerTest/templates/SSViewerTestIncludeScopeInheritance.ss delete mode 100644 tests/php/View/SSViewerTest/templates/SSViewerTestIncludeScopeInheritanceWithArgs.ss delete mode 100644 tests/php/View/SSViewerTest/templates/SSViewerTestProcess.ss delete mode 100644 tests/php/View/SSViewerTest/themes/layouttest/templates/TestNamespace/SSViewerTestModel_Controller.ss diff --git a/_config/view.yml b/_config/view.yml new file mode 100644 index 000000000..fd8293c9f --- /dev/null +++ b/_config/view.yml @@ -0,0 +1,6 @@ +--- +Name: view-config +--- +SilverStripe\Core\Injector\Injector: + SilverStripe\View\TemplateEngine: + class: 'SilverStripe\View\SSTemplateEngine' diff --git a/src/Control/ContentNegotiator.php b/src/Control/ContentNegotiator.php index aeb3b9f54..4bb9b46c1 100644 --- a/src/Control/ContentNegotiator.php +++ b/src/Control/ContentNegotiator.php @@ -225,7 +225,7 @@ class ContentNegotiator // Fix base tag $content = preg_replace( '//', - '', + '', $content ?? '' ); diff --git a/src/Control/Controller.php b/src/Control/Controller.php index d1abe672f..eb23078f5 100644 --- a/src/Control/Controller.php +++ b/src/Control/Controller.php @@ -3,11 +3,14 @@ namespace SilverStripe\Control; use SilverStripe\Core\ClassInfo; +use SilverStripe\Core\Injector\Injector; use SilverStripe\Dev\Debug; +use SilverStripe\Model\ModelData; use SilverStripe\ORM\FieldType\DBHTMLText; use SilverStripe\Security\Member; use SilverStripe\Security\Security; use SilverStripe\View\SSViewer; +use SilverStripe\View\TemplateEngine; use SilverStripe\View\TemplateGlobalProvider; /** @@ -88,6 +91,8 @@ class Controller extends RequestHandler implements TemplateGlobalProvider 'handleIndex', ]; + protected ?TemplateEngine $templateEngine = null; + public function __construct() { parent::__construct(); @@ -401,7 +406,7 @@ class Controller extends RequestHandler implements TemplateGlobalProvider $templates = array_unique(array_merge($actionTemplates, $classTemplates)); } - return SSViewer::create($templates); + return SSViewer::create($templates, $this->getTemplateEngine()); } /** @@ -453,9 +458,10 @@ class Controller extends RequestHandler implements TemplateGlobalProvider } $class = static::class; - while ($class != 'SilverStripe\\Control\\RequestHandler') { + $engine = $this->getTemplateEngine(); + while ($class !== RequestHandler::class) { $templateName = strtok($class ?? '', '_') . '_' . $action; - if (SSViewer::hasTemplate($templateName)) { + if ($engine->hasTemplate($templateName)) { return $class; } @@ -487,17 +493,25 @@ class Controller extends RequestHandler implements TemplateGlobalProvider $parentClass = get_parent_class($parentClass ?? ''); } - return SSViewer::hasTemplate($templates); + $engine = $this->getTemplateEngine(); + return $engine->hasTemplate($templates); + } + + public function renderWith($template, ModelData|array $customFields = []): DBHTMLText + { + // Ensure template engine is used, unless the viewer was already explicitly instantiated + if (!($template instanceof SSViewer)) { + $template = SSViewer::create($template, $this->getTemplateEngine()); + } + return parent::renderWith($template, $customFields); } /** * Render the current controller with the templates determined by {@link getViewer()}. * * @param array $params - * - * @return string */ - public function render($params = null) + public function render($params = null): DBHTMLText { $template = $this->getViewer($this->getAction()); @@ -737,4 +751,12 @@ class Controller extends RequestHandler implements TemplateGlobalProvider 'CurrentPage' => 'curr', ]; } + + protected function getTemplateEngine(): TemplateEngine + { + if (!$this->templateEngine) { + $this->templateEngine = Injector::inst()->create(TemplateEngine::class); + } + return $this->templateEngine; + } } diff --git a/src/Control/RSS/RSSFeed_Entry.php b/src/Control/RSS/RSSFeed_Entry.php index 1ebaae7e7..66034d711 100644 --- a/src/Control/RSS/RSSFeed_Entry.php +++ b/src/Control/RSS/RSSFeed_Entry.php @@ -47,7 +47,7 @@ class RSSFeed_Entry extends ModelData */ public function __construct($entry, $titleField, $descriptionField, $authorField) { - $this->failover = $entry; + $this->setFailover($entry); $this->titleField = $titleField; $this->descriptionField = $descriptionField; $this->authorField = $authorField; @@ -58,7 +58,7 @@ class RSSFeed_Entry extends ModelData /** * Get the description of this entry * - * @return DBField Returns the description of the entry. + * @return DBField|null Returns the description of the entry. */ public function Title() { @@ -68,7 +68,7 @@ class RSSFeed_Entry extends ModelData /** * Get the description of this entry * - * @return DBField Returns the description of the entry. + * @return DBField|null Returns the description of the entry. */ public function Description() { @@ -85,7 +85,7 @@ class RSSFeed_Entry extends ModelData /** * Get the author of this entry * - * @return DBField Returns the author of the entry. + * @return DBField|null Returns the author of the entry. */ public function Author() { @@ -96,7 +96,7 @@ class RSSFeed_Entry extends ModelData * Return the safely casted field * * @param string $fieldName Name of field - * @return DBField + * @return DBField|null */ public function rssField($fieldName) { diff --git a/src/Dev/Backtrace.php b/src/Dev/Backtrace.php index 62d402efc..9aa7b85ad 100644 --- a/src/Dev/Backtrace.php +++ b/src/Dev/Backtrace.php @@ -149,11 +149,11 @@ class Backtrace if ($showArgs && isset($item['args'])) { $args = []; foreach ($item['args'] as $arg) { - if (!is_object($arg) || method_exists($arg, '__toString')) { + if (is_object($arg)) { + $args[] = get_class($arg); + } else { $sarg = is_array($arg) ? 'Array' : strval($arg); $args[] = (strlen($sarg ?? '') > $argCharLimit) ? substr($sarg, 0, $argCharLimit) . '...' : $sarg; - } else { - $args[] = get_class($arg); } } diff --git a/src/Forms/DropdownField.php b/src/Forms/DropdownField.php index ed5da3000..9e3124525 100644 --- a/src/Forms/DropdownField.php +++ b/src/Forms/DropdownField.php @@ -68,7 +68,7 @@ use SilverStripe\Model\ArrayData; * DropdownField::create( * 'Country', * 'Country', - * singleton(MyObject::class)->dbObject('Country')->enumValues() + * singleton(MyObject::class)->dbObject('Country')?->enumValues() * ); * * diff --git a/src/Forms/FieldGroup.php b/src/Forms/FieldGroup.php index 9a0d6c675..c61de2136 100644 --- a/src/Forms/FieldGroup.php +++ b/src/Forms/FieldGroup.php @@ -154,7 +154,7 @@ class FieldGroup extends CompositeField /** @var FormField $subfield */ $messages = []; foreach ($dataFields as $subfield) { - $message = $subfield->obj('Message')->forTemplate(); + $message = $subfield->obj('Message')?->forTemplate(); if ($message) { $messages[] = rtrim($message ?? '', "."); } diff --git a/src/Forms/Form.php b/src/Forms/Form.php index 7ce206f8d..1a02ca27f 100644 --- a/src/Forms/Form.php +++ b/src/Forms/Form.php @@ -899,10 +899,10 @@ class Form extends ModelData implements HasRequestHandler } /** - * Set the SS template that this form should use + * Set the template or template candidates that this form should use * to render with. The default is "Form". * - * @param string|array $template The name of the template (without the .ss extension) or array form + * @param string|array $template The name of the template (without the file extension) or array of candidates * @return $this */ public function setTemplate($template) diff --git a/src/Forms/FormField.php b/src/Forms/FormField.php index 0d210436b..264090010 100644 --- a/src/Forms/FormField.php +++ b/src/Forms/FormField.php @@ -15,6 +15,7 @@ use SilverStripe\Core\Validation\ValidationResult; use SilverStripe\View\AttributesHTML; use SilverStripe\View\SSViewer; use SilverStripe\Model\ModelData; +use SilverStripe\ORM\DataObject; /** * Represents a field in a form. @@ -458,7 +459,7 @@ class FormField extends RequestHandler * * By default, makes use of $this->dataValue() * - * @param ModelData|DataObjectInterface $record Record to save data into + * @param DataObjectInterface $record Record to save data into */ public function saveInto(DataObjectInterface $record) { @@ -469,7 +470,9 @@ class FormField extends RequestHandler if (($pos = strrpos($this->name ?? '', '.')) !== false) { $relation = substr($this->name ?? '', 0, $pos); $fieldName = substr($this->name ?? '', $pos + 1); - $component = $record->relObject($relation); + if ($record instanceof DataObject) { + $component = $record->relObject($relation); + } } if ($fieldName && $component) { @@ -1469,12 +1472,12 @@ class FormField extends RequestHandler 'schemaType' => $this->getSchemaDataType(), 'component' => $this->getSchemaComponent(), 'holderId' => $this->HolderID(), - 'title' => $this->obj('Title')->getSchemaValue(), + 'title' => $this->obj('Title')?->getSchemaValue(), 'source' => null, 'extraClass' => $this->extraClass(), - 'description' => $this->obj('Description')->getSchemaValue(), - 'rightTitle' => $this->obj('RightTitle')->getSchemaValue(), - 'leftTitle' => $this->obj('LeftTitle')->getSchemaValue(), + 'description' => $this->obj('Description')?->getSchemaValue(), + 'rightTitle' => $this->obj('RightTitle')?->getSchemaValue(), + 'leftTitle' => $this->obj('LeftTitle')?->getSchemaValue(), 'readOnly' => $this->isReadonly(), 'disabled' => $this->isDisabled(), 'customValidationMessage' => $this->getCustomValidationMessage(), diff --git a/src/Forms/FormScaffolder.php b/src/Forms/FormScaffolder.php index 099dabf5d..db43a88e8 100644 --- a/src/Forms/FormScaffolder.php +++ b/src/Forms/FormScaffolder.php @@ -115,7 +115,7 @@ class FormScaffolder $fieldObject = $this ->obj ->dbObject($fieldName) - ->scaffoldFormField(null, $this->getParamsArray()); + ?->scaffoldFormField(null, $this->getParamsArray()); } // Allow fields to opt-out of scaffolding if (!$fieldObject) { @@ -145,7 +145,7 @@ class FormScaffolder $fieldClass = $this->fieldClasses[$fieldName]; $hasOneField = new $fieldClass($fieldName); } else { - $hasOneField = $this->obj->dbObject($fieldName)->scaffoldFormField(null, $this->getParamsArray()); + $hasOneField = $this->obj->dbObject($fieldName)?->scaffoldFormField(null, $this->getParamsArray()); } if (empty($hasOneField)) { continue; // Allow fields to opt out of scaffolding diff --git a/src/Forms/GridField/GridFieldAddExistingAutocompleter.php b/src/Forms/GridField/GridFieldAddExistingAutocompleter.php index 3c8b0aac0..19ed77c64 100644 --- a/src/Forms/GridField/GridFieldAddExistingAutocompleter.php +++ b/src/Forms/GridField/GridFieldAddExistingAutocompleter.php @@ -17,6 +17,7 @@ use SilverStripe\Model\ArrayData; use SilverStripe\View\SSViewer; use LogicException; use SilverStripe\Control\HTTPResponse_Exception; +use SilverStripe\View\SSViewer_FromString; /** * This class is is responsible for adding objects to another object's has_many @@ -283,12 +284,12 @@ class GridFieldAddExistingAutocompleter extends AbstractGridFieldComponent imple $json = []; Config::nest(); SSViewer::config()->set('source_file_comments', false); - $viewer = SSViewer::fromString($this->resultsFormat); + $viewer = SSViewer_FromString::create($this->resultsFormat); foreach ($results as $result) { if (!$result->canView()) { continue; } - $title = Convert::html2raw($viewer->process($result)); + $title = Convert::html2raw($viewer->process($result, cache: false)); $json[] = [ 'label' => $title, 'value' => $title, diff --git a/src/Forms/HTMLEditor/HTMLEditorField.php b/src/Forms/HTMLEditor/HTMLEditorField.php index 90c3fad75..4527dd1de 100644 --- a/src/Forms/HTMLEditor/HTMLEditorField.php +++ b/src/Forms/HTMLEditor/HTMLEditorField.php @@ -5,9 +5,11 @@ namespace SilverStripe\Forms\HTMLEditor; use SilverStripe\Assets\Shortcodes\ImageShortcodeProvider; use SilverStripe\Forms\FormField; use SilverStripe\Forms\TextareaField; -use SilverStripe\ORM\DataObject; use SilverStripe\ORM\DataObjectInterface; use Exception; +use SilverStripe\Model\ModelData; +use SilverStripe\ORM\FieldType\DBField; +use SilverStripe\View\CastingService; use SilverStripe\View\Parsers\HTMLValue; /** @@ -123,13 +125,9 @@ class HTMLEditorField extends TextareaField ); } - /** - * @param DataObject|DataObjectInterface $record - * @throws Exception - */ public function saveInto(DataObjectInterface $record) { - if ($record->hasField($this->name) && $record->escapeTypeForField($this->name) != 'xml') { + if (!$this->usesXmlFriendlyField($record)) { throw new Exception( 'HTMLEditorField->saveInto(): This field should save into a HTMLText or HTMLVarchar field.' ); @@ -225,4 +223,15 @@ class HTMLEditorField extends TextareaField return $config; } + + private function usesXmlFriendlyField(DataObjectInterface $record): bool + { + if ($record instanceof ModelData && !$record->hasField($this->getName())) { + return true; + } + + $castingService = CastingService::singleton(); + $castValue = $castingService->cast($this->Value(), $record, $this->getName()); + return $castValue instanceof DBField && $castValue::config()->get('escape_type') === 'xml'; + } } diff --git a/src/Forms/TreeDropdownField.php b/src/Forms/TreeDropdownField.php index c503c591a..5bf454f55 100644 --- a/src/Forms/TreeDropdownField.php +++ b/src/Forms/TreeDropdownField.php @@ -7,6 +7,7 @@ use InvalidArgumentException; use SilverStripe\Assets\Folder; use SilverStripe\Control\HTTPRequest; use SilverStripe\Control\HTTPResponse; +use SilverStripe\Model\List\SS_List; use SilverStripe\ORM\DataList; use SilverStripe\ORM\DataObject; use SilverStripe\ORM\FieldType\DBDatetime; @@ -519,13 +520,20 @@ class TreeDropdownField extends FormField implements HasOneRelationFieldInterfac // Allow to pass values to be selected within the ajax request $value = $request->requestVar('forceValue') ?: $this->value; - if ($value && ($values = preg_split('/,\s*/', $value ?? ''))) { + if ($value instanceof SS_List) { + $values = $value; + } elseif ($value) { + $values = preg_split('/,\s*/', $value ?? ''); + } else { + $values = []; + } + if (!empty($values)) { foreach ($values as $value) { if (!$value || $value == 'unchanged') { continue; } - $object = $this->objectForKey($value); + $object = is_object($value) ? $value : $this->objectForKey($value); if (!$object) { continue; } @@ -870,14 +878,14 @@ class TreeDropdownField extends FormField implements HasOneRelationFieldInterfac $ancestors = $record->getAncestors(true)->reverse(); foreach ($ancestors as $parent) { - $title = $parent->obj($this->getTitleField())->getValue(); + $title = $parent->obj($this->getTitleField())?->getValue(); $titlePath .= $title . '/'; } } $data['data']['valueObject'] = [ - 'id' => $record->obj($this->getKeyField())->getValue(), - 'title' => $record->obj($this->getTitleField())->getValue(), - 'treetitle' => $record->obj($this->getLabelField())->getSchemaValue(), + 'id' => $record->obj($this->getKeyField())?->getValue(), + 'title' => $record->obj($this->getTitleField())?->getValue(), + 'treetitle' => $record->obj($this->getLabelField())?->getSchemaValue(), 'titlePath' => $titlePath, ]; } diff --git a/src/Forms/TreeMultiselectField.php b/src/Forms/TreeMultiselectField.php index a1362f247..449a275fe 100644 --- a/src/Forms/TreeMultiselectField.php +++ b/src/Forms/TreeMultiselectField.php @@ -92,10 +92,10 @@ class TreeMultiselectField extends TreeDropdownField foreach ($items as $item) { if ($item instanceof DataObject) { $values[] = [ - 'id' => $item->obj($this->getKeyField())->getValue(), - 'title' => $item->obj($this->getTitleField())->getValue(), + 'id' => $item->obj($this->getKeyField())?->getValue(), + 'title' => $item->obj($this->getTitleField())?->getValue(), 'parentid' => $item->ParentID, - 'treetitle' => $item->obj($this->getLabelField())->getSchemaValue(), + 'treetitle' => $item->obj($this->getLabelField())?->getSchemaValue(), ]; } else { $values[] = $item; @@ -212,7 +212,7 @@ class TreeMultiselectField extends TreeDropdownField foreach ($items as $item) { $idArray[] = $item->ID; $titleArray[] = ($item instanceof ModelData) - ? $item->obj($this->getLabelField())->forTemplate() + ? $item->obj($this->getLabelField())?->forTemplate() : Convert::raw2xml($item->{$this->getLabelField()}); } diff --git a/src/Model/List/ListDecorator.php b/src/Model/List/ListDecorator.php index 6cfc963b4..fa3c43dae 100644 --- a/src/Model/List/ListDecorator.php +++ b/src/Model/List/ListDecorator.php @@ -56,7 +56,9 @@ abstract class ListDecorator extends ModelData implements SS_List, Sortable, Fil public function setList(SS_List&Sortable&Filterable&Limitable $list): ListDecorator { $this->list = $list; - $this->failover = $this->list; + if ($list instanceof ModelData) { + $this->setFailover($list); + } return $this; } diff --git a/src/Model/ModelData.php b/src/Model/ModelData.php index 04d5a1fc0..e001de45e 100644 --- a/src/Model/ModelData.php +++ b/src/Model/ModelData.php @@ -12,14 +12,14 @@ use SilverStripe\Core\Config\Configurable; use SilverStripe\Core\Convert; use SilverStripe\Core\Extensible; use SilverStripe\Core\Injector\Injectable; -use SilverStripe\Core\Injector\Injector; use SilverStripe\Dev\Debug; use SilverStripe\Core\ArrayLib; -use SilverStripe\Model\List\ArrayList; use SilverStripe\ORM\FieldType\DBField; use SilverStripe\ORM\FieldType\DBHTMLText; use SilverStripe\Model\ArrayData; +use SilverStripe\View\CastingService; use SilverStripe\View\SSViewer; +use Stringable; use UnexpectedValueException; /** @@ -29,7 +29,7 @@ use UnexpectedValueException; * is provided and automatically escaped by ModelData. Any class that needs to be available to a view (controllers, * {@link DataObject}s, page controls) should inherit from this class. */ -class ModelData +class ModelData implements Stringable { use Extensible { defineMethods as extensibleDefineMethods; @@ -38,7 +38,7 @@ class ModelData use Configurable; /** - * An array of objects to cast certain fields to. This is set up as an array in the format: + * An array of DBField classes to cast certain fields to. This is set up as an array in the format: * * * public static $casting = array ( @@ -47,16 +47,18 @@ class ModelData * */ private static array $casting = [ - 'CSSClasses' => 'Varchar' + 'CSSClasses' => 'Varchar', + 'forTemplate' => 'HTMLText', ]; /** - * The default object to cast scalar fields to if casting information is not specified, and casting to an object + * The default class to cast scalar fields to if casting information is not specified, and casting to an object * is required. + * This can be any injectable service name but must resolve to a DBField subclass. + * + * If null, casting will be determined based on the type of value (e.g. integers will be cast to DBInt) */ - private static string $default_cast = 'Text'; - - private static array $casting_cache = []; + private static ?string $default_cast = null; /** * Acts as a PHP 8.2+ compliant replacement for dynamic properties @@ -251,8 +253,7 @@ class ModelData // ----------------------------------------------------------------------------------------------------------------- /** - * Add methods from the {@link ModelData::$failover} object, as well as wrapping any methods prefixed with an - * underscore into a {@link ModelData::cachedCall()}. + * Add methods from the {@link ModelData::$failover} object * * @throws LogicException */ @@ -305,12 +306,18 @@ class ModelData return true; } - /** - * Return the class name (though subclasses may return something else) - */ public function __toString(): string { - return static::class; + return $this->forTemplate(); + } + + /** + * Return the HTML markup that represents this model when it is directly injected into a template (e.g. using $Me). + * By default this attempts to render the model using templates based on the class hierarchy. + */ + public function forTemplate(): string + { + return $this->renderWith($this->getViewerTemplates()); } public function getCustomisedObj(): ?ModelData @@ -326,14 +333,10 @@ class ModelData // CASTING --------------------------------------------------------------------------------------------------------- /** - * Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) + * Return the "casting helper" (an injectable service name) * for a field on this object. This helper will be a subclass of DBField. - * - * @param bool $useFallback If true, fall back on the default casting helper if there isn't an explicit one. - * @return string|null Casting helper As a constructor pattern, and may include arguments. - * @throws Exception */ - public function castingHelper(string $field, bool $useFallback = true): ?string + public function castingHelper(string $field): ?string { // Get casting if it has been configured. // DB fields and PHP methods are all case insensitive so we normalise casing before checking. @@ -346,67 +349,15 @@ class ModelData // If no specific cast is declared, fall back to failover. $failover = $this->getFailover(); if ($failover) { - $cast = $failover->castingHelper($field, $useFallback); + $cast = $failover->castingHelper($field); if ($cast) { return $cast; } } - if ($useFallback) { - return $this->defaultCastingHelper($field); - } - return null; } - /** - * Return the default "casting helper" for use when no explicit casting helper is defined. - * This helper will be a subclass of DBField. See castingHelper() - */ - protected function defaultCastingHelper(string $field): string - { - // If there is a failover, the default_cast will always - // be drawn from this object instead of the top level object. - $failover = $this->getFailover(); - if ($failover) { - $cast = $failover->defaultCastingHelper($field); - if ($cast) { - return $cast; - } - } - - // Fall back to raw default_cast - $default = $this->config()->get('default_cast'); - if (empty($default)) { - throw new Exception('No default_cast'); - } - return $default; - } - - /** - * Get the class name a field on this object will be casted to. - */ - public function castingClass(string $field): string - { - // Strip arguments - $spec = $this->castingHelper($field); - return trim(strtok($spec ?? '', '(') ?? ''); - } - - /** - * Return the string-format type for the given field. - * - * @return string 'xml'|'raw' - */ - public function escapeTypeForField(string $field): string - { - $class = $this->castingClass($field) ?: $this->config()->get('default_cast'); - - /** @var DBField $type */ - $type = Injector::inst()->get($class, true); - return $type->config()->get('escape_type'); - } - // TEMPLATE ACCESS LAYER ------------------------------------------------------------------------------------------- /** @@ -417,9 +368,9 @@ class ModelData * - an SSViewer instance * * @param string|array|SSViewer $template the template to render into - * @param ModelData|array|null $customFields fields to customise() the object with before rendering + * @param ModelData|array $customFields fields to customise() the object with before rendering */ - public function renderWith($template, ModelData|array|null $customFields = null): DBHTMLText + public function renderWith($template, ModelData|array $customFields = []): DBHTMLText { if (!is_object($template)) { $template = SSViewer::create($template); @@ -429,9 +380,10 @@ class ModelData if ($customFields instanceof ModelData) { $data = $data->customise($customFields); + $customFields = []; } if ($template instanceof SSViewer) { - return $template->process($data, is_array($customFields) ? $customFields : null); + return $template->process($data, $customFields); } throw new UnexpectedValueException( @@ -440,27 +392,11 @@ class ModelData } /** - * Generate the cache name for a field - * - * @param string $fieldName Name of field - * @param array $arguments List of optional arguments given - * @return string + * Get a cached value from the field cache for a field */ - protected function objCacheName($fieldName, $arguments) - { - return $arguments - ? $fieldName . ":" . var_export($arguments, true) - : $fieldName; - } - - /** - * Get a cached value from the field cache - * - * @param string $key Cache key - * @return mixed - */ - protected function objCacheGet($key) + public function objCacheGet(string $fieldName, array $arguments = []): mixed { + $key = $this->objCacheName($fieldName, $arguments); if (isset($this->objCache[$key])) { return $this->objCache[$key]; } @@ -468,14 +404,11 @@ class ModelData } /** - * Store a value in the field cache - * - * @param string $key Cache key - * @param mixed $value - * @return $this + * Store a value in the field cache for a field */ - protected function objCacheSet($key, $value) + public function objCacheSet(string $fieldName, array $arguments, mixed $value): static { + $key = $this->objCacheName($fieldName, $arguments); $this->objCache[$key] = $value; return $this; } @@ -485,7 +418,7 @@ class ModelData * * @return $this */ - protected function objCacheClear() + public function objCacheClear() { $this->objCache = []; return $this; @@ -497,82 +430,40 @@ class ModelData * * @return object|DBField|null The specific object representing the field, or null if there is no * property, method, or dynamic data available for that field. - * Note that if there is a property or method that returns null, a relevant DBField instance will - * be returned. */ public function obj( string $fieldName, array $arguments = [], - bool $cache = false, - ?string $cacheName = null + bool $cache = false ): ?object { - $hasObj = false; - if (!$cacheName && $cache) { - $cacheName = $this->objCacheName($fieldName, $arguments); - } - // Check pre-cached value - $value = $cache ? $this->objCacheGet($cacheName) : null; - if ($value !== null) { - return $value; - } + $value = $cache ? $this->objCacheGet($fieldName, $arguments) : null; + if ($value === null) { + $hasObj = false; + // Load value from record + if ($this->hasMethod($fieldName)) { + // Try methods first - there's a LOT of logic that assumes this will be checked first. + $hasObj = true; + $value = call_user_func_array([$this, $fieldName], $arguments ?: []); + } else { + // Try fields and getters if there was no method with that name. + $hasObj = $this->hasField($fieldName) || ($this->hasMethod("get{$fieldName}") && $this->isAccessibleMethod("get{$fieldName}")); + $value = $this->$fieldName;// @TODO may need _get() explicitly here + } - // Load value from record - if ($this->hasMethod($fieldName)) { - $hasObj = true; - $value = call_user_func_array([$this, $fieldName], $arguments ?: []); - } else { - $hasObj = $this->hasField($fieldName) || ($this->hasMethod("get{$fieldName}") && $this->isAccessibleMethod("get{$fieldName}")); - $value = $this->$fieldName; - } + // Record in cache + if ($value !== null && $cache) { + $this->objCacheSet($fieldName, $arguments, $value); + } - // Return null early if there's no backing for this field - // i.e. no poperty, no method, etc - it just doesn't exist on this model. - if (!$hasObj && $value === null) { - return null; - } - - // Try to cast object if we have an explicit cast set - if (!is_object($value)) { - $castingHelper = $this->castingHelper($fieldName, false); - if ($castingHelper !== null) { - $valueObject = Injector::inst()->create($castingHelper, $fieldName); - $valueObject->setValue($value, $this); - $value = $valueObject; + // Return null early if there's no backing for this field + // i.e. no poperty, no method, etc - it just doesn't exist on this model. + if (!$hasObj && $value === null) { + return null; } } - // Wrap list arrays in ModelData so templates can handle them - if (is_array($value) && array_is_list($value)) { - $value = ArrayList::create($value); - } - - // Fallback on default casting - if (!is_object($value)) { - // Force cast - $castingHelper = $this->defaultCastingHelper($fieldName); - $valueObject = Injector::inst()->create($castingHelper, $fieldName); - $valueObject->setValue($value, $this); - $value = $valueObject; - } - - // Record in cache - if ($cache) { - $this->objCacheSet($cacheName, $value); - } - - return $value; - } - - /** - * A simple wrapper around {@link ModelData::obj()} that automatically caches the result so it can be used again - * without re-running the method. - * - * @return Object|DBField - */ - public function cachedCall(string $fieldName, array $arguments = [], ?string $cacheName = null): object - { - return $this->obj($fieldName, $arguments, true, $cacheName); + return CastingService::singleton()->cast($value, $this, $fieldName, true); } /** @@ -677,4 +568,14 @@ class ModelData { return ModelDataDebugger::create($this); } + + /** + * Generate the cache name for a field + */ + private function objCacheName(string $fieldName, array $arguments = []): string + { + return empty($arguments) + ? $fieldName + : $fieldName . ":" . var_export($arguments, true); + } } diff --git a/src/Model/ModelDataCustomised.php b/src/Model/ModelDataCustomised.php index 6ae73be21..bc86d4a72 100644 --- a/src/Model/ModelDataCustomised.php +++ b/src/Model/ModelDataCustomised.php @@ -49,17 +49,22 @@ class ModelDataCustomised extends ModelData return isset($this->customised->$property) || isset($this->original->$property) || parent::__isset($property); } + public function forTemplate(): string + { + return $this->original->forTemplate(); + } + public function hasMethod($method) { return $this->customised->hasMethod($method) || $this->original->hasMethod($method); } - public function cachedCall(string $fieldName, array $arguments = [], ?string $cacheName = null): object + public function castingHelper(string $field): ?string { - if ($this->customisedHas($fieldName)) { - return $this->customised->cachedCall($fieldName, $arguments, $cacheName); + if ($this->customisedHas($field)) { + return $this->customised->castingHelper($field); } - return $this->original->cachedCall($fieldName, $arguments, $cacheName); + return $this->original->castingHelper($field); } public function obj( @@ -74,10 +79,15 @@ class ModelDataCustomised extends ModelData return $this->original->obj($fieldName, $arguments, $cache, $cacheName); } - private function customisedHas(string $fieldName): bool + public function customisedHas(string $fieldName): bool { return property_exists($this->customised, $fieldName) || $this->customised->hasField($fieldName) || $this->customised->hasMethod($fieldName); } + + public function getCustomisedModelData(): ?ModelData + { + return $this->customised; + } } diff --git a/src/ORM/DataList.php b/src/ORM/DataList.php index d703d3b90..e8d69f27f 100644 --- a/src/ORM/DataList.php +++ b/src/ORM/DataList.php @@ -19,6 +19,7 @@ use SilverStripe\Model\List\Limitable; use SilverStripe\Model\List\Map; use SilverStripe\Model\List\Sortable; use SilverStripe\Model\List\SS_List; +use SilverStripe\ORM\FieldType\DBField; use SilverStripe\ORM\Filters\SearchFilterable; /** @@ -1852,7 +1853,7 @@ class DataList extends ModelData implements SS_List, Filterable, Sortable, Limit return $relation; } - public function dbObject($fieldName) + public function dbObject(string $fieldName): ?DBField { return singleton($this->dataClass)->dbObject($fieldName); } diff --git a/src/ORM/DataObject.php b/src/ORM/DataObject.php index 2b6bed1da..913250645 100644 --- a/src/ORM/DataObject.php +++ b/src/ORM/DataObject.php @@ -104,9 +104,6 @@ use stdClass; * } * * - * If any public method on this class is prefixed with an underscore, - * the results are cached in memory through {@link cachedCall()}. - * * @property int $ID ID of the DataObject, 0 if the DataObject doesn't exist in database. * @property int $OldID ID of object, if deleted * @property string $Title @@ -3033,7 +3030,7 @@ class DataObject extends ModelData implements DataObjectInterface, i18nEntityPro /** * {@inheritdoc} */ - public function castingHelper(string $field, bool $useFallback = true): ?string + public function castingHelper(string $field): ?string { $fieldSpec = static::getSchema()->fieldSpec(static::class, $field); if ($fieldSpec) { @@ -3051,7 +3048,7 @@ class DataObject extends ModelData implements DataObjectInterface, i18nEntityPro } } - return parent::castingHelper($field, $useFallback); + return parent::castingHelper($field); } /** @@ -3234,11 +3231,11 @@ class DataObject extends ModelData implements DataObjectInterface, i18nEntityPro * - it still returns an object even when the field has no value. * - it only matches fields and not methods * - it matches foreign keys generated by has_one relationships, eg, "ParentID" + * - if the field exists, the return value is ALWAYS a DBField instance * - * @param string $fieldName Name of the field - * @return DBField The field as a DBField object + * Returns null if the field doesn't exist */ - public function dbObject($fieldName) + public function dbObject(string $fieldName): ?DBField { // Check for field in DB $schema = static::getSchema(); @@ -3306,7 +3303,7 @@ class DataObject extends ModelData implements DataObjectInterface, i18nEntityPro } elseif ($component instanceof Relation || $component instanceof DataList) { // $relation could either be a field (aggregate), or another relation $singleton = DataObject::singleton($component->dataClass()); - $component = $singleton->dbObject($relation) ?: $component->relation($relation); + $component = $singleton->dbObject($relation) ?? $component->relation($relation); } elseif ($component instanceof DataObject && ($dbObject = $component->dbObject($relation))) { $component = $dbObject; } elseif ($component instanceof ModelData && $component->hasField($relation)) { @@ -4399,7 +4396,7 @@ class DataObject extends ModelData implements DataObjectInterface, i18nEntityPro // has_one fields should not use dbObject to check if a value is given $hasOne = static::getSchema()->hasOneComponent(static::class, $field); if (!$hasOne && ($obj = $this->dbObject($field))) { - return $obj->exists(); + return $obj && $obj->exists(); } else { return parent::hasValue($field, $arguments, $cache); } diff --git a/src/ORM/EagerLoadedList.php b/src/ORM/EagerLoadedList.php index d65a49d37..ad53ad42e 100644 --- a/src/ORM/EagerLoadedList.php +++ b/src/ORM/EagerLoadedList.php @@ -171,7 +171,7 @@ class EagerLoadedList extends ModelData implements Relation, SS_List, Filterable return $this->dataClass; } - public function dbObject($fieldName): ?DBField + public function dbObject(string $fieldName): ?DBField { return singleton($this->dataClass)->dbObject($fieldName); } diff --git a/src/ORM/FieldType/DBComposite.php b/src/ORM/FieldType/DBComposite.php index 7060417ea..6c9ea2a05 100644 --- a/src/ORM/FieldType/DBComposite.php +++ b/src/ORM/FieldType/DBComposite.php @@ -73,7 +73,7 @@ abstract class DBComposite extends DBField foreach ($this->compositeDatabaseFields() as $field => $spec) { // Write sub-manipulation $fieldObject = $this->dbObject($field); - $fieldObject->writeToManipulation($manipulation); + $fieldObject?->writeToManipulation($manipulation); } } @@ -137,7 +137,7 @@ abstract class DBComposite extends DBField // By default all fields foreach ($this->compositeDatabaseFields() as $field => $spec) { $fieldObject = $this->dbObject($field); - if (!$fieldObject->exists()) { + if (!$fieldObject?->exists()) { return false; } } diff --git a/src/ORM/FieldType/DBField.php b/src/ORM/FieldType/DBField.php index 38efb5758..8d7254aa3 100644 --- a/src/ORM/FieldType/DBField.php +++ b/src/ORM/FieldType/DBField.php @@ -520,11 +520,6 @@ abstract class DBField extends ModelData implements DBIndexable DBG; } - public function __toString(): string - { - return (string)$this->forTemplate(); - } - public function getArrayValue() { return $this->arrayValue; diff --git a/src/ORM/FieldType/DBVarchar.php b/src/ORM/FieldType/DBVarchar.php index 3081ad34b..86608a197 100644 --- a/src/ORM/FieldType/DBVarchar.php +++ b/src/ORM/FieldType/DBVarchar.php @@ -47,7 +47,7 @@ class DBVarchar extends DBString * can be useful if you want to have text fields with a length limit that * is dictated by the DB field. * - * TextField::create('Title')->setMaxLength(singleton('SiteTree')->dbObject('Title')->getSize()) + * TextField::create('Title')->setMaxLength(singleton('SiteTree')->dbObject('Title')?->getSize()) * * @return int The size of the field */ diff --git a/src/ORM/Filters/SearchFilter.php b/src/ORM/Filters/SearchFilter.php index f622252fb..bc70ec5d4 100644 --- a/src/ORM/Filters/SearchFilter.php +++ b/src/ORM/Filters/SearchFilter.php @@ -339,7 +339,7 @@ abstract class SearchFilter /** @var DBField $dbField */ $dbField = singleton($this->model)->dbObject($this->name); - $dbField->setValue($this->value); + $dbField?->setValue($this->value); return $dbField->RAW(); } diff --git a/src/ORM/Relation.php b/src/ORM/Relation.php index 62b2b266c..93c63e961 100644 --- a/src/ORM/Relation.php +++ b/src/ORM/Relation.php @@ -45,9 +45,6 @@ interface Relation extends SS_List, Filterable, Sortable, Limitable /** * Return the DBField object that represents the given field on the related class. - * - * @param string $fieldName Name of the field - * @return DBField The field as a DBField object */ - public function dbObject($fieldName); + public function dbObject(string $fieldName): ?DBField; } diff --git a/src/ORM/UnsavedRelationList.php b/src/ORM/UnsavedRelationList.php index e01ff241e..ab2780288 100644 --- a/src/ORM/UnsavedRelationList.php +++ b/src/ORM/UnsavedRelationList.php @@ -307,11 +307,8 @@ class UnsavedRelationList extends ArrayList implements Relation /** * Return the DBField object that represents the given field on the related class. - * - * @param string $fieldName Name of the field - * @return DBField The field as a DBField object */ - public function dbObject($fieldName) + public function dbObject(string $fieldName): ?DBField { return DataObject::singleton($this->dataClass)->dbObject($fieldName); } diff --git a/src/PolyExecution/PolyOutput.php b/src/PolyExecution/PolyOutput.php index a10d4646e..35b52af39 100644 --- a/src/PolyExecution/PolyOutput.php +++ b/src/PolyExecution/PolyOutput.php @@ -226,9 +226,6 @@ class PolyOutput extends Output { $listInfo = $this->listTypeStack[array_key_last($this->listTypeStack)]; $listType = $listInfo['type']; - if ($listType === PolyOutput::LIST_ORDERED) { - echo ''; - } if ($options === null) { $options = $listInfo['options']; } diff --git a/src/Security/Member.php b/src/Security/Member.php index e5d198650..a4a7b3467 100644 --- a/src/Security/Member.php +++ b/src/Security/Member.php @@ -343,7 +343,7 @@ class Member extends DataObject { /** @var DBDatetime $lockedOutUntilObj */ $lockedOutUntilObj = $this->dbObject('LockedOutUntil'); - if ($lockedOutUntilObj->InFuture()) { + if ($lockedOutUntilObj?->InFuture()) { return true; } @@ -370,7 +370,7 @@ class Member extends DataObject /** @var DBDatetime $firstFailureDate */ $firstFailureDate = $attempts->first()->dbObject('Created'); $maxAgeSeconds = $this->config()->get('lock_out_delay_mins') * 60; - $lockedOutUntil = $firstFailureDate->getTimestamp() + $maxAgeSeconds; + $lockedOutUntil = $firstFailureDate?->getTimestamp() + $maxAgeSeconds; $now = DBDatetime::now()->getTimestamp(); if ($now < $lockedOutUntil) { return true; @@ -426,7 +426,7 @@ class Member extends DataObject $currentValue = $this->PasswordExpiry; $currentDate = $this->dbObject('PasswordExpiry'); - if ($dataValue && (!$currentValue || $currentDate->inFuture())) { + if ($dataValue && (!$currentValue || $currentDate?->inFuture())) { // Only alter future expiries - this way an admin could see how long ago a password expired still $this->PasswordExpiry = DBDatetime::now()->Rfc2822(); } elseif (!$dataValue && $this->isPasswordExpired()) { diff --git a/src/Security/PermissionCheckboxSetField.php b/src/Security/PermissionCheckboxSetField.php index bad09fa4f..7592dc681 100644 --- a/src/Security/PermissionCheckboxSetField.php +++ b/src/Security/PermissionCheckboxSetField.php @@ -117,7 +117,7 @@ class PermissionCheckboxSetField extends FormField $uninheritedCodes[$permission->Code][] = _t( 'SilverStripe\\Security\\PermissionCheckboxSetField.AssignedTo', 'assigned to "{title}"', - ['title' => $record->dbObject('Title')->forTemplate()] + ['title' => $record->dbObject('Title')?->forTemplate()] ); } @@ -135,7 +135,7 @@ class PermissionCheckboxSetField extends FormField 'SilverStripe\\Security\\PermissionCheckboxSetField.FromRole', 'inherited from role "{title}"', 'A permission inherited from a certain permission role', - ['title' => $role->dbObject('Title')->forTemplate()] + ['title' => $role->dbObject('Title')?->forTemplate()] ); } } @@ -159,8 +159,8 @@ class PermissionCheckboxSetField extends FormField 'inherited from role "{roletitle}" on group "{grouptitle}"', 'A permission inherited from a role on a certain group', [ - 'roletitle' => $role->dbObject('Title')->forTemplate(), - 'grouptitle' => $parent->dbObject('Title')->forTemplate() + 'roletitle' => $role->dbObject('Title')?->forTemplate(), + 'grouptitle' => $parent->dbObject('Title')?->forTemplate() ] ); } @@ -176,7 +176,7 @@ class PermissionCheckboxSetField extends FormField 'SilverStripe\\Security\\PermissionCheckboxSetField.FromGroup', 'inherited from group "{title}"', 'A permission inherited from a certain group', - ['title' => $parent->dbObject('Title')->forTemplate()] + ['title' => $parent->dbObject('Title')?->forTemplate()] ); } } diff --git a/src/View/CastingService.php b/src/View/CastingService.php new file mode 100644 index 000000000..0d6f7510b --- /dev/null +++ b/src/View/CastingService.php @@ -0,0 +1,100 @@ +castingHelper($fieldName); + } + + // Cast to object if there's an explicit casting for this field + // Explicit casts take precedence over array casting + if ($service) { + $castObject = Injector::inst()->create($service, $fieldName); + if (!ClassInfo::hasMethod($castObject, 'setValue')) { + throw new LogicException('Explicit casting service must have a setValue method.'); + } + $castObject->setValue($data, $source); + return $castObject; + } + + // Wrap arrays in ModelData so templates can handle them + if (is_array($data)) { + return array_is_list($data) ? ArrayList::create($data) : ArrayData::create($data); + } + + // Fall back to default casting + $service = $this->defaultService($data, $source, $fieldName); + $castObject = Injector::inst()->create($service, $fieldName); + if (!ClassInfo::hasMethod($castObject, 'setValue')) { + throw new LogicException('Default service must have a setValue method.'); + } + $castObject->setValue($data, $source); + return $castObject; + } + + /** + * Get the default service to use if no explicit service is declared for this field on the source model. + */ + private function defaultService(mixed $data, mixed $source = null, string $fieldName = ''): ?string + { + $default = null; + if ($source instanceof ModelData) { + $default = $source::config()->get('default_cast'); + if ($default === null) { + $failover = $source->getFailover(); + if ($failover) { + $default = $this->defaultService($data, $failover, $fieldName); + } + } + } + if ($default !== null) { + return $default; + } + + return match (gettype($data)) { + 'boolean' => DBBoolean::class, + 'string' => DBText::class, + 'double' => DBFloat::class, + 'integer' => DBInt::class, + default => DBText::class, + }; + } +} diff --git a/src/View/Dev/SSViewerTestState.php b/src/View/Dev/SSViewerTestState.php index 56f946e46..bb4b8e5f7 100644 --- a/src/View/Dev/SSViewerTestState.php +++ b/src/View/Dev/SSViewerTestState.php @@ -11,7 +11,7 @@ class SSViewerTestState implements TestState { public function setUp(SapphireTest $test) { - SSViewer::set_themes(null); + SSViewer::set_themes([]); SSViewer::setRewriteHashLinksDefault(null); ContentNegotiator::setEnabled(null); } diff --git a/src/View/Exception/MissingTemplateException.php b/src/View/Exception/MissingTemplateException.php new file mode 100644 index 000000000..7864290d7 --- /dev/null +++ b/src/View/Exception/MissingTemplateException.php @@ -0,0 +1,11 @@ +` template commands. + * + * Caching + * + * Compiled templates are cached, usually on the filesystem. + * If you put ?flush=1 on your URL, it will force the template to be recompiled. + * + */ +class SSTemplateEngine implements TemplateEngine, Flushable +{ + use Injectable; + + /** + * List of models being processed + */ + protected static array $topLevel = []; + + /** + * @internal + */ + private static bool $template_cache_flushed = false; + + /** + * @internal + */ + private static bool $cacheblock_cache_flushed = false; + + /** + */ + private ?CacheInterface $partialCacheStore = null; + + /** + */ + private ?TemplateParser $parser = null; + + /** + * A template or pool of candidate templates to choose from. + */ + private string|array $templateCandidates = []; + + /** + * Absolute path to chosen template file which will be used in the call to render() + */ + private ?string $chosen = null; + + /** + * Templates to use when looking up 'Layout' or 'Content' + */ + private array $subTemplates = []; + + public function __construct(string|array $templateCandidates = []) + { + if (!empty($templateCandidates)) { + $this->setTemplate($templateCandidates); + } + } + + /** + * Execute the given template, passing it the given data. + * Used by the <% include %> template tag to process included templates. + * + * @param array $overlay Associative array of fields (e.g. args into an include template) to inject into the + * template as properties. These override properties and methods with the same name from $data and from global + * template providers. + */ + public static function execute_template(array|string $template, ViewLayerData $data, array $overlay = [], ?SSViewer_Scope $scope = null): string + { + $engine = static::create($template); + return $engine->render($data, $overlay, $scope); + } + + /** + * Get the current model being processed + */ + public static function topLevel(): ?ViewLayerData + { + if (SSTemplateEngine::$topLevel) { + return SSTemplateEngine::$topLevel[sizeof(SSTemplateEngine::$topLevel)-1]; + } + return null; + } + + /** + * Triggered early in the request when someone requests a flush. + */ + public static function flush() + { + SSTemplateEngine::flush_template_cache(true); + SSTemplateEngine::flush_cacheblock_cache(true); + } + + public function hasTemplate(array|string $templateCandidates): bool + { + return (bool) ThemeResourceLoader::inst()->findTemplate($templateCandidates, SSViewer::get_themes()); + } + + public function renderString(string $template, ViewLayerData $model, array $overlay = [], bool $cache = true): string + { + $hash = sha1($template); + $cacheFile = TEMP_PATH . DIRECTORY_SEPARATOR . ".cache.$hash"; + + // Generate a file whether we're caching or not. + // This is an inefficiency that's required due to the way rendered templates get processed. + if (!file_exists($cacheFile ?? '') || isset($_GET['flush'])) { + $content = $this->parseTemplateContent($template, "string sha1=$hash"); + $fh = fopen($cacheFile ?? '', 'w'); + fwrite($fh, $content ?? ''); + fclose($fh); + } + + $output = $this->includeGeneratedTemplate($cacheFile, $model, $overlay, []); + + if (!$cache) { + unlink($cacheFile ?? ''); + } + + return $output; + } + + public function render(ViewLayerData $model, array $overlay = [], ?SSViewer_Scope $scope = null): string + { + SSTemplateEngine::$topLevel[] = $model; + $template = $this->chosen; + + // If there's no template, throw an exception + if (!$template) { + if (empty($this->templateCandidates)) { + throw new MissingTemplateException( + 'No template to render. ' + . 'Try calling setTemplate() or passing template candidates into the constructor.' + ); + } + $message = 'None of the following templates could be found: '; + $message .= print_r($this->templateCandidates, true); + $themes = SSViewer::get_themes(); + if (!$themes) { + $message .= ' (no theme in use)'; + } else { + $message .= ' in themes "' . print_r($themes, true) . '"'; + } + throw new MissingTemplateException($message); + } + + $cacheFile = TEMP_PATH . DIRECTORY_SEPARATOR . '.cache' + . str_replace(['\\','/',':'], '.', Director::makeRelative(realpath($template ?? '')) ?? ''); + $lastEdited = filemtime($template ?? ''); + + if (!file_exists($cacheFile ?? '') || filemtime($cacheFile ?? '') < $lastEdited) { + $content = file_get_contents($template ?? ''); + $content = $this->parseTemplateContent($content, $template); + + $fh = fopen($cacheFile ?? '', 'w'); + fwrite($fh, $content ?? ''); + fclose($fh); + } + + $underlay = ['I18NNamespace' => basename($template ?? '')]; + + // Makes the rendered sub-templates available on the parent model, + // through $Content and $Layout placeholders. + foreach (['Content', 'Layout'] as $subtemplate) { + // Detect sub-template to use + $sub = $this->getSubtemplateFor($subtemplate); + if (!$sub) { + continue; + } + + // Create lazy-evaluated underlay for this subtemplate + $underlay[$subtemplate] = function () use ($model, $overlay, $sub) { + $subtemplateViewer = clone $this; + // Select the right template and render if the template exists + $subtemplateViewer->setTemplate($sub); + // If there's no template for that underlay, just don't render anything. + // This mirrors how SSViewer_Scope handles null values. + if (!$subtemplateViewer->chosen) { + return null; + } + // Render and wrap in DBHTMLText so it doesn't get escaped + return DBHTMLText::create()->setValue($subtemplateViewer->render($model, $overlay)); + }; + } + + $output = $this->includeGeneratedTemplate($cacheFile, $model, $overlay, $underlay, $scope); + + array_pop(SSTemplateEngine::$topLevel); + + return $output; + } + + /** + */ + public function setTemplate(string|array $templates): static + { + $this->templateCandidates = $templates; + $this->chosen = $this->chooseTemplate($templates); + $this->subTemplates = []; + return $this; + } + + /** + * Find the template to use for a given list + * + * @param array|string $templates + * @return string + */ + public function chooseTemplate($templates) + { + return ThemeResourceLoader::inst()->findTemplate($templates, SSViewer::get_themes()); + } + + /** + * Returns the filenames of the template that will be rendered. It is a map that may contain + * 'Content' & 'Layout', and will have to contain 'main' + * + * @return array + */ + public function templates() + { + return array_merge(['main' => $this->chosen], $this->subTemplates); + } + + /** + * @param string $type "Layout" or "main" + * @param string $file Full system path to the template file + */ + public function setTemplateFile($type, $file) + { + if (!$type || $type == 'main') { + $this->chosen = $file; + } else { + $this->subTemplates[$type] = $file; + } + } + + /** + * Set the template parser that will be used in template generation + */ + public function setParser(TemplateParser $parser): static + { + $this->parser = $parser; + return $this; + } + + /** + * Returns the parser that is set for template generation + */ + public function getParser(): TemplateParser + { + if (!$this->parser) { + $this->setParser(Injector::inst()->get(SSTemplateParser::class)); + } + return $this->parser; + } + + /** + * Parse given template contents + * + * @param string $content The template contents + * @param string $template The template file name + * @return string + */ + public function parseTemplateContent($content, $template = "") + { + return $this->getParser()->compileString( + $content, + $template, + Director::isDev() && SSViewer::config()->uninherited('source_file_comments') + ); + } + + /** + * An internal utility function to set up variables in preparation for including a compiled + * template, then do the include + * + * @param string $cacheFile The path to the file that contains the template compiled to PHP + * @param ViewLayerData $model The model to use as the root scope for the template + * @param array $overlay Any variables to layer on top of the scope + * @param array $underlay Any variables to layer underneath the scope + * @param SSViewer_Scope $inheritedScope The current scope of a parent template including a sub-template + * @return string The result of executing the template + */ + protected function includeGeneratedTemplate($cacheFile, $model, $overlay, $underlay, $inheritedScope = null) + { + if (isset($_GET['showtemplate']) && $_GET['showtemplate'] && Permission::check('ADMIN')) { + $lines = file($cacheFile ?? ''); + echo "

Template: $cacheFile

"; + echo "
";
+            foreach ($lines as $num => $line) {
+                echo str_pad($num+1, 5) . htmlentities($line, ENT_COMPAT, 'UTF-8');
+            }
+            echo "
"; + } + + $cache = $this->getPartialCacheStore(); + $scope = new SSViewer_Scope($model, $overlay, $underlay, $inheritedScope); + $val = ''; + + // Placeholder for values exposed to $cacheFile + [$cache, $scope, $val]; + include($cacheFile); + + return $val; + } + + /** + * Get the appropriate template to use for the named sub-template, or null if none are appropriate + * + * @param string $subtemplate Sub-template to use + * + * @return array|null + */ + protected function getSubtemplateFor($subtemplate) + { + // Get explicit subtemplate name + if (isset($this->subTemplates[$subtemplate])) { + return $this->subTemplates[$subtemplate]; + } + + // Don't apply sub-templates if type is already specified (e.g. 'Includes') + if (isset($this->templateCandidates['type'])) { + return null; + } + + // Filter out any other typed templates as we can only add, not change type + $templates = array_filter( + (array) $this->templateCandidates, + function ($template) { + return !isset($template['type']); + } + ); + if (empty($templates)) { + return null; + } + + // Set type to subtemplate + $templates['type'] = $subtemplate; + return $templates; + } + + /** + * Clears all parsed template files in the cache folder. + * + * Can only be called once per request (there may be multiple SSViewer instances). + * + * @param bool $force Set this to true to force a re-flush. If left to false, flushing + * may only be performed once a request. + */ + public static function flush_template_cache($force = false) + { + if (!SSTemplateEngine::$template_cache_flushed || $force) { + $dir = dir(TEMP_PATH); + while (false !== ($file = $dir->read())) { + if (strstr($file ?? '', '.cache')) { + unlink(TEMP_PATH . DIRECTORY_SEPARATOR . $file); + } + } + SSTemplateEngine::$template_cache_flushed = true; + } + } + + /** + * Clears all partial cache blocks. + * + * Can only be called once per request (there may be multiple SSViewer instances). + * + * @param bool $force Set this to true to force a re-flush. If left to false, flushing + * may only be performed once a request. + */ + public static function flush_cacheblock_cache($force = false) + { + if (!SSTemplateEngine::$cacheblock_cache_flushed || $force) { + $cache = Injector::inst()->get(CacheInterface::class . '.cacheblock'); + $cache->clear(); + + + SSTemplateEngine::$cacheblock_cache_flushed = true; + } + } + + /** + * Set the cache object to use when storing / retrieving partial cache blocks. + * + * @param CacheInterface $cache + */ + public function setPartialCacheStore($cache) + { + $this->partialCacheStore = $cache; + } + + /** + * Get the cache object to use when storing / retrieving partial cache blocks. + * + * @return CacheInterface + */ + public function getPartialCacheStore() + { + if ($this->partialCacheStore) { + return $this->partialCacheStore; + } + + return Injector::inst()->get(CacheInterface::class . '.cacheblock'); + } +} diff --git a/src/View/SSTemplateParser.peg b/src/View/SSTemplateParser.peg index b893ef4ae..84ae8b2eb 100644 --- a/src/View/SSTemplateParser.peg +++ b/src/View/SSTemplateParser.peg @@ -247,7 +247,7 @@ class SSTemplateParser extends Parser implements TemplateParser } $res['php'] .= ($sub['ArgumentMode'] == 'default') ? $sub['string_php'] : - str_replace('$$FINAL', 'XML_val', $sub['php'] ?? ''); + str_replace('$$FINAL', 'getValueAsArgument', $sub['php'] ?? ''); } /*!* @@ -274,8 +274,8 @@ class SSTemplateParser extends Parser implements TemplateParser } /** - * The basic generated PHP of LookupStep and LastLookupStep is the same, except that LookupStep calls 'obj' to - * get the next ModelData in the sequence, and LastLookupStep calls different methods (XML_val, hasValue, obj) + * The basic generated PHP of LookupStep and LastLookupStep is the same, except that LookupStep calls 'scopeToIntermediateValue' to + * get the next ModelData in the sequence, and LastLookupStep calls different methods (getOutputValue, hasValue, scopeToIntermediateValue) * depending on the context the lookup is used in. */ function Lookup_AddLookupStep(&$res, $sub, $method) @@ -286,15 +286,17 @@ class SSTemplateParser extends Parser implements TemplateParser if (isset($sub['Call']['CallArguments']) && isset($sub['Call']['CallArguments']['php'])) { $arguments = $sub['Call']['CallArguments']['php']; - $res['php'] .= "->$method('$property', [$arguments], true)"; + $type = ViewLayerData::TYPE_METHOD; + $res['php'] .= "->$method('$property', [$arguments], '$type')"; } else { - $res['php'] .= "->$method('$property', [], true)"; + $type = ViewLayerData::TYPE_PROPERTY; + $res['php'] .= "->$method('$property', [], '$type')"; } } function Lookup_LookupStep(&$res, $sub) { - $this->Lookup_AddLookupStep($res, $sub, 'obj'); + $this->Lookup_AddLookupStep($res, $sub, 'scopeToIntermediateValue'); } function Lookup_LastLookupStep(&$res, $sub) @@ -357,7 +359,7 @@ class SSTemplateParser extends Parser implements TemplateParser function InjectionVariables_Argument(&$res, $sub) { - $res['php'] .= str_replace('$$FINAL', 'XML_val', $sub['php'] ?? '') . ','; + $res['php'] .= str_replace('$$FINAL', 'getOutputValue', $sub['php'] ?? '') . ','; } function InjectionVariables__finalise(&$res) @@ -392,7 +394,7 @@ class SSTemplateParser extends Parser implements TemplateParser */ function Injection_STR(&$res, $sub) { - $res['php'] = '$val .= '. str_replace('$$FINAL', 'XML_val', $sub['Lookup']['php'] ?? '') . ';'; + $res['php'] = '$val .= '. str_replace('$$FINAL', 'getOutputValue', $sub['Lookup']['php'] ?? '') . ';'; } /*!* @@ -535,10 +537,10 @@ class SSTemplateParser extends Parser implements TemplateParser if (!empty($res['php'])) { $res['php'] .= $sub['string_php']; } else { - $res['php'] = str_replace('$$FINAL', 'XML_val', $sub['lookup_php'] ?? ''); + $res['php'] = str_replace('$$FINAL', 'getOutputValue', $sub['lookup_php'] ?? ''); } } else { - $res['php'] .= str_replace('$$FINAL', 'XML_val', $sub['php'] ?? ''); + $res['php'] .= str_replace('$$FINAL', 'getOutputValue', $sub['php'] ?? ''); } } @@ -567,7 +569,7 @@ class SSTemplateParser extends Parser implements TemplateParser } else { $php = ($sub['ArgumentMode'] == 'default' ? $sub['lookup_php'] : $sub['php']); // TODO: kinda hacky - maybe we need a way to pass state down the parse chain so - // Lookup_LastLookupStep and Argument_BareWord can produce hasValue instead of XML_val + // Lookup_LastLookupStep and Argument_BareWord can produce hasValue instead of getOutputValue $res['php'] .= str_replace('$$FINAL', 'hasValue', $php ?? ''); } } @@ -697,7 +699,7 @@ class SSTemplateParser extends Parser implements TemplateParser $res['php'] = ''; } - $res['php'] .= str_replace('$$FINAL', 'XML_val', $sub['php'] ?? ''); + $res['php'] .= str_replace('$$FINAL', 'getOutputValue', $sub['php'] ?? ''); } /*!* @@ -827,7 +829,7 @@ class SSTemplateParser extends Parser implements TemplateParser { $entity = $sub['String']['text']; if (strpos($entity ?? '', '.') === false) { - $res['php'] .= "\$scope->XML_val('I18NNamespace').'.$entity'"; + $res['php'] .= "\$scope->getOutputValue('I18NNamespace').'.$entity'"; } else { $res['php'] .= "'$entity'"; } @@ -915,7 +917,7 @@ class SSTemplateParser extends Parser implements TemplateParser break; default: - $res['php'] .= str_replace('$$FINAL', 'obj', $sub['php'] ?? '') . '->self()'; + $res['php'] .= str_replace('$$FINAL', 'scopeToIntermediateValue', $sub['php'] ?? '') . '->self()'; break; } } @@ -947,8 +949,8 @@ class SSTemplateParser extends Parser implements TemplateParser $template = $res['template']; $arguments = $res['arguments']; - // Note: 'type' here is important to disable subTemplates in SSViewer::getSubtemplateFor() - $res['php'] = '$val .= \\SilverStripe\\View\\SSViewer::execute_template([["type" => "Includes", '.$template.'], '.$template.'], $scope->getItem(), [' . + // Note: 'type' here is important to disable subTemplates in SSTemplateEngine::getSubtemplateFor() + $res['php'] = '$val .= \\SilverStripe\\View\\SSTemplateEngine::execute_template([["type" => "Includes", '.$template.'], '.$template.'], $scope->getCurrentItem(), [' . implode(',', $arguments)."], \$scope, true);\n"; if ($this->includeDebuggingComments) { // Add include filename comments on dev sites @@ -1037,7 +1039,8 @@ class SSTemplateParser extends Parser implements TemplateParser //loop without arguments loops on the current scope if ($res['ArgumentCount'] == 0) { - $on = '$scope->locally()->obj(\'Me\', [], true)'; + $type = ViewLayerData::TYPE_METHOD; + $on = "\$scope->locally()->scopeToIntermediateValue('Me', [], '$type')"; // @TODO use self instead or move $Me to scope explicitly } else { //loop in the normal way $arg = $res['Arguments'][0]; if ($arg['ArgumentMode'] == 'string') { @@ -1045,13 +1048,13 @@ class SSTemplateParser extends Parser implements TemplateParser } $on = str_replace( '$$FINAL', - 'obj', + 'scopeToIntermediateValue', ($arg['ArgumentMode'] == 'default') ? $arg['lookup_php'] : $arg['php'] ); } return - $on . '; $scope->pushScope(); while (($key = $scope->next()) !== false) {' . PHP_EOL . + $on . '; $scope->pushScope(); while ($scope->next() !== false) {' . PHP_EOL . $res['Template']['php'] . PHP_EOL . '}; $scope->popScope(); '; } @@ -1071,7 +1074,7 @@ class SSTemplateParser extends Parser implements TemplateParser throw new SSTemplateParseException('Control block cant take string as argument.', $this); } - $on = str_replace('$$FINAL', 'obj', ($arg['ArgumentMode'] == 'default') ? $arg['lookup_php'] : $arg['php']); + $on = str_replace('$$FINAL', 'scopeToIntermediateValue', ($arg['ArgumentMode'] == 'default') ? $arg['lookup_php'] : $arg['php']); return $on . '; $scope->pushScope();' . PHP_EOL . $res['Template']['php'] . PHP_EOL . @@ -1118,6 +1121,7 @@ class SSTemplateParser extends Parser implements TemplateParser /** * This is an open block handler, for the <% debug %> utility tag + * @TODO find out if this even works in CMS 5, and if so make sure it keeps working */ function OpenBlock_Handle_Debug(&$res) { @@ -1145,7 +1149,9 @@ class SSTemplateParser extends Parser implements TemplateParser if ($res['ArgumentCount'] != 0) { throw new SSTemplateParseException('Base_tag takes no arguments', $this); } - return '$val .= \\SilverStripe\\View\\SSViewer::get_base_tag($val);'; + $code = '$isXhtml = preg_match(\'/]+xhtml/i\', $val);'; + $code .= PHP_EOL . '$val .= \\SilverStripe\\View\\SSViewer::getBaseTag($isXhtml);'; + return $code; } /** diff --git a/src/View/SSTemplateParser.php b/src/View/SSTemplateParser.php index 4e4842489..3ccc7ecbd 100644 --- a/src/View/SSTemplateParser.php +++ b/src/View/SSTemplateParser.php @@ -572,7 +572,7 @@ class SSTemplateParser extends Parser implements TemplateParser } $res['php'] .= ($sub['ArgumentMode'] == 'default') ? $sub['string_php'] : - str_replace('$$FINAL', 'XML_val', $sub['php'] ?? ''); + str_replace('$$FINAL', 'getValueAsArgument', $sub['php'] ?? ''); } /* Call: Method:Word ( "(" < :CallArguments? > ")" )? */ @@ -765,8 +765,8 @@ class SSTemplateParser extends Parser implements TemplateParser } /** - * The basic generated PHP of LookupStep and LastLookupStep is the same, except that LookupStep calls 'obj' to - * get the next ModelData in the sequence, and LastLookupStep calls different methods (XML_val, hasValue, obj) + * The basic generated PHP of LookupStep and LastLookupStep is the same, except that LookupStep calls 'scopeToIntermediateValue' to + * get the next ModelData in the sequence, and LastLookupStep calls different methods (getOutputValue, hasValue, scopeToIntermediateValue) * depending on the context the lookup is used in. */ function Lookup_AddLookupStep(&$res, $sub, $method) @@ -777,15 +777,17 @@ class SSTemplateParser extends Parser implements TemplateParser if (isset($sub['Call']['CallArguments']) && isset($sub['Call']['CallArguments']['php'])) { $arguments = $sub['Call']['CallArguments']['php']; - $res['php'] .= "->$method('$property', [$arguments], true)"; + $type = ViewLayerData::TYPE_METHOD; + $res['php'] .= "->$method('$property', [$arguments], '$type')"; } else { - $res['php'] .= "->$method('$property', [], true)"; + $type = ViewLayerData::TYPE_PROPERTY; + $res['php'] .= "->$method('$property', [], '$type')"; } } function Lookup_LookupStep(&$res, $sub) { - $this->Lookup_AddLookupStep($res, $sub, 'obj'); + $this->Lookup_AddLookupStep($res, $sub, 'scopeToIntermediateValue'); } function Lookup_LastLookupStep(&$res, $sub) @@ -1009,7 +1011,7 @@ class SSTemplateParser extends Parser implements TemplateParser function InjectionVariables_Argument(&$res, $sub) { - $res['php'] .= str_replace('$$FINAL', 'XML_val', $sub['php'] ?? '') . ','; + $res['php'] .= str_replace('$$FINAL', 'getOutputValue', $sub['php'] ?? '') . ','; } function InjectionVariables__finalise(&$res) @@ -1158,7 +1160,7 @@ class SSTemplateParser extends Parser implements TemplateParser function Injection_STR(&$res, $sub) { - $res['php'] = '$val .= '. str_replace('$$FINAL', 'XML_val', $sub['Lookup']['php'] ?? '') . ';'; + $res['php'] = '$val .= '. str_replace('$$FINAL', 'getOutputValue', $sub['Lookup']['php'] ?? '') . ';'; } /* DollarMarkedLookup: SimpleInjection */ @@ -1818,10 +1820,10 @@ class SSTemplateParser extends Parser implements TemplateParser if (!empty($res['php'])) { $res['php'] .= $sub['string_php']; } else { - $res['php'] = str_replace('$$FINAL', 'XML_val', $sub['lookup_php'] ?? ''); + $res['php'] = str_replace('$$FINAL', 'getOutputValue', $sub['lookup_php'] ?? ''); } } else { - $res['php'] .= str_replace('$$FINAL', 'XML_val', $sub['php'] ?? ''); + $res['php'] .= str_replace('$$FINAL', 'getOutputValue', $sub['php'] ?? ''); } } @@ -1887,7 +1889,7 @@ class SSTemplateParser extends Parser implements TemplateParser } else { $php = ($sub['ArgumentMode'] == 'default' ? $sub['lookup_php'] : $sub['php']); // TODO: kinda hacky - maybe we need a way to pass state down the parse chain so - // Lookup_LastLookupStep and Argument_BareWord can produce hasValue instead of XML_val + // Lookup_LastLookupStep and Argument_BareWord can produce hasValue instead of getOutputValue $res['php'] .= str_replace('$$FINAL', 'hasValue', $php ?? ''); } } @@ -2470,7 +2472,7 @@ class SSTemplateParser extends Parser implements TemplateParser $res['php'] = ''; } - $res['php'] .= str_replace('$$FINAL', 'XML_val', $sub['php'] ?? ''); + $res['php'] .= str_replace('$$FINAL', 'getOutputValue', $sub['php'] ?? ''); } /* CacheBlockTemplate: (Comment | Translate | If | Require | OldI18NTag | Include | ClosedBlock | @@ -3587,7 +3589,7 @@ class SSTemplateParser extends Parser implements TemplateParser { $entity = $sub['String']['text']; if (strpos($entity ?? '', '.') === false) { - $res['php'] .= "\$scope->XML_val('I18NNamespace').'.$entity'"; + $res['php'] .= "\$scope->getOutputValue('I18NNamespace').'.$entity'"; } else { $res['php'] .= "'$entity'"; } @@ -3792,7 +3794,7 @@ class SSTemplateParser extends Parser implements TemplateParser break; default: - $res['php'] .= str_replace('$$FINAL', 'obj', $sub['php'] ?? '') . '->self()'; + $res['php'] .= str_replace('$$FINAL', 'scopeToIntermediateValue', $sub['php'] ?? '') . '->self()'; break; } } @@ -3896,8 +3898,8 @@ class SSTemplateParser extends Parser implements TemplateParser $template = $res['template']; $arguments = $res['arguments']; - // Note: 'type' here is important to disable subTemplates in SSViewer::getSubtemplateFor() - $res['php'] = '$val .= \\SilverStripe\\View\\SSViewer::execute_template([["type" => "Includes", '.$template.'], '.$template.'], $scope->getItem(), [' . + // Note: 'type' here is important to disable subTemplates in SSTemplateEngine::getSubtemplateFor() + $res['php'] = '$val .= \\SilverStripe\\View\\SSTemplateEngine::execute_template([["type" => "Includes", '.$template.'], '.$template.'], $scope->getCurrentItem(), [' . implode(',', $arguments)."], \$scope, true);\n"; if ($this->includeDebuggingComments) { // Add include filename comments on dev sites @@ -4265,7 +4267,8 @@ class SSTemplateParser extends Parser implements TemplateParser //loop without arguments loops on the current scope if ($res['ArgumentCount'] == 0) { - $on = '$scope->locally()->obj(\'Me\', [], true)'; + $type = ViewLayerData::TYPE_METHOD; + $on = "\$scope->locally()->scopeToIntermediateValue('Me', [], '$type')"; // @TODO use self instead or move $Me to scope explicitly } else { //loop in the normal way $arg = $res['Arguments'][0]; if ($arg['ArgumentMode'] == 'string') { @@ -4273,13 +4276,13 @@ class SSTemplateParser extends Parser implements TemplateParser } $on = str_replace( '$$FINAL', - 'obj', + 'scopeToIntermediateValue', ($arg['ArgumentMode'] == 'default') ? $arg['lookup_php'] : $arg['php'] ); } return - $on . '; $scope->pushScope(); while (($key = $scope->next()) !== false) {' . PHP_EOL . + $on . '; $scope->pushScope(); while ($scope->next() !== false) {' . PHP_EOL . $res['Template']['php'] . PHP_EOL . '}; $scope->popScope(); '; } @@ -4299,7 +4302,7 @@ class SSTemplateParser extends Parser implements TemplateParser throw new SSTemplateParseException('Control block cant take string as argument.', $this); } - $on = str_replace('$$FINAL', 'obj', ($arg['ArgumentMode'] == 'default') ? $arg['lookup_php'] : $arg['php']); + $on = str_replace('$$FINAL', 'scopeToIntermediateValue', ($arg['ArgumentMode'] == 'default') ? $arg['lookup_php'] : $arg['php']); return $on . '; $scope->pushScope();' . PHP_EOL . $res['Template']['php'] . PHP_EOL . @@ -4403,6 +4406,7 @@ class SSTemplateParser extends Parser implements TemplateParser /** * This is an open block handler, for the <% debug %> utility tag + * @TODO find out if this even works in CMS 5, and if so make sure it keeps working */ function OpenBlock_Handle_Debug(&$res) { @@ -4430,7 +4434,9 @@ class SSTemplateParser extends Parser implements TemplateParser if ($res['ArgumentCount'] != 0) { throw new SSTemplateParseException('Base_tag takes no arguments', $this); } - return '$val .= \\SilverStripe\\View\\SSViewer::get_base_tag($val);'; + $code = '$isXhtml = preg_match(\'/]+xhtml/i\', $val);'; + $code .= PHP_EOL . '$val .= \\SilverStripe\\View\\SSViewer::getBaseTag($isXhtml);'; + return $code; } /** diff --git a/src/View/SSViewer.php b/src/View/SSViewer.php index 63f0edc34..cac4d75f8 100644 --- a/src/View/SSViewer.php +++ b/src/View/SSViewer.php @@ -5,41 +5,20 @@ namespace SilverStripe\View; use SilverStripe\Core\Config\Config; use SilverStripe\Core\Config\Configurable; use SilverStripe\Core\ClassInfo; -use Psr\SimpleCache\CacheInterface; use SilverStripe\Core\Convert; -use SilverStripe\Core\Flushable; -use SilverStripe\Core\Injector\Injector; use SilverStripe\Core\Injector\Injectable; use SilverStripe\Control\Director; use SilverStripe\ORM\FieldType\DBField; use SilverStripe\ORM\FieldType\DBHTMLText; -use SilverStripe\Security\Permission; use InvalidArgumentException; -use SilverStripe\Model\ModelData; +use SilverStripe\Core\Injector\Injector; /** - * Parses a template file with an *.ss file extension. + * Class that manages themes and interacts with TemplateEngine classes to render templates. * - * In addition to a full template in the templates/ folder, a template in - * templates/Content or templates/Layout will be rendered into $Content and - * $Layout, respectively. - * - * A single template can be parsed by multiple nested {@link SSViewer} instances - * through $Layout/$Content placeholders, as well as <% include MyTemplateFile %> template commands. - * - * Themes - * - * See http://doc.silverstripe.org/themes and http://doc.silverstripe.org/themes:developing - * - * Caching - * - * Compiled templates are cached via {@link Cache}, usually on the filesystem. - * If you put ?flush=1 on your URL, it will force the template to be recompiled. - * - * @see http://doc.silverstripe.org/themes - * @see http://doc.silverstripe.org/themes:developing + * Ensures rendered templates are normalised, e.g have appropriate resources from the Requirements API. */ -class SSViewer implements Flushable +class SSViewer { use Configurable; use Injectable; @@ -57,18 +36,8 @@ class SSViewer implements Flushable /** * A list (highest priority first) of themes to use * Only used when {@link $theme_enabled} is set to TRUE. - * - * @config - * @var string */ - private static $themes = []; - - /** - * Overridden value of $themes config - * - * @var array - */ - protected static $current_themes = null; + private static array $themes = []; /** * Use the theme. Set to FALSE in order to disable themes, @@ -76,33 +45,29 @@ class SSViewer implements Flushable * such as an administrative interface separate from the website theme. * It retains the theme settings to be re-enabled, for example when a website content * needs to be rendered from within this administrative interface. - * - * @config - * @var bool */ - private static $theme_enabled = true; + private static bool $theme_enabled = true; /** * Default prepended cache key for partial caching - * - * @config - * @var string */ - private static $global_key = '$CurrentReadingMode, $CurrentUser.ID'; + private static string $global_key = '$CurrentReadingMode, $CurrentUser.ID'; /** - * @config - * @var bool + * If true, rendered templates will include comments indicating which template file was used. + * May not be supported for some rendering engines. */ - private static $source_file_comments = false; + private static bool $source_file_comments = false; /** * Set if hash links should be rewritten - * - * @config - * @var bool */ - private static $rewrite_hash_links = true; + private static bool $rewrite_hash_links = true; + + /** + * Overridden value of $themes config + */ + protected static array $current_themes = []; /** * Overridden value of rewrite_hash_links config @@ -120,59 +85,10 @@ class SSViewer implements Flushable protected $rewriteHashlinks = null; /** - * @internal - * @ignore */ - private static $template_cache_flushed = false; + protected bool $includeRequirements = true; - /** - * @internal - * @ignore - */ - private static $cacheblock_cache_flushed = false; - - /** - * List of items being processed - * - * @var array - */ - protected static $topLevel = []; - - /** - * List of templates to select from - * - * @var array - */ - protected $templates = null; - - /** - * Absolute path to chosen template file - * - * @var string - */ - protected $chosen = null; - - /** - * Templates to use when looking up 'Layout' or 'Content' - * - * @var array - */ - protected $subTemplates = []; - - /** - * @var bool - */ - protected $includeRequirements = true; - - /** - * @var TemplateParser - */ - protected $parser; - - /** - * @var CacheInterface - */ - protected $partialCacheStore = null; + private TemplateEngine $templateEngine; /** * @param string|array $templates If passed as a string with .ss extension, used as the "main" template. @@ -181,86 +97,41 @@ class SSViewer implements Flushable * * array('MySpecificPage', 'MyPage', 'Page') * - * @param TemplateParser $parser */ - public function __construct($templates, TemplateParser $parser = null) + public function __construct(string|array $templates, ?TemplateEngine $templateEngine = null) { - if ($parser) { - $this->setParser($parser); + if ($templateEngine) { + $templateEngine->setTemplate($templates); + } else { + $templateEngine = Injector::inst()->create(TemplateEngine::class, $templates); } - - $this->setTemplate($templates); - - if (!$this->chosen) { - $message = 'None of the following templates could be found: '; - $message .= print_r($templates, true); - - $themes = SSViewer::get_themes(); - if (!$themes) { - $message .= ' (no theme in use)'; - } else { - $message .= ' in themes "' . print_r($themes, true) . '"'; - } - - user_error($message ?? '', E_USER_WARNING); - } - } - - /** - * Triggered early in the request when someone requests a flush. - */ - public static function flush() - { - SSViewer::flush_template_cache(true); - SSViewer::flush_cacheblock_cache(true); - } - - /** - * Create a template from a string instead of a .ss file - * - * @param string $content The template content - * @param bool|void $cacheTemplate Whether or not to cache the template from string - * @return SSViewer - */ - public static function fromString($content, $cacheTemplate = null) - { - $viewer = SSViewer_FromString::create($content); - if ($cacheTemplate !== null) { - $viewer->setCacheTemplate($cacheTemplate); - } - return $viewer; + $this->setTemplateEngine($templateEngine); } /** * Assign the list of active themes to apply. * If default themes should be included add $default as the last entry. - * - * @param array $themes */ - public static function set_themes($themes = []) + public static function set_themes(array $themes): void { static::$current_themes = $themes; } /** * Add to the list of active themes to apply - * - * @param array $themes */ - public static function add_themes($themes = []) + public static function add_themes(array $themes) { $currentThemes = SSViewer::get_themes(); $finalThemes = array_merge($themes, $currentThemes); // array_values is used to ensure sequential array keys as array_unique can leave gaps - static::set_themes(array_values(array_unique($finalThemes ?? []))); + static::set_themes(array_values(array_unique($finalThemes))); } /** * Get the list of active themes - * - * @return array */ - public static function get_themes() + public static function get_themes(): array { $default = [SSViewer::PUBLIC_THEME, SSViewer::DEFAULT_THEME]; @@ -270,7 +141,7 @@ class SSViewer implements Flushable // Explicit list is assigned $themes = static::$current_themes; - if (!isset($themes)) { + if (empty($themes)) { $themes = SSViewer::config()->uninherited('themes'); } if ($themes) { @@ -283,7 +154,7 @@ class SSViewer implements Flushable /** * Traverses the given the given class context looking for candidate template names * which match each item in the class hierarchy. The resulting list of template candidates - * may or may not exist, but you can invoke {@see SSViewer::chooseTemplate} on any list + * may or may not exist, but you can call hasTemplate() on a TemplateEngine * to determine the best candidate based on the current themes. * * @param string|object $classOrObject Valid class name, or object @@ -323,16 +194,58 @@ class SSViewer implements Flushable } /** - * Get the current item being processed + * Get an associative array of names to information about callable template provider methods. * - * @return ModelData + * @var boolean $createObject If true, methods will be called on instantiated objects rather than statically on the class. */ - public static function topLevel() + public static function getMethodsFromProvider(string $providerInterface, $methodName, bool $createObject = false): array { - if (SSViewer::$topLevel) { - return SSViewer::$topLevel[sizeof(SSViewer::$topLevel)-1]; + $implementors = ClassInfo::implementorsOf($providerInterface); + if ($implementors) { + foreach ($implementors as $implementor) { + // Create a new instance of the object for method calls + if ($createObject) { + $implementor = new $implementor(); + $exposedVariables = $implementor->$methodName(); + } else { + $exposedVariables = $implementor::$methodName(); + } + + foreach ($exposedVariables as $varName => $details) { + if (!is_array($details)) { + $details = ['method' => $details]; + } + + // If just a value (and not a key => value pair), use method name for both key and value + if (is_numeric($varName)) { + $varName = $details['method']; + } + + // Add in a reference to the implementing class (might be a string class name or an instance) + $details['implementor'] = $implementor; + + // And a callable array + if (isset($details['method'])) { + $details['callable'] = [$implementor, $details['method']]; + } + + // Save with both uppercase & lowercase first letter, so either works + $lcFirst = strtolower($varName[0] ?? '') . substr($varName ?? '', 1); + $result[$lcFirst] = $details; + $result[ucfirst($varName)] = $details; + } + } } - return null; + + return $result; + } + + /** + * Get the template engine used to render templates for this viewer + */ + public function getTemplateEngine(): TemplateEngine + { + return $this->templateEngine; } /** @@ -384,81 +297,15 @@ class SSViewer implements Flushable static::$current_rewrite_hash_links = $rewrite; } - /** - * @param string|array $templates - */ - public function setTemplate($templates) - { - $this->templates = $templates; - $this->chosen = $this->chooseTemplate($templates); - $this->subTemplates = []; - } - - /** - * Find the template to use for a given list - * - * @param array|string $templates - * @return string - */ - public static function chooseTemplate($templates) - { - return ThemeResourceLoader::inst()->findTemplate($templates, SSViewer::get_themes()); - } - - /** - * Set the template parser that will be used in template generation - * - * @param TemplateParser $parser - */ - public function setParser(TemplateParser $parser) - { - $this->parser = $parser; - } - - /** - * Returns the parser that is set for template generation - * - * @return TemplateParser - */ - public function getParser() - { - if (!$this->parser) { - $this->setParser(Injector::inst()->get('SilverStripe\\View\\SSTemplateParser')); - } - return $this->parser; - } - - /** - * Returns true if at least one of the listed templates exists. - * - * @param array|string $templates - * - * @return bool - */ - public static function hasTemplate($templates) - { - return (bool)ThemeResourceLoader::inst()->findTemplate($templates, SSViewer::get_themes()); - } - /** * Call this to disable rewriting of links. This is useful in Ajax applications. * It returns the SSViewer objects, so that you can call new SSViewer("X")->dontRewriteHashlinks()->process(); - * - * @return $this */ - public function dontRewriteHashlinks() + public function dontRewriteHashlinks(): static { return $this->setRewriteHashLinks(false); } - /** - * @return string - */ - public function exists() - { - return $this->chosen; - } - /** * @param string $identifier A template name without '.ss' extension or path * @param string $type The template type, either "main", "Includes" or "Layout" @@ -469,116 +316,14 @@ class SSViewer implements Flushable return ThemeResourceLoader::inst()->findTemplate(['type' => $type, $identifier], SSViewer::get_themes()); } - /** - * Clears all parsed template files in the cache folder. - * - * Can only be called once per request (there may be multiple SSViewer instances). - * - * @param bool $force Set this to true to force a re-flush. If left to false, flushing - * may only be performed once a request. - */ - public static function flush_template_cache($force = false) - { - if (!SSViewer::$template_cache_flushed || $force) { - $dir = dir(TEMP_PATH); - while (false !== ($file = $dir->read())) { - if (strstr($file ?? '', '.cache')) { - unlink(TEMP_PATH . DIRECTORY_SEPARATOR . $file); - } - } - SSViewer::$template_cache_flushed = true; - } - } - - /** - * Clears all partial cache blocks. - * - * Can only be called once per request (there may be multiple SSViewer instances). - * - * @param bool $force Set this to true to force a re-flush. If left to false, flushing - * may only be performed once a request. - */ - public static function flush_cacheblock_cache($force = false) - { - if (!SSViewer::$cacheblock_cache_flushed || $force) { - $cache = Injector::inst()->get(CacheInterface::class . '.cacheblock'); - $cache->clear(); - - - SSViewer::$cacheblock_cache_flushed = true; - } - } - - /** - * Set the cache object to use when storing / retrieving partial cache blocks. - * - * @param CacheInterface $cache - */ - public function setPartialCacheStore($cache) - { - $this->partialCacheStore = $cache; - } - - /** - * Get the cache object to use when storing / retrieving partial cache blocks. - * - * @return CacheInterface - */ - public function getPartialCacheStore() - { - if ($this->partialCacheStore) { - return $this->partialCacheStore; - } - - return Injector::inst()->get(CacheInterface::class . '.cacheblock'); - } - /** * Flag whether to include the requirements in this response. - * - * @param bool $incl */ - public function includeRequirements($incl = true) + public function includeRequirements(bool $incl = true) { $this->includeRequirements = $incl; } - /** - * An internal utility function to set up variables in preparation for including a compiled - * template, then do the include - * - * Effectively this is the common code that both SSViewer#process and SSViewer_FromString#process call - * - * @param string $cacheFile The path to the file that contains the template compiled to PHP - * @param ModelData $item The item to use as the root scope for the template - * @param array $overlay Any variables to layer on top of the scope - * @param array $underlay Any variables to layer underneath the scope - * @param ModelData $inheritedScope The current scope of a parent template including a sub-template - * @return string The result of executing the template - */ - protected function includeGeneratedTemplate($cacheFile, $item, $overlay, $underlay, $inheritedScope = null) - { - if (isset($_GET['showtemplate']) && $_GET['showtemplate'] && Permission::check('ADMIN')) { - $lines = file($cacheFile ?? ''); - echo "

Template: $cacheFile

"; - echo "
";
-            foreach ($lines as $num => $line) {
-                echo str_pad($num+1, 5) . htmlentities($line, ENT_COMPAT, 'UTF-8');
-            }
-            echo "
"; - } - - $cache = $this->getPartialCacheStore(); - $scope = new SSViewer_DataPresenter($item, $overlay, $underlay, $inheritedScope); - $val = ''; - - // Placeholder for values exposed to $cacheFile - [$cache, $scope, $val]; - include($cacheFile); - - return $val; - } - /** * The process() method handles the "meat" of the template processing. * @@ -590,70 +335,24 @@ class SSViewer implements Flushable * * Note: You can call this method indirectly by {@link ModelData->renderWith()}. * - * @param ModelData $item - * @param array|null $arguments Arguments to an included template - * @param ModelData $inheritedScope The current scope of a parent template including a sub-template - * @return DBHTMLText Parsed template output. + * @param array $overlay Associative array of fields for use in the template. + * These will override properties and methods with the same name from $data and from global + * template providers. */ - public function process($item, $arguments = null, $inheritedScope = null) + public function process(mixed $item, array $overlay = []): DBHTMLText { + $item = ViewLayerData::create($item); // Set hashlinks and temporarily modify global state $rewrite = $this->getRewriteHashLinks(); $origRewriteDefault = static::getRewriteHashLinksDefault(); static::setRewriteHashLinksDefault($rewrite); - SSViewer::$topLevel[] = $item; - - $template = $this->chosen; - - $cacheFile = TEMP_PATH . DIRECTORY_SEPARATOR . '.cache' - . str_replace(['\\','/',':'], '.', Director::makeRelative(realpath($template ?? '')) ?? ''); - $lastEdited = filemtime($template ?? ''); - - if (!file_exists($cacheFile ?? '') || filemtime($cacheFile ?? '') < $lastEdited) { - $content = file_get_contents($template ?? ''); - $content = $this->parseTemplateContent($content, $template); - - $fh = fopen($cacheFile ?? '', 'w'); - fwrite($fh, $content ?? ''); - fclose($fh); - } - - $underlay = ['I18NNamespace' => basename($template ?? '')]; - - // Makes the rendered sub-templates available on the parent item, - // through $Content and $Layout placeholders. - foreach (['Content', 'Layout'] as $subtemplate) { - // Detect sub-template to use - $sub = $this->getSubtemplateFor($subtemplate); - if (!$sub) { - continue; - } - - // Create lazy-evaluated underlay for this subtemplate - $underlay[$subtemplate] = function () use ($item, $arguments, $sub) { - $subtemplateViewer = clone $this; - // Disable requirements - this will be handled by the parent template - $subtemplateViewer->includeRequirements(false); - // Select the right template - $subtemplateViewer->setTemplate($sub); - - // Render if available - if ($subtemplateViewer->exists()) { - return $subtemplateViewer->process($item, $arguments); - } - return null; - }; - } - - $output = $this->includeGeneratedTemplate($cacheFile, $item, $arguments, $underlay, $inheritedScope); + $output = $this->getTemplateEngine()->render($item, $overlay);// this is where we tell the engine to render the template if ($this->includeRequirements) { $output = Requirements::includeInHTML($output); } - array_pop(SSViewer::$topLevel); - // If we have our crazy base tag, then fix # links referencing the current page. if ($rewrite) { if (strpos($output ?? '', 'subTemplates[$subtemplate])) { - return $this->subTemplates[$subtemplate]; - } - - // Don't apply sub-templates if type is already specified (e.g. 'Includes') - if (isset($this->templates['type'])) { - return null; - } - - // Filter out any other typed templates as we can only add, not change type - $templates = array_filter( - (array)$this->templates, - function ($template) { - return !isset($template['type']); - } - ); - if (empty($templates)) { - return null; - } - - // Set type to subtemplate - $templates['type'] = $subtemplate; - return $templates; - } - - /** - * Execute the given template, passing it the given data. - * Used by the <% include %> template tag to process templates. - * - * @param string $template Template name - * @param mixed $data Data context - * @param array $arguments Additional arguments - * @param Object $scope - * @param bool $globalRequirements - * - * @return string Evaluated result - */ - public static function execute_template($template, $data, $arguments = null, $scope = null, $globalRequirements = false) - { - $v = SSViewer::create($template); - - if ($globalRequirements) { - $v->includeRequirements(false); - } else { - //nest a requirements backend for our template rendering - $origBackend = Requirements::backend(); - Requirements::set_backend(Requirements_Backend::create()); - } - try { - return $v->process($data, $arguments, $scope); - } finally { - if (!$globalRequirements) { - Requirements::set_backend($origBackend); - } - } - } - /** * Execute the evaluated string, passing it the given data. * Used by partial caching to evaluate custom cache keys expressed using @@ -756,9 +388,10 @@ PHP; * * @return string Evaluated result */ - public static function execute_string($content, $data, $arguments = null, $globalRequirements = false) + public static function execute_string($content, $data, $arguments = [], $globalRequirements = false) { - $v = SSViewer::fromString($content); + // @TODO come back to this. Probably delete it but keeping for now due to $globalRequirements + $v = SSViewer_FromString::create($content); if ($globalRequirements) { $v->includeRequirements(false); @@ -776,64 +409,31 @@ PHP; } } - /** - * Parse given template contents - * - * @param string $content The template contents - * @param string $template The template file name - * @return string - */ - public function parseTemplateContent($content, $template = "") - { - return $this->getParser()->compileString( - $content, - $template, - Director::isDev() && SSViewer::config()->uninherited('source_file_comments') - ); - } - - /** - * Returns the filenames of the template that will be rendered. It is a map that may contain - * 'Content' & 'Layout', and will have to contain 'main' - * - * @return array - */ - public function templates() - { - return array_merge(['main' => $this->chosen], $this->subTemplates); - } - - /** - * @param string $type "Layout" or "main" - * @param string $file Full system path to the template file - */ - public function setTemplateFile($type, $file) - { - if (!$type || $type == 'main') { - $this->chosen = $file; - } else { - $this->subTemplates[$type] = $file; - } - } - /** * Return an appropriate base tag for the given template. * It will be closed on an XHTML document, and unclosed on an HTML document. * - * @param string $contentGeneratedSoFar The content of the template generated so far; it should contain - * the DOCTYPE declaration. - * @return string + * @param bool $isXhtml Whether the DOCTYPE is xhtml or not. */ - public static function get_base_tag($contentGeneratedSoFar) + public static function getBaseTag(bool $isXhtml = false): string { // Base href should always have a trailing slash $base = rtrim(Director::absoluteBaseURL(), '/') . '/'; - // Is the document XHTML? - if (preg_match('/]+xhtml/i', $contentGeneratedSoFar ?? '')) { + if ($isXhtml) { return ""; } else { - return ""; + return ""; } } + + /** + * Get the engine used to render templates for this viewer. + * Note that this is intentionally protected to avoid the engine being set after instantiation. + */ + protected function setTemplateEngine(TemplateEngine $engine): static + { + $this->templateEngine = $engine; + return $this; + } } diff --git a/src/View/SSViewer_DataPresenter.php b/src/View/SSViewer_DataPresenter.php deleted file mode 100644 index 0729584a2..000000000 --- a/src/View/SSViewer_DataPresenter.php +++ /dev/null @@ -1,449 +0,0 @@ -overlay = $overlay ?: []; - $this->underlay = $underlay ?: []; - - $this->cacheGlobalProperties(); - $this->cacheIteratorProperties(); - } - - /** - * Build cache of global properties - */ - protected function cacheGlobalProperties() - { - if (SSViewer_DataPresenter::$globalProperties !== null) { - return; - } - - SSViewer_DataPresenter::$globalProperties = $this->getPropertiesFromProvider( - TemplateGlobalProvider::class, - 'get_template_global_variables' - ); - } - - /** - * Build cache of global iterator properties - */ - protected function cacheIteratorProperties() - { - if (SSViewer_DataPresenter::$iteratorProperties !== null) { - return; - } - - SSViewer_DataPresenter::$iteratorProperties = $this->getPropertiesFromProvider( - TemplateIteratorProvider::class, - 'get_template_iterator_variables', - true // Call non-statically - ); - } - - /** - * @var string $interfaceToQuery - * @var string $variableMethod - * @var boolean $createObject - * @return array - */ - protected function getPropertiesFromProvider($interfaceToQuery, $variableMethod, $createObject = false) - { - $methods = []; - - $implementors = ClassInfo::implementorsOf($interfaceToQuery); - if ($implementors) { - foreach ($implementors as $implementor) { - // Create a new instance of the object for method calls - if ($createObject) { - $implementor = new $implementor(); - $exposedVariables = $implementor->$variableMethod(); - } else { - $exposedVariables = $implementor::$variableMethod(); - } - - foreach ($exposedVariables as $varName => $details) { - if (!is_array($details)) { - $details = [ - 'method' => $details, - 'casting' => ModelData::config()->uninherited('default_cast') - ]; - } - - // If just a value (and not a key => value pair), use method name for both key and value - if (is_numeric($varName)) { - $varName = $details['method']; - } - - // Add in a reference to the implementing class (might be a string class name or an instance) - $details['implementor'] = $implementor; - - // And a callable array - if (isset($details['method'])) { - $details['callable'] = [$implementor, $details['method']]; - } - - // Save with both uppercase & lowercase first letter, so either works - $lcFirst = strtolower($varName[0] ?? '') . substr($varName ?? '', 1); - $result[$lcFirst] = $details; - $result[ucfirst($varName)] = $details; - } - } - } - - return $result; - } - - /** - * Look up injected value - it may be part of an "overlay" (arguments passed to <% include %>), - * set on the current item, part of an "underlay" ($Layout or $Content), or an iterator/global property - * - * @param string $property Name of property - * @param array $params - * @param bool $cast If true, an object is always returned even if not an object. - * @return array|null - */ - public function getInjectedValue($property, array $params, $cast = true) - { - // Get source for this value - $result = $this->getValueSource($property); - if (!array_key_exists('source', $result)) { - return null; - } - - // Look up the value - either from a callable, or from a directly provided value - $source = $result['source']; - $res = []; - if (isset($source['callable'])) { - $res['value'] = $source['callable'](...$params); - } elseif (array_key_exists('value', $source)) { - $res['value'] = $source['value']; - } else { - throw new InvalidArgumentException( - "Injected property $property doesn't have a value or callable value source provided" - ); - } - - // If we want to provide a casted object, look up what type object to use - if ($cast) { - $res['obj'] = $this->castValue($res['value'], $source); - } - - return $res; - } - - /** - * Store the current overlay (as it doesn't directly apply to the new scope - * that's being pushed). We want to store the overlay against the next item - * "up" in the stack (hence upIndex), rather than the current item, because - * SSViewer_Scope::obj() has already been called and pushed the new item to - * the stack by this point - * - * @return SSViewer_Scope - */ - public function pushScope() - { - $scope = parent::pushScope(); - $upIndex = $this->getUpIndex() ?: 0; - - $itemStack = $this->getItemStack(); - $itemStack[$upIndex][SSViewer_Scope::ITEM_OVERLAY] = $this->overlay; - $this->setItemStack($itemStack); - - // Remove the overlay when we're changing to a new scope, as values in - // that scope take priority. The exceptions that set this flag are $Up - // and $Top as they require that the new scope inherits the overlay - if (!$this->preserveOverlay) { - $this->overlay = []; - } - - return $scope; - } - - /** - * Now that we're going to jump up an item in the item stack, we need to - * restore the overlay that was previously stored against the next item "up" - * in the stack from the current one - * - * @return SSViewer_Scope - */ - public function popScope() - { - $upIndex = $this->getUpIndex(); - - if ($upIndex !== null) { - $itemStack = $this->getItemStack(); - $this->overlay = $itemStack[$upIndex][SSViewer_Scope::ITEM_OVERLAY]; - } - - return parent::popScope(); - } - - /** - * $Up and $Top need to restore the overlay from the parent and top-level - * scope respectively. - * - * @param string $name - * @param array $arguments - * @param bool $cache - * @param string $cacheName - * @return $this - */ - public function obj($name, $arguments = [], $cache = false, $cacheName = null) - { - $overlayIndex = false; - - switch ($name) { - case 'Up': - $upIndex = $this->getUpIndex(); - if ($upIndex === null) { - throw new \LogicException('Up called when we\'re already at the top of the scope'); - } - $overlayIndex = $upIndex; // Parent scope - $this->preserveOverlay = true; // Preserve overlay - break; - case 'Top': - $overlayIndex = 0; // Top-level scope - $this->preserveOverlay = true; // Preserve overlay - break; - default: - $this->preserveOverlay = false; - break; - } - - if ($overlayIndex !== false) { - $itemStack = $this->getItemStack(); - if (!$this->overlay && isset($itemStack[$overlayIndex][SSViewer_Scope::ITEM_OVERLAY])) { - $this->overlay = $itemStack[$overlayIndex][SSViewer_Scope::ITEM_OVERLAY]; - } - } - - parent::obj($name, $arguments, $cache, $cacheName); - return $this; - } - - /** - * {@inheritdoc} - */ - public function getObj($name, $arguments = [], $cache = false, $cacheName = null) - { - $result = $this->getInjectedValue($name, (array)$arguments); - if ($result) { - return $result['obj']; - } - return parent::getObj($name, $arguments, $cache, $cacheName); - } - - /** - * {@inheritdoc} - */ - public function __call($name, $arguments) - { - // Extract the method name and parameters - $property = $arguments[0]; // The name of the public function being called - - // The public function parameters in an array - $params = (isset($arguments[1])) ? (array)$arguments[1] : []; - - $val = $this->getInjectedValue($property, $params); - if ($val) { - $obj = $val['obj']; - if ($name === 'hasValue') { - $result = ($obj instanceof ModelData) ? $obj->exists() : (bool)$obj; - } elseif (is_null($obj) || (is_scalar($obj) && !is_string($obj))) { - $result = $obj; // Nulls and non-string scalars don't need casting - } else { - $result = $obj->forTemplate(); // XML_val - } - - $this->resetLocalScope(); - return $result; - } - - return parent::__call($name, $arguments); - } - - /** - * Evaluate a template override. Returns an array where the presence of - * a 'value' key indiciates whether an override was successfully found, - * as null is a valid override value - * - * @param string $property Name of override requested - * @param array $overrides List of overrides available - * @return array An array with a 'value' key if a value has been found, or empty if not - */ - protected function processTemplateOverride($property, $overrides) - { - if (!array_key_exists($property, $overrides)) { - return []; - } - - // Detect override type - $override = $overrides[$property]; - - // Late-evaluate this value - if (!is_string($override) && is_callable($override)) { - $override = $override(); - - // Late override may yet return null - if (!isset($override)) { - return []; - } - } - - return ['value' => $override]; - } - - /** - * Determine source to use for getInjectedValue. Returns an array where the presence of - * a 'source' key indiciates whether a value source was successfully found, as a source - * may be a null value returned from an override - * - * @param string $property - * @return array An array with a 'source' key if a value source has been found, or empty if not - */ - protected function getValueSource($property) - { - // Check for a presenter-specific override - $result = $this->processTemplateOverride($property, $this->overlay); - if (array_key_exists('value', $result)) { - return ['source' => $result]; - } - - // Check if the method to-be-called exists on the target object - if so, don't check any further - // injection locations - $on = $this->getItem(); - if (is_object($on) && (isset($on->$property) || method_exists($on, $property ?? ''))) { - return []; - } - - // Check for a presenter-specific override - $result = $this->processTemplateOverride($property, $this->underlay); - if (array_key_exists('value', $result)) { - return ['source' => $result]; - } - - // Then for iterator-specific overrides - if (array_key_exists($property, SSViewer_DataPresenter::$iteratorProperties)) { - $source = SSViewer_DataPresenter::$iteratorProperties[$property]; - /** @var TemplateIteratorProvider $implementor */ - $implementor = $source['implementor']; - if ($this->itemIterator) { - // Set the current iterator position and total (the object instance is the first item in - // the callable array) - $implementor->iteratorProperties( - $this->itemIterator->key(), - $this->itemIteratorTotal - ); - } else { - // If we don't actually have an iterator at the moment, act like a list of length 1 - $implementor->iteratorProperties(0, 1); - } - - return ($source) ? ['source' => $source] : []; - } - - // And finally for global overrides - if (array_key_exists($property, SSViewer_DataPresenter::$globalProperties)) { - return [ - 'source' => SSViewer_DataPresenter::$globalProperties[$property] // get the method call - ]; - } - - // No value - return []; - } - - /** - * Ensure the value is cast safely - * - * @param mixed $value - * @param array $source - * @return DBField - */ - protected function castValue($value, $source) - { - // If the value has already been cast, is null, or is a non-string scalar - if (is_object($value) || is_null($value) || (is_scalar($value) && !is_string($value))) { - return $value; - } - - // Wrap list arrays in ModelData so templates can handle them - if (is_array($value) && array_is_list($value)) { - return ArrayList::create($value); - } - - // Get provided or default cast - $casting = empty($source['casting']) - ? ModelData::config()->uninherited('default_cast') - : $source['casting']; - - return DBField::create_field($casting, $value); - } -} diff --git a/src/View/SSViewer_FromString.php b/src/View/SSViewer_FromString.php index c7712a9f2..aba6b9920 100644 --- a/src/View/SSViewer_FromString.php +++ b/src/View/SSViewer_FromString.php @@ -3,21 +3,15 @@ namespace SilverStripe\View; use SilverStripe\Core\Config\Config; +use SilverStripe\Core\Injector\Injector; use SilverStripe\ORM\FieldType\DBField; +use SilverStripe\ORM\FieldType\DBHTMLText; /** * Special SSViewer that will process a template passed as a string, rather than a filename. */ class SSViewer_FromString extends SSViewer { - /** - * The global template caching behaviour if no instance override is specified - * - * @config - * @var bool - */ - private static $cache_template = true; - /** * The template to use * @@ -25,71 +19,27 @@ class SSViewer_FromString extends SSViewer */ protected $content; - /** - * Indicates whether templates should be cached - * - * @var bool - */ - protected $cacheTemplate; - /** * @param string $content * @param TemplateParser $parser */ - public function __construct($content, TemplateParser $parser = null) + public function __construct(string $content, ?TemplateEngine $templateEngine = null) { - if ($parser) { - $this->setParser($parser); - } - $this->content = $content; + if (!$templateEngine) { + $templateEngine = Injector::inst()->create(TemplateEngine::class); + } + $this->setTemplateEngine($templateEngine); } /** * {@inheritdoc} */ - public function process($item, $arguments = null, $scope = null) + public function process(mixed $item, array $overlay = [], bool $cache = true): DBHTMLText { - $hash = sha1($this->content ?? ''); - $cacheFile = TEMP_PATH . DIRECTORY_SEPARATOR . ".cache.$hash"; - - if (!file_exists($cacheFile ?? '') || isset($_GET['flush'])) { - $content = $this->parseTemplateContent($this->content, "string sha1=$hash"); - $fh = fopen($cacheFile ?? '', 'w'); - fwrite($fh, $content ?? ''); - fclose($fh); - } - - $val = $this->includeGeneratedTemplate($cacheFile, $item, $arguments, null, $scope); - - if ($this->cacheTemplate !== null) { - $cacheTemplate = $this->cacheTemplate; - } else { - $cacheTemplate = static::config()->get('cache_template'); - } - - if (!$cacheTemplate) { - unlink($cacheFile ?? ''); - } - - $html = DBField::create_field('HTMLFragment', $val); - + $item = ViewLayerData::create($item); + $output = $this->getTemplateEngine()->renderString($this->content, $item, $overlay, $cache); + $html = DBField::create_field('HTMLFragment', $output); return $html; } - - /** - * @param boolean $cacheTemplate - */ - public function setCacheTemplate($cacheTemplate) - { - $this->cacheTemplate = (bool)$cacheTemplate; - } - - /** - * @return boolean - */ - public function getCacheTemplate() - { - return $this->cacheTemplate; - } } diff --git a/src/View/SSViewer_Scope.php b/src/View/SSViewer_Scope.php index 928b7b4a3..754f64e6f 100644 --- a/src/View/SSViewer_Scope.php +++ b/src/View/SSViewer_Scope.php @@ -4,12 +4,11 @@ namespace SilverStripe\View; use ArrayIterator; use Countable; +use InvalidArgumentException; use Iterator; -use SilverStripe\Model\List\ArrayList; -use SilverStripe\ORM\FieldType\DBBoolean; -use SilverStripe\ORM\FieldType\DBText; -use SilverStripe\ORM\FieldType\DBFloat; -use SilverStripe\ORM\FieldType\DBInt; +use LogicException; +use SilverStripe\Core\ClassInfo; +use SilverStripe\Core\Injector\Injector; use SilverStripe\ORM\FieldType\DBField; /** @@ -18,6 +17,10 @@ use SilverStripe\ORM\FieldType\DBField; * - Track Up and Top * - (As a side effect) Inject data that needs to be available globally (used to live in ModelData) * + * It is also responsible for mixing in data on top of what the item provides. This can be "global" + * data that is scope-independant (like BaseURL), or type-specific data that is layered on top cross-cut like + * (like $FirstLast etc). + * * In order to handle up, rather than tracking it using a tree, which would involve constructing new objects * for each step, we use indexes into the itemStack (which already has to exist). * @@ -107,37 +110,73 @@ class SSViewer_Scope */ private $localIndex = 0; + /** + * List of global property providers + * + * @internal + * @var TemplateGlobalProvider[]|null + */ + private static $globalProperties = null; + + /** + * List of global iterator providers + * + * @internal + * @var TemplateIteratorProvider[]|null + */ + private static $iteratorProperties = null; + + /** + * Overlay variables. Take precedence over anything from the current scope + * + * @var array|null + */ + protected $overlay; + + /** + * Flag for whether overlay should be preserved when pushing a new scope + * + * @see SSViewer_Scope::pushScope() + * @var bool + */ + protected $preserveOverlay = false; + + /** + * Underlay variables. Concede precedence to overlay variables or anything from the current scope + * + * @var array + */ + protected $underlay; + /** * @var object $item * @var SSViewer_Scope $inheritedScope */ - public function __construct($item, SSViewer_Scope $inheritedScope = null) - { + public function __construct( + $item, + array $overlay = null, + array $underlay = null, + SSViewer_Scope $inheritedScope = null + ) { $this->item = $item; $this->itemIterator = ($inheritedScope) ? $inheritedScope->itemIterator : null; $this->itemIteratorTotal = ($inheritedScope) ? $inheritedScope->itemIteratorTotal : 0; $this->itemStack[] = [$this->item, $this->itemIterator, $this->itemIteratorTotal, null, null, 0]; + + $this->overlay = $overlay ?: []; + $this->underlay = $underlay ?: []; + + $this->cacheGlobalProperties(); + $this->cacheIteratorProperties(); } /** - * Returns the current "active" item - * - * @return object + * Returns the current "current" item in scope */ - public function getItem() + public function getCurrentItem(): ?ViewLayerData { - $item = $this->itemIterator ? $this->itemIterator->current() : $this->item; - if (is_scalar($item)) { - $item = $this->convertScalarToDBField($item); - } - - // Wrap list arrays in ModelData so templates can handle them - if (is_array($item) && array_is_list($item)) { - $item = ArrayList::create($item); - } - - return $item; + return $this->itemIterator ? $this->itemIterator->current() : $this->item; } /** @@ -164,56 +203,21 @@ class SSViewer_Scope } /** - * Reset the local scope - restores saved state to the "global" item stack. Typically called after - * a lookup chain has been completed + * Set scope to an intermediate value, which will be used for getting output later on. */ - public function resetLocalScope() + public function scopeToIntermediateValue(string $name, array $arguments, string $type): static { - // Restore previous un-completed lookup chain if set - $previousLocalState = $this->localStack ? array_pop($this->localStack) : null; - array_splice($this->itemStack, $this->localIndex + 1, count($this->itemStack ?? []), $previousLocalState); + $overlayIndex = false; - list( - $this->item, - $this->itemIterator, - $this->itemIteratorTotal, - $this->popIndex, - $this->upIndex, - $this->currentIndex - ) = end($this->itemStack); - } - - /** - * @param string $name - * @param array $arguments - * @param bool $cache - * @param string $cacheName - * @return mixed - */ - public function getObj($name, $arguments = [], $cache = false, $cacheName = null) - { - $on = $this->getItem(); - if ($on === null) { - return null; - } - return $on->obj($name, $arguments, $cache, $cacheName); - } - - /** - * @param string $name - * @param array $arguments - * @param bool $cache - * @param string $cacheName - * @return $this - */ - public function obj($name, $arguments = [], $cache = false, $cacheName = null) - { + // $Up and $Top need to restore the overlay from the parent and top-level scope respectively. switch ($name) { case 'Up': - if ($this->upIndex === null) { + $upIndex = $this->getUpIndex(); + if ($upIndex === null) { throw new \LogicException('Up called when we\'re already at the top of the scope'); } - + $overlayIndex = $upIndex; // Parent scope + $this->preserveOverlay = true; // Preserve overlay list( $this->item, $this->itemIterator, @@ -224,6 +228,8 @@ class SSViewer_Scope ) = $this->itemStack[$this->upIndex]; break; case 'Top': + $overlayIndex = 0; // Top-level scope + $this->preserveOverlay = true; // Preserve overlay list( $this->item, $this->itemIterator, @@ -234,13 +240,21 @@ class SSViewer_Scope ) = $this->itemStack[0]; break; default: - $this->item = $this->getObj($name, $arguments, $cache, $cacheName); + $this->preserveOverlay = false; + $this->item = $this->getObj($name, $arguments, $type); $this->itemIterator = null; $this->upIndex = $this->currentIndex ? $this->currentIndex : count($this->itemStack) - 1; $this->currentIndex = count($this->itemStack); break; } + if ($overlayIndex !== false) { + $itemStack = $this->getItemStack(); + if (!$this->overlay && isset($itemStack[$overlayIndex][SSViewer_Scope::ITEM_OVERLAY])) { + $this->overlay = $itemStack[$overlayIndex][SSViewer_Scope::ITEM_OVERLAY]; + } + } + $this->itemStack[] = [ $this->item, $this->itemIterator, @@ -254,12 +268,11 @@ class SSViewer_Scope /** * Gets the current object and resets the scope. - * - * @return object + * @TODO: Replace with $Me */ - public function self() + public function self(): ?ViewLayerData { - $result = $this->getItem(); + $result = $this->getCurrentItem(); $this->resetLocalScope(); return $result; @@ -268,9 +281,13 @@ class SSViewer_Scope /** * Jump to the last item in the stack, called when a new item is added before a loop/with * - * @return SSViewer_Scope + * Store the current overlay (as it doesn't directly apply to the new scope + * that's being pushed). We want to store the overlay against the next item + * "up" in the stack (hence upIndex), rather than the current item, because + * SSViewer_Scope::obj() has already been called and pushed the new item to + * the stack by this point */ - public function pushScope() + public function pushScope(): static { $newLocalIndex = count($this->itemStack ?? []) - 1; @@ -284,16 +301,38 @@ class SSViewer_Scope // once we enter a new global scope, we need to make sure we use a new one $this->itemIterator = $this->itemStack[$newLocalIndex][SSViewer_Scope::ITEM_ITERATOR] = null; + $upIndex = $this->getUpIndex() ?: 0; + + $itemStack = $this->getItemStack(); + $itemStack[$upIndex][SSViewer_Scope::ITEM_OVERLAY] = $this->overlay; + $this->setItemStack($itemStack); + + // Remove the overlay when we're changing to a new scope, as values in + // that scope take priority. The exceptions that set this flag are $Up + // and $Top as they require that the new scope inherits the overlay + if (!$this->preserveOverlay) { + $this->overlay = []; + } + return $this; } /** * Jump back to "previous" item in the stack, called after a loop/with block * - * @return SSViewer_Scope + * Now that we're going to jump up an item in the item stack, we need to + * restore the overlay that was previously stored against the next item "up" + * in the stack from the current one */ - public function popScope() + public function popScope(): static { + $upIndex = $this->getUpIndex(); + + if ($upIndex !== null) { + $itemStack = $this->getItemStack(); + $this->overlay = $itemStack[$upIndex][SSViewer_Scope::ITEM_OVERLAY]; + } + $this->localIndex = $this->popIndex; $this->resetLocalScope(); @@ -301,11 +340,10 @@ class SSViewer_Scope } /** - * Fast-forwards the current iterator to the next item - * - * @return mixed + * Fast-forwards the current iterator to the next item. + * @return bool True if there's an item, false if not. */ - public function next() + public function next(): bool { if (!$this->item) { return false; @@ -349,23 +387,95 @@ class SSViewer_Scope return false; } - return $this->itemIterator->key(); + return true; } /** - * @param string $name - * @param array $arguments - * @return mixed + * Get the value that will be directly rendered in the template. */ - public function __call($name, $arguments) + public function getOutputValue(string $name, array $arguments, string $type): string { - $on = $this->getItem(); - $retval = $on ? $on->$name(...$arguments) : null; + $retval = $this->getObj($name, $arguments, $type); + $this->resetLocalScope(); + return $retval === null ? '' : $retval->__toString(); + } + + /** + * Get the value to pass as an argument to a method. + */ + public function getValueAsArgument(string $name, array $arguments, string $type): mixed + { + $retval = null; + + if ($this->hasOverlay($name)) { + $retval = $this->getOverlay($name, $arguments, true); + } else { + $on = $this->getCurrentItem(); + if ($on && isset($on->$name)) { + $retval = $on->getRawDataValue($name, $type, $arguments); + } + + if ($retval === null) { + $retval = $this->getUnderlay($name, $arguments, true); + } + } + + // if ($retval instanceof DBField) { + // $retval = $retval->getValue(); // Workaround because we're still calling obj in ViewLayerData + // } $this->resetLocalScope(); return $retval; } + /** + * Check if the current item in scope has a value for the named field. + */ + public function hasValue(string $name, array $arguments): bool + { + // @TODO: look for ways to remove the need to call hasValue (e.g. using isset($this->getCurrentItem()->$name) and an equivalent for over/underlays) + $retval = null; + $overlay = $this->getOverlay($name, $arguments); + if ($overlay && $overlay->hasDataValue()) { + $retval = true; + } + + if ($retval === null) { + $on = $this->getCurrentItem(); + if ($on) { + $retval = $on->hasDataValue($name, $arguments); + } + } + + if (!$retval) { + $underlay = $this->getUnderlay($name, $arguments); + $retval = $underlay && $underlay->hasDataValue(); + } + + $this->resetLocalScope(); + return $retval; + } + + /** + * Reset the local scope - restores saved state to the "global" item stack. Typically called after + * a lookup chain has been completed + */ + protected function resetLocalScope() + { + // Restore previous un-completed lookup chain if set + $previousLocalState = $this->localStack ? array_pop($this->localStack) : null; + array_splice($this->itemStack, $this->localIndex + 1, count($this->itemStack ?? []), $previousLocalState); + + list( + $this->item, + $this->itemIterator, + $this->itemIteratorTotal, + $this->popIndex, + $this->upIndex, + $this->currentIndex + ) = end($this->itemStack); + } + /** * @return array */ @@ -390,13 +500,174 @@ class SSViewer_Scope return $this->upIndex; } - private function convertScalarToDBField(bool|string|float|int $value): DBField + /** + * Evaluate a template override. Returns an array where the presence of + * a 'value' key indiciates whether an override was successfully found, + * as null is a valid override value + * + * @param string $property Name of override requested + * @param array $overrides List of overrides available + * @return array An array with a 'value' key if a value has been found, or empty if not + */ + protected function processTemplateOverride($property, $overrides) { - return match (gettype($value)) { - 'boolean' => DBBoolean::create()->setValue($value), - 'string' => DBText::create()->setValue($value), - 'double' => DBFloat::create()->setValue($value), - 'integer' => DBInt::create()->setValue($value), - }; + if (!array_key_exists($property, $overrides)) { + return []; + } + + // Detect override type + $override = $overrides[$property]; + + // Late-evaluate this value + if (!is_string($override) && is_callable($override)) { + $override = $override(); + + // Late override may yet return null + if (!isset($override)) { + return []; + } + } + + return ['value' => $override]; + } + + /** + * Build cache of global properties + */ + protected function cacheGlobalProperties() + { + if (SSViewer_Scope::$globalProperties !== null) { + return; + } + + SSViewer_Scope::$globalProperties = SSViewer::getMethodsFromProvider( + TemplateGlobalProvider::class, + 'get_template_global_variables' + ); + } + + /** + * Build cache of global iterator properties + */ + protected function cacheIteratorProperties() + { + if (SSViewer_Scope::$iteratorProperties !== null) { + return; + } + + SSViewer_Scope::$iteratorProperties = SSViewer::getMethodsFromProvider( + TemplateIteratorProvider::class, + 'get_template_iterator_variables', + true // Call non-statically + ); + } + + protected function getObj(string $name, array $arguments, string $type): ?ViewLayerData + { + if ($this->hasOverlay($name)) { + return $this->getOverlay($name, $arguments); + } + + $on = $this->getCurrentItem(); + if ($on && isset($on->$name)) { + if ($type === ViewLayerData::TYPE_METHOD) { + return $on->$name(...$arguments); + } + // property + return $on->$name; + } + + return $this->getUnderlay($name, $arguments); + } + + protected function hasOverlay(string $property): bool + { + $result = $this->processTemplateOverride($property, $this->overlay); + return array_key_exists('value', $result); + } + + protected function getOverlay(string $property, array $args, bool $getRaw = false): mixed + { + $result = $this->processTemplateOverride($property, $this->overlay); + if (array_key_exists('value', $result)) { + return $this->getInjectedValue($result, $property, $args, $getRaw); + } + return null; + } + + protected function getUnderlay(string $property, array $args, bool $getRaw = false): mixed + { + // Check for a presenter-specific override + $result = $this->processTemplateOverride($property, $this->underlay); + if (array_key_exists('value', $result)) { + return $this->getInjectedValue($result, $property, $args, $getRaw); + } + + // Then for iterator-specific overrides + if (array_key_exists($property, SSViewer_Scope::$iteratorProperties)) { + $source = SSViewer_Scope::$iteratorProperties[$property]; + /** @var TemplateIteratorProvider $implementor */ + $implementor = $source['implementor']; + if ($this->itemIterator) { + // Set the current iterator position and total (the object instance is the first item in + // the callable array) + $implementor->iteratorProperties( + $this->itemIterator->key(), + $this->itemIteratorTotal + ); + } else { + // If we don't actually have an iterator at the moment, act like a list of length 1 + $implementor->iteratorProperties(0, 1); + } + + return $this->getInjectedValue($source, $property, $args, $getRaw); + } + + // And finally for global overrides + if (array_key_exists($property, SSViewer_Scope::$globalProperties)) { + return $this->getInjectedValue( + SSViewer_Scope::$globalProperties[$property], + $property, + $args, + $getRaw + ); + } + + return null; + } + + protected function getInjectedValue( + array|TemplateGlobalProvider|TemplateIteratorProvider $source, + string $property, + array $params, + bool $getRaw = false + ) { + // Look up the value - either from a callable, or from a directly provided value + $value = null; + if (isset($source['callable'])) { + $value = $source['callable'](...$params); + } elseif (array_key_exists('value', $source)) { + $value = $source['value']; + } else { + throw new InvalidArgumentException( + "Injected property $property doesn't have a value or callable value source provided" + ); + } + + if ($value === null) { + return null; + } + + // TemplateGlobalProviders can provide an explicit service to cast to which works outside of the regular cast flow + if (!$getRaw && isset($source['casting'])) { + $castObject = Injector::inst()->create($source['casting'], $property); + if (!ClassInfo::hasMethod($castObject, 'setValue')) { + throw new LogicException('Explicit cast from template global provider must have a setValue method.'); + } + $castObject->setValue($value); + $value = $castObject; + } + + return $getRaw ? $value : ViewLayerData::create($value); } } diff --git a/src/View/TemplateEngine.php b/src/View/TemplateEngine.php new file mode 100644 index 000000000..785130a11 --- /dev/null +++ b/src/View/TemplateEngine.php @@ -0,0 +1,61 @@ +data; + } else { + $data = CastingService::singleton()->cast($data, $source, $name); + } + $this->data = $data; + } + + /** + * Needed so we can rewind in SSViewer_Scope::next() after getting itemIteratorTotal without throwing an exception. + * @TODO see if we can remove the need for this + */ + public function count(): int + { + if (ClassInfo::hasMethod($this->data, 'count')) { + $count = $this->callDataMethod($this->data, 'count', []); + if ($count !== null) { + return $count; + } + } + if (isset($this->data->count)) { + return $this->data->count; + } + if (is_countable($this->data)) { + return count($this->data); + } + if (ClassInfo::hasMethod($this->data, 'getIterator')) { + return count($this->data->getIterator()); + } + return 0; + } + + public function getIterator(): Traversable + { + if (!is_iterable($this->data) && !ClassInfo::hasMethod($this->data, 'getIterator')) { + $type = is_object($this->data) ? get_class($this->data) : gettype($this->data); + throw new BadMethodCallException("$type is not iterable."); + } + + $iterator = $this->data; + if (!is_iterable($iterator)) { + $iterator = $this->data->getIterator(); + } + $source = $this->data instanceof ModelData ? $this->data : null; + foreach ($iterator as $item) { + yield $item === null ? null : ViewLayerData::create($item, $source); + } + } + + public function __isset(string $name): bool + { + // Might be worth reintroducing the way ss template engine checks if lists/countables "exist" here, + // i.e. if ($this->data->__isset($name) && is_countable($this->data->{$name})) { return count($this->data->{$name}) > 0; } + // In worst-case scenarios that would result in lazy-loading a value when we don't need to, but we already do that with the current system. + + // The SS template system uses `ModelData::hasValue()` rather than isset(), but using that doesn't check for methods and we can't use + // method_exists on ViewLayerData because the method just simply DOESN'T exist.... so. Hmm. + // UPDATE: Added ClassInfo::hasMethod here to simulate what ModelData does... will still have to check if it works with twig + // Removing method_exists check in scope for now. + return isset($this->data->$name) || ClassInfo::hasMethod($this->data, $name); + } + + public function __get(string $name): ?ViewLayerData + { + $value = $this->getRawDataValue($name, ViewLayerData::TYPE_PROPERTY); + if ($value === null) { + return null; + } + $source = $this->data instanceof ModelData ? $this->data : null; + return ViewLayerData::create($value, $source, $name); // @TODO maybe not return this here, but wrap it again in the next layer? This may not play nicely with twig when passing values into args? + } + + public function __call(string $name, array $arguments = []): ?ViewLayerData + { + $value = $this->getRawDataValue($name, ViewLayerData::TYPE_METHOD, $arguments); + if ($value === null) { + return null; + } + $source = $this->data instanceof ModelData ? $this->data : null; + return ViewLayerData::create($value, $source, $name); // @TODO maybe not return this here, but wrap it again in the next layer? This may not play nicely with twig when passing values into args? + } + + public function __toString(): string + { + if ($this->data instanceof ModelData) { + return $this->data->forTemplate(); + } + return (string) $this->data; + } + + // @TODO We need this right now for the ss template engine, but need to check if + // we can rely on it, since twig won't be calling this at all + public function hasDataValue(?string $name = null, array $arguments = []): bool + { + if ($name) { + if ($this->data instanceof ModelData) { + return $this->data->hasValue($name, $arguments); + } + return isset($this->$name); + } + if ($this->data instanceof ModelData) { + return $this->data->exists(); + } + return (bool) $this->data; + } + + // @TODO We need this publicly right now for the ss template engine method args, but need to check if + // we can rely on it, since twig won't be calling this at all + public function getRawDataValue(string $name, string $type = ViewLayerData::TYPE_ANY, array $arguments = []): mixed + { + if ($type !== ViewLayerData::TYPE_ANY && $type !== ViewLayerData::TYPE_METHOD && $type !== ViewLayerData::TYPE_PROPERTY) { + throw new InvalidArgumentException('$type must be one of the TYPE_* constant values'); + } + + $data = $this->data; + if ($data instanceof ModelDataCustomised && $data->customisedHas($name)) { + $data = $data->getCustomisedModelData(); + } + + // We don't currently use the $type, but could in a future enhancement if we find that distinction useful. + $value = $this->getValueFromData($data, $name, $arguments); + + return $value; + } + + private function getValueFromData(object $data, string $name, array $arguments): mixed + { + // Values from ModelData can be cached + if ($data instanceof ModelData) { + $cached = $data->objCacheGet($name, $arguments); + if ($cached !== null) { + return $cached; + } + } + + $value = null; + // Keep track of whether we've already fetched a value (allowing null to be the correct value) + $fetchedValue = false; + + // Try calling a method even if we're fetching as a property + // This matches historical behaviour that a LOT of logic in core modules expects + $value = $this->callDataMethod($data, $name, $arguments, $fetchedValue); + + // Try to get a property even if we aren't explicitly trying to call a method, if the method didn't exist. + // This matches historical behaviour and allows e.g. `$MyProperty(some-arg)` with a `getMyProperty($arg)` method. + if (!$fetchedValue) { + // Try an explicit getter + // This matches the "magic" getter behaviour of ModelData across the board for consistent results + $getter = "get{$name}"; + $value = $this->callDataMethod($data, $getter, $arguments, $fetchedValue); + if (!$fetchedValue && isset($data->$name)) { + $value = $data->$name; + $fetchedValue = true; + } + } + + // Caching for modeldata + if ($data instanceof ModelData) { + $data->objCacheSet($name, $arguments, $value); + } + + return $value; + } + + private function callDataMethod(object $data, string $name, array $arguments, bool &$fetchedValue = false): mixed + { + $hasDynamicMethods = method_exists($data, '__call'); + $hasMethod = ClassInfo::hasMethod($data, $name); + if ($hasMethod || $hasDynamicMethods) { + try { + $value = $data->$name(...$arguments); + $fetchedValue = true; + return $value; + } catch (BadMethodCallException $e) { + // Only throw the exception if we weren't relying on __call + // It's common for __call to throw BadMethodCallException for methods that aren't "implemented" + // so we just want to return null in those cases. + if (!$hasDynamicMethods) { + throw $e; + } + } + } + return null; + } +} diff --git a/tests/php/Forms/GridField/GridField_URLHandlerTest/TestComponent.php b/tests/php/Forms/GridField/GridField_URLHandlerTest/TestComponent.php index dea7ccc66..60adbcfd7 100644 --- a/tests/php/Forms/GridField/GridField_URLHandlerTest/TestComponent.php +++ b/tests/php/Forms/GridField/GridField_URLHandlerTest/TestComponent.php @@ -56,7 +56,7 @@ class TestComponent extends RequestHandler implements GridField_URLHandler public function showform(GridField $gridField, HTTPRequest $request) { $this->setRequest($request); - return "" . SSViewer::get_base_tag("") . "" . $this->Form($gridField, $request)->forTemplate(); + return "" . SSViewer::getBaseTag() . "" . $this->Form($gridField, $request)->forTemplate(); } /** diff --git a/tests/php/Forms/GridField/GridField_URLHandlerTest/TestComponent_ItemRequest.php b/tests/php/Forms/GridField/GridField_URLHandlerTest/TestComponent_ItemRequest.php index fc7774ef1..639c114d6 100644 --- a/tests/php/Forms/GridField/GridField_URLHandlerTest/TestComponent_ItemRequest.php +++ b/tests/php/Forms/GridField/GridField_URLHandlerTest/TestComponent_ItemRequest.php @@ -36,7 +36,7 @@ class TestComponent_ItemRequest extends RequestHandler public function showform() { - return "" . SSViewer::get_base_tag("") . "" . $this->Form()->forTemplate(); + return "" . SSViewer::getBaseTag() . "" . $this->Form()->forTemplate(); } public function Form() diff --git a/tests/php/Forms/TreeDropdownFieldTest.php b/tests/php/Forms/TreeDropdownFieldTest.php index 83e091f89..012b22b9a 100644 --- a/tests/php/Forms/TreeDropdownFieldTest.php +++ b/tests/php/Forms/TreeDropdownFieldTest.php @@ -314,7 +314,7 @@ class TreeDropdownFieldTest extends SapphireTest $noResult = $parser->getBySelector($cssPath); $this->assertEmpty( $noResult, - $subObject2 . ' is not found' + get_class($subObject2) . ' is not found' ); } diff --git a/tests/php/Forms/TreeMultiselectFieldTest.php b/tests/php/Forms/TreeMultiselectFieldTest.php index 408ab4af8..2d07fdf10 100644 --- a/tests/php/Forms/TreeMultiselectFieldTest.php +++ b/tests/php/Forms/TreeMultiselectFieldTest.php @@ -7,6 +7,8 @@ use SilverStripe\Dev\SapphireTest; use SilverStripe\Forms\Form; use SilverStripe\Forms\FormTemplateHelper; use SilverStripe\Forms\TreeMultiselectField; +use SilverStripe\ORM\Tests\HierarchyTest\HierarchyOnSubclassTestObject; +use SilverStripe\ORM\Tests\HierarchyTest\HierarchyOnSubclassTestSubObject; use SilverStripe\ORM\Tests\HierarchyTest\TestObject; use SilverStripe\View\SSViewer; @@ -16,6 +18,8 @@ class TreeMultiselectFieldTest extends SapphireTest protected static $extra_dataobjects = [ TestObject::class, + HierarchyOnSubclassTestObject::class, + HierarchyOnSubclassTestSubObject::class, ]; protected $formId = 'TheFormID'; diff --git a/tests/php/Model/ModelDataTest.php b/tests/php/Model/ModelDataTest.php index 33f4b171d..f3e910b77 100644 --- a/tests/php/Model/ModelDataTest.php +++ b/tests/php/Model/ModelDataTest.php @@ -122,7 +122,7 @@ class ModelDataTest extends SapphireTest $this->assertEquals('casted', $newModelData->XML_val('alwaysCasted')); $this->assertEquals('castable', $modelData->forTemplate()); - $this->assertEquals('casted', $newModelData->forTemplate()); + $this->assertEquals('castable', $newModelData->forTemplate()); } public function testDefaultValueWrapping() @@ -139,25 +139,6 @@ class ModelDataTest extends SapphireTest $this->assertEquals('SomeTitleValue', $obj->forTemplate()); } - public function testCastingClass() - { - $expected = [ - //'NonExistant' => null, - 'Field' => 'CastingType', - 'Argument' => 'ArgumentType', - 'ArrayArgument' => 'ArrayArgumentType' - ]; - $obj = new ModelDataTest\CastingClass(); - - foreach ($expected as $field => $class) { - $this->assertEquals( - $class, - $obj->castingClass($field), - "castingClass() returns correct results for ::\$$field" - ); - } - } - public function testObjWithCachedStringValueReturnsValidObject() { $obj = new ModelDataTest\NoCastingInformation(); diff --git a/tests/php/Model/ModelDataTest/NotCached.php b/tests/php/Model/ModelDataTest/NotCached.php index 2b9888249..57678e641 100644 --- a/tests/php/Model/ModelDataTest/NotCached.php +++ b/tests/php/Model/ModelDataTest/NotCached.php @@ -9,7 +9,7 @@ class NotCached extends ModelData implements TestOnly { public $Test; - protected function objCacheGet($key) + public function objCacheGet(string $fieldName, array $arguments = []): mixed { // Disable caching return null; diff --git a/tests/php/ORM/Filters/EndsWithFilterTest.php b/tests/php/ORM/Filters/EndsWithFilterTest.php index 40c69c0e2..907715d07 100644 --- a/tests/php/ORM/Filters/EndsWithFilterTest.php +++ b/tests/php/ORM/Filters/EndsWithFilterTest.php @@ -197,20 +197,6 @@ class EndsWithFilterTest extends SapphireTest 'modifiers' => [], 'matches' => false, ], - // These will both evaluate to true because the __toString() method just returns the class name. - // We're testing this scenario because ArrayList might contain arbitrary values - [ - 'filterValue' => new ArrayData(['SomeField' => 'some value']), - 'matchValue' => new ArrayData(['SomeField' => 'some value']), - 'modifiers' => [], - 'matches' => true, - ], - [ - 'filterValue' => new ArrayData(['SomeField' => 'SoMe VaLuE']), - 'matchValue' => new ArrayData(['SomeField' => 'some value']), - 'modifiers' => [], - 'matches' => true, - ], // case insensitive [ 'filterValue' => 'somevalue', diff --git a/tests/php/ORM/Filters/PartialMatchFilterTest.php b/tests/php/ORM/Filters/PartialMatchFilterTest.php index 7d11ebe7c..8a3d5fdaf 100644 --- a/tests/php/ORM/Filters/PartialMatchFilterTest.php +++ b/tests/php/ORM/Filters/PartialMatchFilterTest.php @@ -197,20 +197,6 @@ class PartialMatchFilterTest extends SapphireTest 'modifiers' => [], 'matches' => false, ], - // These will both evaluate to true because the __toString() method just returns the class name. - // We're testing this scenario because ArrayList might contain arbitrary values - [ - 'filterValue' => new ArrayData(['SomeField' => 'some value']), - 'matchValue' => new ArrayData(['SomeField' => 'some value']), - 'modifiers' => [], - 'matches' => true, - ], - [ - 'filterValue' => new ArrayData(['SomeField' => 'SoMe VaLuE']), - 'matchValue' => new ArrayData(['SomeField' => 'some value']), - 'modifiers' => [], - 'matches' => true, - ], // case insensitive [ 'filterValue' => 'somevalue', diff --git a/tests/php/ORM/Filters/StartsWithFilterTest.php b/tests/php/ORM/Filters/StartsWithFilterTest.php index 32e2050ff..66a2d8b16 100644 --- a/tests/php/ORM/Filters/StartsWithFilterTest.php +++ b/tests/php/ORM/Filters/StartsWithFilterTest.php @@ -197,20 +197,6 @@ class StartsWithFilterTest extends SapphireTest 'modifiers' => [], 'matches' => false, ], - // These will both evaluate to true because the __toString() method just returns the class name. - // We're testing this scenario because ArrayList might contain arbitrary values - [ - 'filterValue' => new ArrayData(['SomeField' => 'some value']), - 'matchValue' => new ArrayData(['SomeField' => 'some value']), - 'modifiers' => [], - 'matches' => true, - ], - [ - 'filterValue' => new ArrayData(['SomeField' => 'SoMe VaLuE']), - 'matchValue' => new ArrayData(['SomeField' => 'some value']), - 'modifiers' => [], - 'matches' => true, - ], // case insensitive [ 'filterValue' => 'somevalue', diff --git a/tests/php/ORM/LabelFieldTest.php b/tests/php/ORM/LabelFieldTest.php index 58f3b4eda..e1170ac61 100644 --- a/tests/php/ORM/LabelFieldTest.php +++ b/tests/php/ORM/LabelFieldTest.php @@ -11,6 +11,6 @@ class LabelFieldTest extends SapphireTest public function testFieldHasNoNameAttribute() { $field = new LabelField('MyName', 'MyTitle'); - $this->assertEquals(trim($field->Field() ?? ''), ''); + $this->assertEquals('', trim($field->Field())); } } diff --git a/tests/php/View/ContentNegotiatorTest.php b/tests/php/View/ContentNegotiatorTest.php index 7465e55fa..2315bf711 100644 --- a/tests/php/View/ContentNegotiatorTest.php +++ b/tests/php/View/ContentNegotiatorTest.php @@ -5,7 +5,7 @@ namespace SilverStripe\View\Tests; use SilverStripe\Dev\SapphireTest; use SilverStripe\Control\ContentNegotiator; use SilverStripe\Control\HTTPResponse; -use SilverStripe\View\SSViewer; +use SilverStripe\View\SSViewer_FromString; use SilverStripe\View\Tests\SSViewerTest\TestFixture; class ContentNegotiatorTest extends SapphireTest @@ -17,7 +17,7 @@ class ContentNegotiatorTest extends SapphireTest */ private function render($templateString, $data = null) { - $t = SSViewer::fromString($templateString); + $t = SSViewer_FromString::create($templateString); if (!$data) { $data = new TestFixture(); } diff --git a/tests/php/View/RequirementsTest.php b/tests/php/View/RequirementsTest.php index 7c900a1eb..9f5844dc3 100644 --- a/tests/php/View/RequirementsTest.php +++ b/tests/php/View/RequirementsTest.php @@ -1501,4 +1501,31 @@ EOS 'Head Tag is correctly not displaying original write' ); } + + public function testRequirementsCombine() + { + /** @var Requirements_Backend $testBackend */ + $testBackend = Injector::inst()->create(Requirements_Backend::class); + $testBackend->setSuffixRequirements(false); + $testBackend->setCombinedFilesEnabled(true); + + //$combinedTestFilePath = BASE_PATH . '/' . $testBackend->getCombinedFilesFolder() . '/testRequirementsCombine.js'; + + $jsFile = $this->getCurrentRelativePath() . '/SSViewerTest/javascript/bad.js'; + $jsFileContents = file_get_contents(BASE_PATH . '/' . $jsFile); + $testBackend->combineFiles('testRequirementsCombine.js', [$jsFile]); + + // secondly, make sure that requirements is generated, even though minification failed + $testBackend->processCombinedFiles(); + $js = array_keys($testBackend->getJavascript() ?? []); + $combinedTestFilePath = Director::publicFolder() . reset($js); + $this->assertStringContainsString('_combinedfiles/testRequirementsCombine-4c0e97a.js', $combinedTestFilePath); + + // and make sure the combined content matches the input content, i.e. no loss of functionality + if (!file_exists($combinedTestFilePath ?? '')) { + $this->fail('No combined file was created at expected path: ' . $combinedTestFilePath); + } + $combinedTestFileContents = file_get_contents($combinedTestFilePath ?? ''); + $this->assertStringContainsString($jsFileContents, $combinedTestFileContents); + } } diff --git a/tests/php/View/SSTemplateEngineTest.php b/tests/php/View/SSTemplateEngineTest.php new file mode 100644 index 000000000..70fa5f3db --- /dev/null +++ b/tests/php/View/SSTemplateEngineTest.php @@ -0,0 +1,2190 @@ +set('source_file_comments', false); + TestAssetStore::activate('SSTemplateEngineTest'); + } + + protected function tearDown(): void + { + TestAssetStore::reset(); + parent::tearDown(); + } + + /** + * Test that a template without a tag still renders. + */ + public function testTemplateWithoutHeadRenders() + { + $data = new ArrayData([ 'Var' => 'var value' ]); + $engine = new SSTemplateEngine('SSTemplateEngineTestPartialTemplate'); + $result = $engine->render(new ViewLayerData($data)); + $this->assertEquals('Test partial template: var value', trim(preg_replace("//U", '', $result ?? '') ?? '')); + } + + /** + * Ensure global methods aren't executed + */ + public function testTemplateExecution() + { + $data = new ArrayData([ 'Var' => 'phpinfo' ]); + $engine = new SSTemplateEngine('SSTemplateEngineTestPartialTemplate'); + $result = $engine->render(new ViewLayerData($data)); + $this->assertEquals('Test partial template: phpinfo', trim(preg_replace("//U", '', $result ?? '') ?? '')); + } + + public function testIncludeScopeInheritance() + { + $data = $this->getScopeInheritanceTestData(); + $expected = [ + 'Item 1 - First-ODD top:Item 1', + 'Item 2 - EVEN top:Item 2', + 'Item 3 - ODD top:Item 3', + 'Item 4 - EVEN top:Item 4', + 'Item 5 - ODD top:Item 5', + 'Item 6 - Last-EVEN top:Item 6', + ]; + + $engine = new SSTemplateEngine('SSTemplateEngineTestIncludeScopeInheritance'); + $result = $engine->render(new ViewLayerData($data)); + $this->assertExpectedStrings($result, $expected); + + // reset results for the tests that include arguments (the title is passed as an arg) + $expected = [ + 'Item 1 _ Item 1 - First-ODD top:Item 1', + 'Item 2 _ Item 2 - EVEN top:Item 2', + 'Item 3 _ Item 3 - ODD top:Item 3', + 'Item 4 _ Item 4 - EVEN top:Item 4', + 'Item 5 _ Item 5 - ODD top:Item 5', + 'Item 6 _ Item 6 - Last-EVEN top:Item 6', + ]; + + $engine = new SSTemplateEngine('SSTemplateEngineTestIncludeScopeInheritanceWithArgs'); + $result = $engine->render(new ViewLayerData($data)); + $this->assertExpectedStrings($result, $expected); + } + + public function testIncludeTruthyness() + { + $data = new ArrayData([ + 'Title' => 'TruthyTest', + 'Items' => new ArrayList([ + new ArrayData(['Title' => 'Item 1']), + new ArrayData(['Title' => '']), + new ArrayData(['Title' => true]), + new ArrayData(['Title' => false]), + new ArrayData(['Title' => null]), + new ArrayData(['Title' => 0]), + new ArrayData(['Title' => 7]) + ]) + ]); + $engine = new SSTemplateEngine('SSTemplateEngineTestIncludeScopeInheritanceWithArgs'); + $result = $engine->render(new ViewLayerData($data)); + + // We should not end up with empty values appearing as empty + $expected = [ + 'Item 1 _ Item 1 - First-ODD top:Item 1', + 'Untitled - EVEN top:', + '1 _ 1 - ODD top:1', + 'Untitled - EVEN top:', + 'Untitled - ODD top:', + 'Untitled - EVEN top:0', + '7 _ 7 - Last-ODD top:7', + ]; + $this->assertExpectedStrings($result, $expected); + } + + public function testRequirements() + { + /** @var Requirements_Backend|MockObject $requirements */ + $requirements = $this + ->getMockBuilder(Requirements_Backend::class) + ->onlyMethods(['javascript', 'css']) + ->getMock(); + $jsFile = FRAMEWORK_DIR . '/tests/forms/a.js'; + $cssFile = FRAMEWORK_DIR . '/tests/forms/a.js'; + + $requirements->expects($this->once())->method('javascript')->with($jsFile); + $requirements->expects($this->once())->method('css')->with($cssFile); + + $origReq = Requirements::backend(); + Requirements::set_backend($requirements); + $result = $this->render( + "<% require javascript($jsFile) %> + <% require css($cssFile) %>" + ); + Requirements::set_backend($origReq); + + // Injecting the actual requirements is the responsibility of SSViewer, so we shouldn't see it in the result + $this->assertFalse((bool)trim($result), 'Should be no content in this return.'); + } + + public function testRequireCallInTemplateInclude() + { + /** @var Requirements_Backend|MockObject $requirements */ + $requirements = $this + ->getMockBuilder(Requirements_Backend::class) + ->onlyMethods(['themedJavascript', 'css']) + ->getMock(); + + $requirements->expects($this->once())->method('themedJavascript')->with('RequirementsTest_a'); + $requirements->expects($this->never())->method('css'); + + $engine = new SSTemplateEngine('SSTemplateEngineTestProcess'); + $origReq = Requirements::backend(); + Requirements::set_backend($requirements); + Requirements::set_suffix_requirements(false); + $result = $engine->render(new ViewLayerData([])); + Requirements::set_backend($origReq); + + // Injecting the actual requirements is the responsibility of SSViewer, so we shouldn't see it in the result + $this->assertEqualIgnoringWhitespace('', $result); + } + + public function testComments() + { + $input = <<This is some content<%-- this is another comment --%>Final content + <%-- Alone multi + line comment --%> + Some more content + Mixing content and <%-- multi + line comment --%> Final final + content + <%--commentwithoutwhitespace--%>last content + SS; + $actual = $this->render($input); + $expected = <<assertEquals($expected, $actual); + + $input = <<empty comment1 + <%-- --%>empty comment2 + <%----%>empty comment3 + SS; + $actual = $this->render($input); + $expected = <<assertEquals($expected, $actual); + } + + public function testBasicText() + { + $this->assertEquals('"', $this->render('"'), 'Double-quotes are left alone'); + $this->assertEquals("'", $this->render("'"), 'Single-quotes are left alone'); + $this->assertEquals('A', $this->render('\\A'), 'Escaped characters are unescaped'); + $this->assertEquals('\\A', $this->render('\\\\A'), 'Escaped back-slashed are correctly unescaped'); + } + + public function testBasicInjection() + { + $this->assertEquals('[out:Test]', $this->render('$Test'), 'Basic stand-alone injection'); + $this->assertEquals('[out:Test]', $this->render('{$Test}'), 'Basic stand-alone wrapped injection'); + $this->assertEquals('A[out:Test]!', $this->render('A$Test!'), 'Basic surrounded injection'); + $this->assertEquals('A[out:Test]B', $this->render('A{$Test}B'), 'Basic surrounded wrapped injection'); + + $this->assertEquals('A$B', $this->render('A\\$B'), 'No injection as $ escaped'); + $this->assertEquals('A$ B', $this->render('A$ B'), 'No injection as $ not followed by word character'); + $this->assertEquals('A{$ B', $this->render('A{$ B'), 'No injection as {$ not followed by word character'); + + $this->assertEquals('{$Test}', $this->render('{\\$Test}'), 'Escapes can be used to avoid injection'); + $this->assertEquals( + '{\\[out:Test]}', + $this->render('{\\\\$Test}'), + 'Escapes before injections are correctly unescaped' + ); + } + + public function testBasicInjectionMismatchedBrackets() + { + $this->expectException(SSTemplateParseException::class); + $this->expectExceptionMessageMatches('/Malformed bracket injection {\$Value(.*)/'); + $this->render('A {$Value here'); + $this->fail("Parser didn't error when encountering mismatched brackets in an injection"); + } + + public function testGlobalVariableCalls() + { + $this->assertEquals('automatic', $this->render('$SSTemplateEngineTest_GlobalAutomatic')); + $this->assertEquals('reference', $this->render('$SSTemplateEngineTest_GlobalReferencedByString')); + $this->assertEquals('reference', $this->render('$SSTemplateEngineTest_GlobalReferencedInArray')); + } + + public function testGlobalVariableCallsWithArguments() + { + $this->assertEquals('zz', $this->render('$SSTemplateEngineTest_GlobalThatTakesArguments')); + $this->assertEquals('zFooz', $this->render('$SSTemplateEngineTest_GlobalThatTakesArguments("Foo")')); + $this->assertEquals( + 'zFoo:Bar:Bazz', + $this->render('$SSTemplateEngineTest_GlobalThatTakesArguments("Foo", "Bar", "Baz")') + ); + $this->assertEquals( + 'zreferencez', + $this->render('$SSTemplateEngineTest_GlobalThatTakesArguments($SSTemplateEngineTest_GlobalReferencedByString)') + ); + } + + public function testGlobalVariablesAreEscaped() + { + $this->assertEquals('
', $this->render('$SSTemplateEngineTest_GlobalHTMLFragment')); + $this->assertEquals('<div></div>', $this->render('$SSTemplateEngineTest_GlobalHTMLEscaped')); + + $this->assertEquals( + 'z
z', + $this->render('$SSTemplateEngineTest_GlobalThatTakesArguments($SSTemplateEngineTest_GlobalHTMLFragment)') + ); + // Don't escape value when passing into a method call + $this->assertEquals( + 'z
z', + $this->render('$SSTemplateEngineTest_GlobalThatTakesArguments($SSTemplateEngineTest_GlobalHTMLEscaped)') + ); + } + + public function testGlobalVariablesReturnNull() + { + $this->assertEquals('

', $this->render('

$SSTemplateEngineTest_GlobalReturnsNull

')); + $this->assertEquals('

', $this->render('

$SSTemplateEngineTest_GlobalReturnsNull.Chained.Properties

')); + } + + public function testCoreGlobalVariableCalls() + { + $this->assertEquals( + Director::absoluteBaseURL(), + $this->render('{$absoluteBaseURL}'), + 'Director::absoluteBaseURL can be called from within template' + ); + $this->assertEquals( + Director::absoluteBaseURL(), + $this->render('{$AbsoluteBaseURL}'), + 'Upper-case %AbsoluteBaseURL can be called from within template' + ); + + $this->assertEquals( + Director::is_ajax(), + $this->render('{$isAjax}'), + 'All variations of is_ajax result in the correct call' + ); + $this->assertEquals( + Director::is_ajax(), + $this->render('{$IsAjax}'), + 'All variations of is_ajax result in the correct call' + ); + $this->assertEquals( + Director::is_ajax(), + $this->render('{$is_ajax}'), + 'All variations of is_ajax result in the correct call' + ); + $this->assertEquals( + Director::is_ajax(), + $this->render('{$Is_ajax}'), + 'All variations of is_ajax result in the correct call' + ); + + $this->assertEquals( + i18n::get_locale(), + $this->render('{$i18nLocale}'), + 'i18n template functions result correct result' + ); + $this->assertEquals( + i18n::get_locale(), + $this->render('{$get_locale}'), + 'i18n template functions result correct result' + ); + + $this->assertEquals( + Security::getCurrentUser()->ID, + $this->render('{$CurrentMember.ID}'), + 'Member template functions result correct result' + ); + $this->assertEquals( + Security::getCurrentUser()->ID, + $this->render('{$CurrentUser.ID}'), + 'Member template functions result correct result' + ); + $this->assertEquals( + Security::getCurrentUser()->ID, + $this->render('{$currentMember.ID}'), + 'Member template functions result correct result' + ); + $this->assertEquals( + Security::getCurrentUser()->ID, + $this->render('{$currentUser.ID}'), + 'Member template functions result correct result' + ); + + $this->assertEquals( + SecurityToken::getSecurityID(), + $this->render('{$getSecurityID}'), + 'SecurityToken template functions result correct result' + ); + $this->assertEquals( + SecurityToken::getSecurityID(), + $this->render('{$SecurityID}'), + 'SecurityToken template functions result correct result' + ); + + $this->assertEquals( + Permission::check("ADMIN"), + (bool)$this->render('{$HasPerm(\'ADMIN\')}'), + 'Permissions template functions result correct result' + ); + $this->assertEquals( + Permission::check("ADMIN"), + (bool)$this->render('{$hasPerm(\'ADMIN\')}'), + 'Permissions template functions result correct result' + ); + } + + public function testNonFieldCastingHelpersNotUsedInHasValue() + { + // check if Link without $ in front of variable + $result = $this->render( + 'A<% if Link %>$Link<% end_if %>B', + new SSTemplateEngineTest\TestObject() + ); + $this->assertEquals('Asome/url.htmlB', $result, 'casting helper not used for <% if Link %>'); + + // check if Link with $ in front of variable + $result = $this->render( + 'A<% if $Link %>$Link<% end_if %>B', + new SSTemplateEngineTest\TestObject() + ); + $this->assertEquals('Asome/url.htmlB', $result, 'casting helper not used for <% if $Link %>'); + } + + public function testLocalFunctionsTakePriorityOverGlobals() + { + $data = new ArrayData([ + 'Page' => new SSTemplateEngineTest\TestObject() + ]); + + //call method with lots of arguments + $result = $this->render( + '<% with Page %>$lotsOfArguments11("a","b","c","d","e","f","g","h","i","j","k")<% end_with %>', + $data + ); + $this->assertEquals("abcdefghijk", $result, "public function can accept up to 11 arguments"); + + //call method that does not exist + $result = $this->render('<% with Page %><% if IDoNotExist %>hello<% end_if %><% end_with %>', $data); + $this->assertEquals("", $result, "Method does not exist - empty result"); + + //call if that does not exist + $result = $this->render('<% with Page %>$IDoNotExist("hello")<% end_with %>', $data); + $this->assertEquals("", $result, "Method does not exist - empty result"); + + //call method with same name as a global method (local call should take priority) + $result = $this->render('<% with Page %>$absoluteBaseURL<% end_with %>', $data); + $this->assertEquals( + "testLocalFunctionPriorityCalled", + $result, + "Local Object's public function called. Did not return the actual baseURL of the current site" + ); + } + + public function testCurrentScopeLoop(): void + { + $data = new ArrayList([['Val' => 'one'], ['Val' => 'two'], ['Val' => 'three']]); + $this->assertEqualIgnoringWhitespace( + 'one two three', + $this->render('<% loop %>$Val<% end_loop %>', $data) + ); + } + + public function testCurrentScopeLoopWith() + { + // Data to run the loop tests on - one sequence of three items, each with a subitem + $data = new ArrayData([ + 'Foo' => new ArrayList([ + 'Subocean' => new ArrayData([ + 'Name' => 'Higher' + ]), + new ArrayData([ + 'Sub' => new ArrayData([ + 'Name' => 'SubKid1' + ]) + ]), + new ArrayData([ + 'Sub' => new ArrayData([ + 'Name' => 'SubKid2' + ]) + ]), + new SSTemplateEngineTest\TestObject('Number6') + ]) + ]); + + $result = $this->render( + '<% loop Foo %>$Number<% if Sub %><% with Sub %>$Name<% end_with %><% end_if %><% end_loop %>', + $data + ); + $this->assertEquals("SubKid1SubKid2Number6", $result, "Loop works"); + + $result = $this->render( + '<% loop Foo %>$Number<% if Sub %><% with Sub %>$Name<% end_with %><% end_if %><% end_loop %>', + $data + ); + $this->assertEquals("SubKid1SubKid2Number6", $result, "Loop works"); + + $result = $this->render('<% with Foo %>$Count<% end_with %>', $data); + $this->assertEquals("4", $result, "4 items in the DataObjectSet"); + + $result = $this->render( + '<% with Foo %><% loop Up.Foo %>$Number<% if Sub %><% with Sub %>$Name<% end_with %>' + . '<% end_if %><% end_loop %><% end_with %>', + $data + ); + $this->assertEquals("SubKid1SubKid2Number6", $result, "Loop in with Up.Foo scope works"); + + $result = $this->render( + '<% with Foo %><% loop %>$Number<% if Sub %><% with Sub %>$Name<% end_with %>' + . '<% end_if %><% end_loop %><% end_with %>', + $data + ); + $this->assertEquals("SubKid1SubKid2Number6", $result, "Loop in current scope works"); + } + + public static function provideArgumentTypes() + { + return [ + [ + 'arg1:0,arg2:"string",arg3:true', + '$methodWithTypedArguments(0, "string", true).RAW', + ], + [ + 'arg1:false,arg2:"string",arg3:true', + '$methodWithTypedArguments(false, "string", true).RAW', + ], + [ + 'arg1:null,arg2:"string",arg3:true', + '$methodWithTypedArguments(null, "string", true).RAW', + ], + [ + 'arg1:"",arg2:"string",arg3:true', + '$methodWithTypedArguments("", "string", true).RAW', + ], + [ + 'arg1:0,arg2:1,arg3:2', + '$methodWithTypedArguments(0, 1, 2).RAW', + ], + ]; + } + + #[DataProvider('provideArgumentTypes')] + public function testArgumentTypes(string $expected, string $template) + { + $this->assertEquals($expected, $this->render($template, new TestModelData())); + } + + public function testObjectDotArguments() + { + $this->assertEquals( + '[out:TestObject.methodWithOneArgument(one)] + [out:TestObject.methodWithTwoArguments(one,two)] + [out:TestMethod(Arg1,Arg2).Bar.Val] + [out:TestMethod(Arg1,Arg2).Bar] + [out:TestMethod(Arg1,Arg2)] + [out:TestMethod(Arg1).Bar.Val] + [out:TestMethod(Arg1).Bar] + [out:TestMethod(Arg1)]', + $this->render( + '$TestObject.methodWithOneArgument(one) + $TestObject.methodWithTwoArguments(one,two) + $TestMethod(Arg1, Arg2).Bar.Val + $TestMethod(Arg1, Arg2).Bar + $TestMethod(Arg1, Arg2) + $TestMethod(Arg1).Bar.Val + $TestMethod(Arg1).Bar + $TestMethod(Arg1)' + ) + ); + } + + public function testEscapedArguments() + { + $this->assertEquals( + '[out:Foo(Arg1,Arg2).Bar.Val].Suffix + [out:Foo(Arg1,Arg2).Val]_Suffix + [out:Foo(Arg1,Arg2)]/Suffix + [out:Foo(Arg1).Bar.Val]textSuffix + [out:Foo(Arg1).Bar].Suffix + [out:Foo(Arg1)].Suffix + [out:Foo.Bar.Val].Suffix + [out:Foo.Bar].Suffix + [out:Foo].Suffix', + $this->render( + '{$Foo(Arg1, Arg2).Bar.Val}.Suffix + {$Foo(Arg1, Arg2).Val}_Suffix + {$Foo(Arg1, Arg2)}/Suffix + {$Foo(Arg1).Bar.Val}textSuffix + {$Foo(Arg1).Bar}.Suffix + {$Foo(Arg1)}.Suffix + {$Foo.Bar.Val}.Suffix + {$Foo.Bar}.Suffix + {$Foo}.Suffix' + ) + ); + } + + public function testLoopWhitespace() + { + $data = new ArrayList([new SSTemplateEngineTest\TestFixture()]); + $this->assertEquals( + 'before[out:Test]after + beforeTestafter', + $this->render( + 'before<% loop %>$Test<% end_loop %>after + before<% loop %>Test<% end_loop %>after', + $data + ) + ); + + // The control tags are removed from the output, but no whitespace + // This is a quirk that could be changed, but included in the test to make the current + // behaviour explicit + $this->assertEquals( + 'before + +[out:ItemOnItsOwnLine] + +after', + $this->render( + 'before +<% loop %> +$ItemOnItsOwnLine +<% end_loop %> +after', + $data + ) + ); + + // The whitespace within the control tags is preserve in a loop + // This is a quirk that could be changed, but included in the test to make the current + // behaviour explicit + $this->assertEquals( + 'before + +[out:Loop3.ItemOnItsOwnLine] + +[out:Loop3.ItemOnItsOwnLine] + +[out:Loop3.ItemOnItsOwnLine] + +after', + $this->render( + 'before +<% loop Loop3 %> +$ItemOnItsOwnLine +<% end_loop %> +after' + ) + ); + } + + public static function typePreservationDataProvider() + { + return [ + // Null + ['NULL:', 'null'], + ['NULL:', 'NULL'], + // Booleans + ['boolean:1', 'true'], + ['boolean:1', 'TRUE'], + ['boolean:', 'false'], + ['boolean:', 'FALSE'], + // Strings which may look like booleans/null to the parser + ['string:nullish', 'nullish'], + ['string:notnull', 'notnull'], + ['string:truethy', 'truethy'], + ['string:untrue', 'untrue'], + ['string:falsey', 'falsey'], + // Integers + ['integer:0', '0'], + ['integer:1', '1'], + ['integer:15', '15'], + ['integer:-15', '-15'], + // Octal integers + ['integer:83', '0123'], + ['integer:-83', '-0123'], + // Hexadecimal integers + ['integer:26', '0x1A'], + ['integer:-26', '-0x1A'], + // Binary integers + ['integer:255', '0b11111111'], + ['integer:-255', '-0b11111111'], + // Floats (aka doubles) + ['double:0', '0.0'], + ['double:1', '1.0'], + ['double:15.25', '15.25'], + ['double:-15.25', '-15.25'], + ['double:1200', '1.2e3'], + ['double:-1200', '-1.2e3'], + ['double:0.07', '7E-2'], + ['double:-0.07', '-7E-2'], + // Explicitly quoted strings + ['string:0', '"0"'], + ['string:1', '\'1\''], + ['string:foobar', '"foobar"'], + ['string:foo bar baz', '"foo bar baz"'], + ['string:false', '\'false\''], + ['string:true', '\'true\''], + ['string:null', '\'null\''], + ['string:false', '"false"'], + ['string:true', '"true"'], + ['string:null', '"null"'], + // Implicit strings + ['string:foobar', 'foobar'], + ['string:foo bar baz', 'foo bar baz'] + ]; + } + + #[DataProvider('typePreservationDataProvider')] + public function testTypesArePreserved($expected, $templateArg) + { + $data = new ArrayData([ + 'Test' => new TestModelData() + ]); + + $this->assertEquals($expected, $this->render("\$Test.Type({$templateArg})", $data)); + } + + #[DataProvider('typePreservationDataProvider')] + public function testTypesArePreservedAsIncludeArguments($expected, $templateArg) + { + $data = new ArrayData([ + 'Test' => new TestModelData() + ]); + + $this->assertEquals( + $expected, + $this->render("<% include SSTemplateEngineTestTypePreservation Argument={$templateArg} %>", $data) + ); + } + + public function testTypePreservationInConditionals() + { + $data = new ArrayData([ + 'Test' => new TestModelData() + ]); + + // Types in conditionals + $this->assertEquals('pass', $this->render('<% if true %>pass<% else %>fail<% end_if %>', $data)); + $this->assertEquals('pass', $this->render('<% if false %>fail<% else %>pass<% end_if %>', $data)); + $this->assertEquals('pass', $this->render('<% if 1 %>pass<% else %>fail<% end_if %>', $data)); + $this->assertEquals('pass', $this->render('<% if 0 %>fail<% else %>pass<% end_if %>', $data)); + } + + public function testControls() + { + // Single item controls + $this->assertEquals( + 'a[out:Foo.Bar.Item]b + [out:Foo.Bar(Arg1).Item] + [out:Foo(Arg1).Item] + [out:Foo(Arg1,Arg2).Item] + [out:Foo(Arg1,Arg2,Arg3).Item]', + $this->render( + '<% with Foo.Bar %>a{$Item}b<% end_with %> + <% with Foo.Bar(Arg1) %>$Item<% end_with %> + <% with Foo(Arg1) %>$Item<% end_with %> + <% with Foo(Arg1, Arg2) %>$Item<% end_with %> + <% with Foo(Arg1, Arg2, Arg3) %>$Item<% end_with %>' + ) + ); + + // Loop controls + $this->assertEquals( + 'a[out:Foo.Loop2.Item]ba[out:Foo.Loop2.Item]b', + $this->render('<% loop Foo.Loop2 %>a{$Item}b<% end_loop %>') + ); + + $this->assertEquals( + '[out:Foo.Loop2(Arg1).Item][out:Foo.Loop2(Arg1).Item]', + $this->render('<% loop Foo.Loop2(Arg1) %>$Item<% end_loop %>') + ); + + $this->assertEquals( + '[out:Loop2(Arg1).Item][out:Loop2(Arg1).Item]', + $this->render('<% loop Loop2(Arg1) %>$Item<% end_loop %>') + ); + + $this->assertEquals( + '[out:Loop2(Arg1,Arg2).Item][out:Loop2(Arg1,Arg2).Item]', + $this->render('<% loop Loop2(Arg1, Arg2) %>$Item<% end_loop %>') + ); + + $this->assertEquals( + '[out:Loop2(Arg1,Arg2,Arg3).Item][out:Loop2(Arg1,Arg2,Arg3).Item]', + $this->render('<% loop Loop2(Arg1, Arg2, Arg3) %>$Item<% end_loop %>') + ); + } + + public function testIfBlocks() + { + // Basic test + $this->assertEquals( + 'AC', + $this->render('A<% if NotSet %>B$NotSet<% end_if %>C') + ); + + // Nested test + $this->assertEquals( + 'AB1C', + $this->render('A<% if IsSet %>B$NotSet<% if IsSet %>1<% else %>2<% end_if %><% end_if %>C') + ); + + // else_if + $this->assertEquals( + 'ACD', + $this->render('A<% if NotSet %>B<% else_if IsSet %>C<% end_if %>D') + ); + $this->assertEquals( + 'AD', + $this->render('A<% if NotSet %>B<% else_if AlsoNotset %>C<% end_if %>D') + ); + $this->assertEquals( + 'ADE', + $this->render('A<% if NotSet %>B<% else_if AlsoNotset %>C<% else_if IsSet %>D<% end_if %>E') + ); + + $this->assertEquals( + 'ADE', + $this->render('A<% if NotSet %>B<% else_if AlsoNotset %>C<% else_if IsSet %>D<% end_if %>E') + ); + + // Dot syntax + $this->assertEquals( + 'ACD', + $this->render('A<% if Foo.NotSet %>B<% else_if Foo.IsSet %>C<% end_if %>D') + ); + $this->assertEquals( + 'ACD', + $this->render('A<% if Foo.Bar.NotSet %>B<% else_if Foo.Bar.IsSet %>C<% end_if %>D') + ); + + // Params + $this->assertEquals( + 'ACD', + $this->render('A<% if NotSet(Param) %>B<% else %>C<% end_if %>D') + ); + $this->assertEquals( + 'ABD', + $this->render('A<% if IsSet(Param) %>B<% else %>C<% end_if %>D') + ); + + // Negation + $this->assertEquals( + 'AC', + $this->render('A<% if not IsSet %>B<% end_if %>C') + ); + $this->assertEquals( + 'ABC', + $this->render('A<% if not NotSet %>B<% end_if %>C') + ); + + // Or + $this->assertEquals( + 'ABD', + $this->render('A<% if IsSet || NotSet %>B<% else_if A %>C<% end_if %>D') + ); + $this->assertEquals( + 'ACD', + $this->render('A<% if NotSet || AlsoNotSet %>B<% else_if IsSet %>C<% end_if %>D') + ); + $this->assertEquals( + 'AD', + $this->render('A<% if NotSet || AlsoNotSet %>B<% else_if NotSet3 %>C<% end_if %>D') + ); + $this->assertEquals( + 'ACD', + $this->render('A<% if NotSet || AlsoNotSet %>B<% else_if IsSet || NotSet %>C<% end_if %>D') + ); + $this->assertEquals( + 'AD', + $this->render('A<% if NotSet || AlsoNotSet %>B<% else_if NotSet2 || NotSet3 %>C<% end_if %>D') + ); + + // Negated Or + $this->assertEquals( + 'ACD', + $this->render('A<% if not IsSet || AlsoNotSet %>B<% else_if A %>C<% end_if %>D') + ); + $this->assertEquals( + 'ABD', + $this->render('A<% if not NotSet || AlsoNotSet %>B<% else_if A %>C<% end_if %>D') + ); + $this->assertEquals( + 'ABD', + $this->render('A<% if NotSet || not AlsoNotSet %>B<% else_if A %>C<% end_if %>D') + ); + + // And + $this->assertEquals( + 'ABD', + $this->render('A<% if IsSet && AlsoSet %>B<% else_if A %>C<% end_if %>D') + ); + $this->assertEquals( + 'ACD', + $this->render('A<% if IsSet && NotSet %>B<% else_if IsSet %>C<% end_if %>D') + ); + $this->assertEquals( + 'AD', + $this->render('A<% if NotSet && NotSet2 %>B<% else_if NotSet3 %>C<% end_if %>D') + ); + $this->assertEquals( + 'ACD', + $this->render('A<% if IsSet && NotSet %>B<% else_if IsSet && AlsoSet %>C<% end_if %>D') + ); + $this->assertEquals( + 'AD', + $this->render('A<% if NotSet && NotSet2 %>B<% else_if IsSet && NotSet3 %>C<% end_if %>D') + ); + + // Equality + $this->assertEquals( + 'ABC', + $this->render('A<% if RawVal == RawVal %>B<% end_if %>C') + ); + $this->assertEquals( + 'ACD', + $this->render('A<% if Right == Wrong %>B<% else_if RawVal == RawVal %>C<% end_if %>D') + ); + $this->assertEquals( + 'ABC', + $this->render('A<% if Right != Wrong %>B<% end_if %>C') + ); + $this->assertEquals( + 'AD', + $this->render('A<% if Right == Wrong %>B<% else_if RawVal != RawVal %>C<% end_if %>D') + ); + + // test inequalities with simple numbers + $this->assertEquals('ABD', $this->render('A<% if 5 > 3 %>B<% else %>C<% end_if %>D')); + $this->assertEquals('ABD', $this->render('A<% if 5 >= 3 %>B<% else %>C<% end_if %>D')); + $this->assertEquals('ACD', $this->render('A<% if 3 > 5 %>B<% else %>C<% end_if %>D')); + $this->assertEquals('ACD', $this->render('A<% if 3 >= 5 %>B<% else %>C<% end_if %>D')); + + $this->assertEquals('ABD', $this->render('A<% if 3 < 5 %>B<% else %>C<% end_if %>D')); + $this->assertEquals('ABD', $this->render('A<% if 3 <= 5 %>B<% else %>C<% end_if %>D')); + $this->assertEquals('ACD', $this->render('A<% if 5 < 3 %>B<% else %>C<% end_if %>D')); + $this->assertEquals('ACD', $this->render('A<% if 5 <= 3 %>B<% else %>C<% end_if %>D')); + + $this->assertEquals('ABD', $this->render('A<% if 4 <= 4 %>B<% else %>C<% end_if %>D')); + $this->assertEquals('ABD', $this->render('A<% if 4 >= 4 %>B<% else %>C<% end_if %>D')); + $this->assertEquals('ACD', $this->render('A<% if 4 > 4 %>B<% else %>C<% end_if %>D')); + $this->assertEquals('ACD', $this->render('A<% if 4 < 4 %>B<% else %>C<% end_if %>D')); + + // empty else_if and else tags, if this would not be supported, + // the output would stop after A, thereby failing the assert + $this->assertEquals('AD', $this->render('A<% if IsSet %><% else %><% end_if %>D')); + $this->assertEquals( + 'AD', + $this->render('A<% if NotSet %><% else_if IsSet %><% else %><% end_if %>D') + ); + $this->assertEquals( + 'AD', + $this->render('A<% if NotSet %><% else_if AlsoNotSet %><% else %><% end_if %>D') + ); + + // Bare words with ending space + $this->assertEquals( + 'ABC', + $this->render('A<% if "RawVal" == RawVal %>B<% end_if %>C') + ); + + // Else + $this->assertEquals( + 'ADE', + $this->render('A<% if Right == Wrong %>B<% else_if RawVal != RawVal %>C<% else %>D<% end_if %>E') + ); + + // Empty if with else + $this->assertEquals( + 'ABC', + $this->render('A<% if NotSet %><% else %>B<% end_if %>C') + ); + } + + public static function provideIfBlockWithIterable(): array + { + $scenarios = [ + 'empty array' => [ + 'iterable' => [], + 'inScope' => false, + ], + 'array' => [ + 'iterable' => [1, 2, 3], + 'inScope' => false, + ], + 'ArrayList' => [ + 'iterable' => new ArrayList([['Val' => 1], ['Val' => 2], ['Val' => 3]]), + 'inScope' => false, + ], + ]; + foreach ($scenarios as $name => $scenario) { + $scenario['inScope'] = true; + $scenarios[$name . ' in scope'] = $scenario; + } + return $scenarios; + } + + #[DataProvider('provideIfBlockWithIterable')] + public function testIfBlockWithIterable(iterable $iterable, bool $inScope): void + { + $expected = count($iterable) ? 'has value' : 'no value'; + $data = new ArrayData(['Iterable' => $iterable]); + if ($inScope) { + $template = '<% with $Iterable %><% if $Me %>has value<% else %>no value<% end_if %><% end_with %>'; + } else { + $template = '<% if $Iterable %>has value<% else %>no value<% end_if %>'; + } + $this->assertEqualIgnoringWhitespace($expected, $this->render($template, $data)); + } + + public function testBaseTagGeneration() + { + // XHTML will have a closed base tag + $tmpl1 = ' + + + <% base_tag %> +

test

+ '; + $this->assertMatchesRegularExpression('/<\/head>/', $this->render($tmpl1)); + + // HTML4 and 5 will only have it for IE + $tmpl2 = ' + + <% base_tag %> +

test

+ '; + $this->assertMatchesRegularExpression( + '/<\/head>/', + $this->render($tmpl2) + ); + + + $tmpl3 = ' + + <% base_tag %> +

test

+ '; + $this->assertMatchesRegularExpression( + '/<\/head>/', + $this->render($tmpl3) + ); + + // Check that the content negotiator converts to the equally legal formats + $negotiator = new ContentNegotiator(); + + $response = new HTTPResponse($this->render($tmpl1)); + $negotiator->html($response); + $this->assertMatchesRegularExpression( + '/<\/head>/', + $response->getBody() + ); + + $response = new HTTPResponse($this->render($tmpl1)); + $negotiator->xhtml($response); + $this->assertMatchesRegularExpression('/<\/head>/', $response->getBody()); + } + + public function testIncludeWithArguments() + { + $this->assertEquals( + '

[out:Arg1]

[out:Arg2]

[out:Arg2.Count]

', + $this->render('<% include SSTemplateEngineTestIncludeWithArguments %>') + ); + + $this->assertEquals( + '

A

[out:Arg2]

[out:Arg2.Count]

', + $this->render('<% include SSTemplateEngineTestIncludeWithArguments Arg1=A %>') + ); + + $this->assertEquals( + '

A

B

', + $this->render('<% include SSTemplateEngineTestIncludeWithArguments Arg1=A, Arg2=B %>') + ); + + $this->assertEquals( + '

A Bare String

B Bare String

', + $this->render('<% include SSTemplateEngineTestIncludeWithArguments Arg1=A Bare String, Arg2=B Bare String %>') + ); + + $this->assertEquals( + '

A

Bar

', + $this->render( + '<% include SSTemplateEngineTestIncludeWithArguments Arg1="A", Arg2=$B %>', + new ArrayData(['B' => 'Bar']) + ) + ); + + $this->assertEquals( + '

A

Bar

', + $this->render( + '<% include SSTemplateEngineTestIncludeWithArguments Arg1="A" %>', + new ArrayData(['Arg1' => 'Foo', 'Arg2' => 'Bar']) + ) + ); + + $this->assertEquals( + '

A

0

', + $this->render('<% include SSTemplateEngineTestIncludeWithArguments Arg1="A", Arg2=0 %>') + ); + + $this->assertEquals( + '

A

', + $this->render('<% include SSTemplateEngineTestIncludeWithArguments Arg1="A", Arg2=false %>') + ); + + $this->assertEquals( + '

A

', + // Note Arg2 is explicitly overridden with null + $this->render('<% include SSTemplateEngineTestIncludeWithArguments Arg1="A", Arg2=null %>') + ); + + $this->assertEquals( + 'SomeArg - Foo - Bar - SomeArg', + $this->render( + '<% include SSTemplateEngineTestIncludeScopeInheritanceWithArgsInLoop Title="SomeArg" %>', + new ArrayData( + ['Items' => new ArrayList( + [ + new ArrayData(['Title' => 'Foo']), + new ArrayData(['Title' => 'Bar']) + ] + )] + ) + ) + ); + + $this->assertEquals( + 'A - B - A', + $this->render( + '<% include SSTemplateEngineTestIncludeScopeInheritanceWithArgsInWith Title="A" %>', + new ArrayData(['Item' => new ArrayData(['Title' =>'B'])]) + ) + ); + + $this->assertEquals( + 'A - B - C - B - A', + $this->render( + '<% include SSTemplateEngineTestIncludeScopeInheritanceWithArgsInNestedWith Title="A" %>', + new ArrayData( + [ + 'Item' => new ArrayData( + [ + 'Title' =>'B', 'NestedItem' => new ArrayData(['Title' => 'C']) + ] + )] + ) + ) + ); + + $this->assertEquals( + 'A - A - A', + $this->render( + '<% include SSTemplateEngineTestIncludeScopeInheritanceWithUpAndTop Title="A" %>', + new ArrayData( + [ + 'Item' => new ArrayData( + [ + 'Title' =>'B', 'NestedItem' => new ArrayData(['Title' => 'C']) + ] + )] + ) + ) + ); + + $data = new ArrayData( + [ + 'Nested' => new ArrayData( + [ + 'Object' => new ArrayData(['Key' => 'A']) + ] + ), + 'Object' => new ArrayData(['Key' => 'B']) + ] + ); + + $res = $this->render('<% include SSTemplateEngineTestIncludeObjectArguments A=$Nested.Object, B=$Object %>', $data); + $this->assertEqualIgnoringWhitespace('A B', $res, 'Objects can be passed as named arguments'); + } + + public function testNamespaceInclude() + { + $data = new ArrayData([]); + + $this->assertEquals( + "tests:( NamespaceInclude\n )", + $this->render('tests:( <% include Namespace\NamespaceInclude %> )', $data), + 'Backslashes work for namespace references in includes' + ); + + $this->assertEquals( + "tests:( NamespaceInclude\n )", + $this->render('tests:( <% include Namespace\\NamespaceInclude %> )', $data), + 'Escaped backslashes work for namespace references in includes' + ); + + $this->assertEquals( + "tests:( NamespaceInclude\n )", + $this->render('tests:( <% include Namespace/NamespaceInclude %> )', $data), + 'Forward slashes work for namespace references in includes' + ); + } + + /** + * Test search for includes fallback to non-includes folder + */ + public function testIncludeFallbacks() + { + $data = new ArrayData([]); + + $this->assertEquals( + "tests:( Namespace/Includes/IncludedTwice.ss\n )", + $this->render('tests:( <% include Namespace\\IncludedTwice %> )', $data), + 'Prefer Includes in the Includes folder' + ); + + $this->assertEquals( + "tests:( Namespace/Includes/IncludedOnceSub.ss\n )", + $this->render('tests:( <% include Namespace\\IncludedOnceSub %> )', $data), + 'Includes in only Includes folder can be found' + ); + + $this->assertEquals( + "tests:( Namespace/IncludedOnceBase.ss\n )", + $this->render('tests:( <% include Namespace\\IncludedOnceBase %> )', $data), + 'Includes outside of Includes folder can be found' + ); + } + + public function testRecursiveInclude() + { + $data = new ArrayData( + [ + 'Title' => 'A', + 'Children' => new ArrayList( + [ + new ArrayData( + [ + 'Title' => 'A1', + 'Children' => new ArrayList( + [ + new ArrayData([ 'Title' => 'A1 i', ]), + new ArrayData([ 'Title' => 'A1 ii', ]), + ] + ), + ] + ), + new ArrayData([ 'Title' => 'A2', ]), + new ArrayData([ 'Title' => 'A3', ]), + ] + ), + ] + ); + + $engine = new SSTemplateEngine('Includes/SSTemplateEngineTestRecursiveInclude'); + $result = $engine->render(new ViewLayerData($data)); + // We don't care about whitespace + $rationalisedResult = trim(preg_replace('/\s+/', ' ', $result ?? '') ?? ''); + + $this->assertEquals('A A1 A1 i A1 ii A2 A3', $rationalisedResult); + } + + /** + * See {@link ModelDataTest} for more extensive casting tests, + * this test just ensures that basic casting is correctly applied during template parsing. + */ + public function testCastingHelpers() + { + $vd = new SSTemplateEngineTest\TestModelData(); + $vd->TextValue = 'html'; + $vd->HTMLValue = 'html'; + $vd->UncastedValue = 'html'; + + // Value casted as "Text" + $this->assertEquals( + '<b>html</b>', + $this->render('$TextValue', $vd) + ); + $this->assertEquals( + 'html', + $this->render('$TextValue.RAW', $vd) + ); + $this->assertEquals( + '<b>html</b>', + $this->render('$TextValue.XML', $vd) + ); + + // Value casted as "HTMLText" + $this->assertEquals( + 'html', + $this->render('$HTMLValue', $vd) + ); + $this->assertEquals( + 'html', + $this->render('$HTMLValue.RAW', $vd) + ); + $this->assertEquals( + '<b>html</b>', + $this->render('$HTMLValue.XML', $vd) + ); + + // Uncasted value (falls back to the relevant DBField class for the data type) + $vd = new SSTemplateEngineTest\TestModelData(); + $vd->UncastedValue = 'html'; + $this->assertEquals( + '<b>html</b>', + $this->render('$UncastedValue', $vd) + ); + $this->assertEquals( + 'html', + $this->render('$UncastedValue.RAW', $vd) + ); + $this->assertEquals( + '<b>html</b>', + $this->render('$UncastedValue.XML', $vd) + ); + } + + public static function provideLoop(): array + { + return [ + 'nested array and iterator' => [ + 'iterable' => [ + [ + 'value 1', + 'value 2', + ], + new ArrayList([ + 'value 3', + 'value 4', + ]), + ], + 'template' => '<% loop $Iterable %><% loop $Me %>$Me<% end_loop %><% end_loop %>', + 'expected' => 'value 1 value 2 value 3 value 4', + ], + 'nested associative arrays' => [ + 'iterable' => [ + [ + 'Foo' => 'one', + ], + [ + 'Foo' => 'two', + ], + [ + 'Foo' => 'three', + ], + ], + 'template' => '<% loop $Iterable %>$Foo<% end_loop %>', + 'expected' => 'one two three', + ], + ]; + } + + #[DataProvider('provideLoop')] + public function testLoop(iterable $iterable, string $template, string $expected): void + { + $data = new ArrayData(['Iterable' => $iterable]); + $this->assertEqualIgnoringWhitespace($expected, $this->render($template, $data)); + } + + public static function provideCountIterable(): array + { + $scenarios = [ + 'empty array' => [ + 'iterable' => [], + 'inScope' => false, + ], + 'array' => [ + 'iterable' => [1, 2, 3], + 'inScope' => false, + ], + 'ArrayList' => [ + 'iterable' => new ArrayList([['Val' => 1], ['Val' => 2], ['Val' => 3]]), + 'inScope' => false, + ], + ]; + foreach ($scenarios as $name => $scenario) { + $scenario['inScope'] = true; + $scenarios[$name . ' in scope'] = $scenario; + } + return $scenarios; + } + + #[DataProvider('provideCountIterable')] + public function testCountIterable(iterable $iterable, bool $inScope): void + { + $expected = count($iterable); + $data = new ArrayData(['Iterable' => $iterable]); + if ($inScope) { + $template = '<% with $Iterable %>$Count<% end_with %>'; + } else { + $template = '$Iterable.Count'; + } + $this->assertEqualIgnoringWhitespace($expected, $this->render($template, $data)); + } + + public function testSSViewerBasicIteratorSupport() + { + $data = new ArrayData( + [ + 'Set' => new ArrayList( + [ + new SSTemplateEngineTest\TestObject("1"), + new SSTemplateEngineTest\TestObject("2"), + new SSTemplateEngineTest\TestObject("3"), + new SSTemplateEngineTest\TestObject("4"), + new SSTemplateEngineTest\TestObject("5"), + new SSTemplateEngineTest\TestObject("6"), + new SSTemplateEngineTest\TestObject("7"), + new SSTemplateEngineTest\TestObject("8"), + new SSTemplateEngineTest\TestObject("9"), + new SSTemplateEngineTest\TestObject("10"), + ] + ) + ] + ); + + //base test + $result = $this->render('<% loop Set %>$Number<% end_loop %>', $data); + $this->assertEquals("12345678910", $result, "Numbers rendered in order"); + + //test First + $result = $this->render('<% loop Set %><% if $IsFirst %>$Number<% end_if %><% end_loop %>', $data); + $this->assertEquals("1", $result, "Only the first number is rendered"); + + //test Last + $result = $this->render('<% loop Set %><% if $IsLast %>$Number<% end_if %><% end_loop %>', $data); + $this->assertEquals("10", $result, "Only the last number is rendered"); + + //test Even + $result = $this->render('<% loop Set %><% if $Even() %>$Number<% end_if %><% end_loop %>', $data); + $this->assertEquals("246810", $result, "Even numbers rendered in order"); + + //test Even with quotes + $result = $this->render('<% loop Set %><% if $Even("1") %>$Number<% end_if %><% end_loop %>', $data); + $this->assertEquals("246810", $result, "Even numbers rendered in order"); + + //test Even without quotes + $result = $this->render('<% loop Set %><% if $Even(1) %>$Number<% end_if %><% end_loop %>', $data); + $this->assertEquals("246810", $result, "Even numbers rendered in order"); + + //test Even with zero-based start index + $result = $this->render('<% loop Set %><% if $Even("0") %>$Number<% end_if %><% end_loop %>', $data); + $this->assertEquals("13579", $result, "Even (with zero-based index) numbers rendered in order"); + + //test Odd + $result = $this->render('<% loop Set %><% if $Odd %>$Number<% end_if %><% end_loop %>', $data); + $this->assertEquals("13579", $result, "Odd numbers rendered in order"); + + //test FirstLast + $result = $this->render('<% loop Set %><% if $FirstLast %>$Number$FirstLast<% end_if %><% end_loop %>', $data); + $this->assertEquals("1first10last", $result, "First and last numbers rendered in order"); + + //test Middle + $result = $this->render('<% loop Set %><% if $Middle %>$Number<% end_if %><% end_loop %>', $data); + $this->assertEquals("23456789", $result, "Middle numbers rendered in order"); + + //test MiddleString + $result = $this->render( + '<% loop Set %><% if MiddleString == "middle" %>$Number$MiddleString<% end_if %>' + . '<% end_loop %>', + $data + ); + $this->assertEquals( + "2middle3middle4middle5middle6middle7middle8middle9middle", + $result, + "Middle numbers rendered in order" + ); + + //test EvenOdd + $result = $this->render('<% loop Set %>$EvenOdd<% end_loop %>', $data); + $this->assertEquals( + "oddevenoddevenoddevenoddevenoddeven", + $result, + "Even and Odd is returned in sequence numbers rendered in order" + ); + + //test Pos + $result = $this->render('<% loop Set %>$Pos<% end_loop %>', $data); + $this->assertEquals("12345678910", $result, '$Pos is rendered in order'); + + //test Pos + $result = $this->render('<% loop Set %>$Pos(0)<% end_loop %>', $data); + $this->assertEquals("0123456789", $result, '$Pos(0) is rendered in order'); + + //test FromEnd + $result = $this->render('<% loop Set %>$FromEnd<% end_loop %>', $data); + $this->assertEquals("10987654321", $result, '$FromEnd is rendered in order'); + + //test FromEnd + $result = $this->render('<% loop Set %>$FromEnd(0)<% end_loop %>', $data); + $this->assertEquals("9876543210", $result, '$FromEnd(0) rendered in order'); + + //test Total + $result = $this->render('<% loop Set %>$TotalItems<% end_loop %>', $data); + $this->assertEquals("10101010101010101010", $result, "10 total items X 10 are returned"); + + //test Modulus + $result = $this->render('<% loop Set %>$Modulus(2,1)<% end_loop %>', $data); + $this->assertEquals("1010101010", $result, "1-indexed pos modular divided by 2 rendered in order"); + + //test MultipleOf 3 + $result = $this->render('<% loop Set %><% if MultipleOf(3) %>$Number<% end_if %><% end_loop %>', $data); + $this->assertEquals("369", $result, "Only numbers that are multiples of 3 are returned"); + + //test MultipleOf 4 + $result = $this->render('<% loop Set %><% if MultipleOf(4) %>$Number<% end_if %><% end_loop %>', $data); + $this->assertEquals("48", $result, "Only numbers that are multiples of 4 are returned"); + + //test MultipleOf 5 + $result = $this->render('<% loop Set %><% if MultipleOf(5) %>$Number<% end_if %><% end_loop %>', $data); + $this->assertEquals("510", $result, "Only numbers that are multiples of 5 are returned"); + + //test MultipleOf 10 + $result = $this->render('<% loop Set %><% if MultipleOf(10,1) %>$Number<% end_if %><% end_loop %>', $data); + $this->assertEquals("10", $result, "Only numbers that are multiples of 10 (with 1-based indexing) are returned"); + + //test MultipleOf 9 zero-based + $result = $this->render('<% loop Set %><% if MultipleOf(9,0) %>$Number<% end_if %><% end_loop %>', $data); + $this->assertEquals( + "110", + $result, + "Only numbers that are multiples of 9 with zero-based indexing are returned. (The first and last item)" + ); + + //test MultipleOf 11 + $result = $this->render('<% loop Set %><% if MultipleOf(11) %>$Number<% end_if %><% end_loop %>', $data); + $this->assertEquals("", $result, "Only numbers that are multiples of 11 are returned. I.e. nothing returned"); + } + + /** + * Test $Up works when the scope $Up refers to was entered with a "with" block + */ + public function testUpInWith() + { + + // Data to run the loop tests on - three levels deep + $data = new ArrayData( + [ + 'Name' => 'Top', + 'Foo' => new ArrayData( + [ + 'Name' => 'Foo', + 'Bar' => new ArrayData( + [ + 'Name' => 'Bar', + 'Baz' => new ArrayData( + [ + 'Name' => 'Baz' + ] + ), + 'Qux' => new ArrayData( + [ + 'Name' => 'Qux' + ] + ) + ] + ) + ] + ) + ] + ); + + // Basic functionality + $this->assertEquals( + 'BarFoo', + $this->render('<% with Foo %><% with Bar %>{$Name}{$Up.Name}<% end_with %><% end_with %>', $data) + ); + + // Two level with block, up refers to internally referenced Bar + $this->assertEquals( + 'BarTop', + $this->render('<% with Foo.Bar %>{$Name}{$Up.Name}<% end_with %>', $data) + ); + + // Stepping up & back down the scope tree + $this->assertEquals( + 'BazFooBar', + $this->render('<% with Foo.Bar.Baz %>{$Name}{$Up.Foo.Name}{$Up.Foo.Bar.Name}<% end_with %>', $data) + ); + + // Using $Up in a with block + $this->assertEquals( + 'BazTopBar', + $this->render( + '<% with Foo.Bar.Baz %>{$Name}<% with $Up %>{$Name}{$Foo.Bar.Name}<% end_with %>' + . '<% end_with %>', + $data + ) + ); + + // Stepping up & back down the scope tree with with blocks + $this->assertEquals( + 'BazTopBarTopBaz', + $this->render( + '<% with Foo.Bar.Baz %>{$Name}<% with $Up %>{$Name}<% with Foo.Bar %>{$Name}<% end_with %>' + . '{$Name}<% end_with %>{$Name}<% end_with %>', + $data + ) + ); + + // Using $Up.Up, where first $Up points to a previous scope entered using $Up, thereby skipping up to Foo + $this->assertEquals( + 'Foo', + $this->render( + '<% with Foo %><% with Bar %><% with Baz %>{$Up.Up.Name}<% end_with %><% end_with %>' + . '<% end_with %>', + $data + ) + ); + + // Using $Up as part of a lookup chain in <% with %> + $this->assertEquals( + 'Top', + $this->render('<% with Foo.Bar.Baz.Up.Qux %>{$Up.Name}<% end_with %>', $data) + ); + } + + public function testTooManyUps() + { + $this->expectException(LogicException::class); + $this->expectExceptionMessage("Up called when we're already at the top of the scope"); + $data = new ArrayData([ + 'Foo' => new ArrayData([ + 'Name' => 'Foo', + 'Bar' => new ArrayData([ + 'Name' => 'Bar' + ]) + ]) + ]); + + $this->assertEquals( + 'Foo', + $this->render('<% with Foo.Bar %>{$Up.Up.Name}<% end_with %>', $data) + ); + } + + /** + * Test $Up works when the scope $Up refers to was entered with a "loop" block + */ + public function testUpInLoop() + { + + // Data to run the loop tests on - one sequence of three items, each with a subitem + $data = new ArrayData( + [ + 'Name' => 'Top', + 'Foo' => new ArrayList( + [ + new ArrayData( + [ + 'Name' => '1', + 'Sub' => new ArrayData( + [ + 'Name' => 'Bar' + ] + ) + ] + ), + new ArrayData( + [ + 'Name' => '2', + 'Sub' => new ArrayData( + [ + 'Name' => 'Baz' + ] + ) + ] + ), + new ArrayData( + [ + 'Name' => '3', + 'Sub' => new ArrayData( + [ + 'Name' => 'Qux' + ] + ) + ] + ) + ] + ) + ] + ); + + // Make sure inside a loop, $Up refers to the current item of the loop + $this->assertEqualIgnoringWhitespace( + '111 222 333', + $this->render( + '<% loop $Foo %>$Name<% with $Sub %>$Up.Name<% end_with %>$Name<% end_loop %>', + $data + ) + ); + + // Make sure inside a loop, looping over $Up uses a separate iterator, + // and doesn't interfere with the original iterator + $this->assertEqualIgnoringWhitespace( + '1Bar123Bar1 2Baz123Baz2 3Qux123Qux3', + $this->render( + '<% loop $Foo %> + $Name + <% with $Sub %> + $Name + <% loop $Up %>$Name<% end_loop %> + $Name + <% end_with %> + $Name + <% end_loop %>', + $data + ) + ); + + // Make sure inside a loop, looping over $Up uses a separate iterator, + // and doesn't interfere with the original iterator or local lookups + $this->assertEqualIgnoringWhitespace( + '1 Bar1 123 1Bar 1 2 Baz2 123 2Baz 2 3 Qux3 123 3Qux 3', + $this->render( + '<% loop $Foo %> + $Name + <% with $Sub %> + {$Name}{$Up.Name} + <% loop $Up %>$Name<% end_loop %> + {$Up.Name}{$Name} + <% end_with %> + $Name + <% end_loop %>', + $data + ) + ); + } + + /** + * Test that nested loops restore the loop variables correctly when pushing and popping states + */ + public function testNestedLoops() + { + + // Data to run the loop tests on - one sequence of three items, one with child elements + // (of a different size to the main sequence) + $data = new ArrayData( + [ + 'Foo' => new ArrayList( + [ + new ArrayData( + [ + 'Name' => '1', + 'Children' => new ArrayList( + [ + new ArrayData( + [ + 'Name' => 'a' + ] + ), + new ArrayData( + [ + 'Name' => 'b' + ] + ), + ] + ), + ] + ), + new ArrayData( + [ + 'Name' => '2', + 'Children' => new ArrayList(), + ] + ), + new ArrayData( + [ + 'Name' => '3', + 'Children' => new ArrayList(), + ] + ), + ] + ), + ] + ); + + // Make sure that including a loop inside a loop will not destroy the internal count of + // items, checked by using "Last" + $this->assertEqualIgnoringWhitespace( + '1ab23last', + $this->render( + '<% loop $Foo %>$Name<% loop Children %>$Name<% end_loop %><% if $IsLast %>last<% end_if %>' + . '<% end_loop %>', + $data + ) + ); + } + + public function testLayout() + { + $this->useTestTheme( + __DIR__ . '/SSTemplateEngineTest', + 'layouttest', + function () { + $engine = new SSTemplateEngine('Page'); + $this->assertEquals("Foo\n\n", $engine->render(new ViewLayerData([]))); + + $engine = new SSTemplateEngine(['Shortcodes', 'Page']); + $this->assertEquals("[file_link]\n\n", $engine->render(new ViewLayerData([]))); + } + ); + } + + public static function provideRenderWithSourceFileComments(): array + { + $i = __DIR__ . '/SSTemplateEngineTest/templates/Includes'; + $f = __DIR__ . '/SSTemplateEngineTest/templates/SSTemplateEngineTestComments'; + return [ + [ + 'name' => 'SSTemplateEngineTestCommentsFullSource', + 'expected' => "" + . "" + . "" + . "" + . "\t" + . "\t" + . "" + . "", + ], + [ + 'name' => 'SSTemplateEngineTestCommentsFullSourceHTML4Doctype', + 'expected' => "" + . "" + . "" + . "" + . "\t" + . "\t" + . "" + . "", + ], + [ + 'name' => 'SSTemplateEngineTestCommentsFullSourceNoDoctype', + 'expected' => "" + . "" + . "\t" + . "\t" + . "", + ], + [ + 'name' => 'SSTemplateEngineTestCommentsFullSourceIfIE', + 'expected' => "" + . "" + . "" + . "" + . "" + . " " + . "\t" + . "\t" + . "" + . "", + ], + [ + 'name' => 'SSTemplateEngineTestCommentsFullSourceIfIENoDoctype', + 'expected' => "" + . "" + . "" + . " " + . "" + . " " + . "\t" + . "\t" + . "", + ], + [ + 'name' => 'SSTemplateEngineTestCommentsPartialSource', + 'expected' => + "" + . "
" + . "", + ], + [ + 'name' => 'SSTemplateEngineTestCommentsWithInclude', + 'expected' => + "" + . "
" + . "" + . "" + . "Included" + . "" + . "" + . "
" + . "", + ], + ]; + } + + #[DataProvider('provideRenderWithSourceFileComments')] + public function testRenderWithSourceFileComments(string $name, string $expected) + { + SSViewer::config()->set('source_file_comments', true); + $this->_renderWithSourceFileComments('SSTemplateEngineTestComments/' . $name, $expected); + } + + public function testLoopIteratorIterator() + { + $list = new PaginatedList(new ArrayList()); + $result = $this->render( + '<% loop List %>$ID - $FirstName
<% end_loop %>', + new ArrayData(['List' => $list]) + ); + $this->assertEquals('', $result); + } + + public static function provideCallsWithArguments(): array + { + return [ + [ + 'template' => '$Level.output(1)', + 'expected' => '1-1', + ], + [ + 'template' => '$Nest.Level.output($Set.First.Number)', + 'expected' => '2-1', + ], + [ + 'template' => '<% with $Set %>$Up.Level.output($First.Number)<% end_with %>', + 'expected' => '1-1', + ], + [ + 'template' => '<% with $Set %>$Top.Nest.Level.output($First.Number)<% end_with %>', + 'expected' => '2-1', + ], + [ + 'template' => '<% loop $Set %>$Up.Nest.Level.output($Number)<% end_loop %>', + 'expected' => '2-12-22-32-42-5', + ], + [ + 'template' => '<% loop $Set %>$Top.Level.output($Number)<% end_loop %>', + 'expected' => '1-11-21-31-41-5', + ], + [ + 'template' => '<% with $Nest %>$Level.output($Top.Set.First.Number)<% end_with %>', + 'expected' => '2-1', + ], + [ + 'template' => '<% with $Level %>$output($Up.Set.Last.Number)<% end_with %>', + 'expected' => '1-5', + ], + [ + 'template' => '<% with $Level.forWith($Set.Last.Number) %>$output("hi")<% end_with %>', + 'expected' => '5-hi', + ], + [ + 'template' => '<% loop $Level.forLoop($Set.First.Number) %>$Number<% end_loop %>', + 'expected' => '!0', + ], + [ + 'template' => '<% with $Nest %> + <% with $Level.forWith($Up.Set.First.Number) %>$output("hi")<% end_with %> + <% end_with %>', + 'expected' => '1-hi', + ], + [ + 'template' => '<% with $Nest %> + <% loop $Level.forLoop($Top.Set.Last.Number) %>$Number<% end_loop %> + <% end_with %>', + 'expected' => '!0!1!2!3!4', + ], + ]; + } + + #[DataProvider('provideCallsWithArguments')] + public function testCallsWithArguments(string $template, string $expected): void + { + $data = new ArrayData( + [ + 'Set' => new ArrayList( + [ + new SSTemplateEngineTest\TestObject("1"), + new SSTemplateEngineTest\TestObject("2"), + new SSTemplateEngineTest\TestObject("3"), + new SSTemplateEngineTest\TestObject("4"), + new SSTemplateEngineTest\TestObject("5"), + ] + ), + 'Level' => new SSTemplateEngineTest\LevelTestData(1), + 'Nest' => [ + 'Level' => new SSTemplateEngineTest\LevelTestData(2), + ], + ] + ); + + $this->assertEquals($expected, trim($this->render($template, $data) ?? '')); + } + + public function testRepeatedCallsAreCached() + { + $data = new SSTemplateEngineTest\CacheTestData(); + $template = ' + <% if $TestWithCall %> + <% with $TestWithCall %> + {$Message} + <% end_with %> + + {$TestWithCall.Message} + <% end_if %>'; + + $this->assertEquals('HiHi', preg_replace('/\s+/', '', $this->render($template, $data) ?? '')); + $this->assertEquals( + 1, + $data->testWithCalls, + 'SSTemplateEngineTest_CacheTestData::TestWithCall() should only be called once. Subsequent calls should be cached' + ); + + $data = new SSTemplateEngineTest\CacheTestData(); + $template = ' + <% if $TestLoopCall %> + <% loop $TestLoopCall %> + {$Message} + <% end_loop %> + <% end_if %>'; + + $this->assertEquals('OneTwo', preg_replace('/\s+/', '', $this->render($template, $data) ?? '')); + $this->assertEquals( + 1, + $data->testLoopCalls, + 'SSTemplateEngineTest_CacheTestData::TestLoopCall() should only be called once. Subsequent calls should be cached' + ); + } + + public function testClosedBlockExtension() + { + $count = 0; + $parser = new SSTemplateParser(); + $parser->addClosedBlock( + 'test', + function () use (&$count) { + $count++; + } + ); + + $engine = new SSTemplateEngine('SSTemplateEngineTestRecursiveInclude'); + $engine->setParser($parser); + $engine->renderString('<% test %><% end_test %>', new ViewLayerData([])); + + $this->assertEquals(1, $count); + } + + public function testOpenBlockExtension() + { + $count = 0; + $parser = new SSTemplateParser(); + $parser->addOpenBlock( + 'test', + function () use (&$count) { + $count++; + } + ); + + $engine = new SSTemplateEngine('SSTemplateEngineTestRecursiveInclude'); + $engine->setParser($parser); + $engine->renderString('<% test %>', new ViewLayerData([])); + + $this->assertEquals(1, $count); + } + + /** + * Tests if caching for SSViewer_FromString is working + */ + public function testFromStringCaching() + { + $content = 'Test content'; + $cacheFile = TEMP_PATH . DIRECTORY_SEPARATOR . '.cache.' . sha1($content ?? ''); + if (file_exists($cacheFile ?? '')) { + unlink($cacheFile ?? ''); + } + + // Test instance behaviors + $this->render($content, null, false); + $this->assertFalse(file_exists($cacheFile ?? ''), 'Cache file was created when caching was off'); + + $this->render($content, null, true); + $this->assertTrue(file_exists($cacheFile ?? ''), 'Cache file wasn\'t created when it was meant to'); + unlink($cacheFile ?? ''); + } + + public function testPrimitivesConvertedToDBFields() + { + $data = new ArrayData([ + // null value should not be rendered, though should also not throw exception + 'Foo' => new ArrayList(['hello', true, 456, 7.89, null]) + ]); + $this->assertEqualIgnoringWhitespace( + 'hello 1 456 7.89', + $this->render('<% loop $Foo %>$Me<% end_loop %>', $data) + ); + } + + #[DoesNotPerformAssertions] + public function testMe(): void + { + $myArrayData = new class extends ArrayData { + public function forTemplate(): string + { + return ''; + } + }; + $this->render('$Me', $myArrayData); + } + + public function testLoopingThroughArrayInOverlay(): void + { + $modelData = new ModelData(); + $theArray = [ + ['Val' => 'one'], + ['Val' => 'two'], + ['Val' => 'red'], + ['Val' => 'blue'], + ]; + $engine = new SSTemplateEngine('SSTemplateEngineTestLoopArray'); + $output = $engine->render(new ViewLayerData($modelData), ['MyArray' => $theArray]); + $this->assertEqualIgnoringWhitespace('one two red blue', $output); + } + + public static function provideGetterMethod(): array + { + return [ + 'as property (not getter)' => [ + 'template' => '$MyProperty', + 'expected' => 'Nothing passed in', + ], + 'as method (not getter)' => [ + 'template' => '$MyProperty()', + 'expected' => 'Nothing passed in', + ], + 'as method (not getter), with arg' => [ + 'template' => '$MyProperty("Some Value")', + 'expected' => 'Was passed in: Some Value', + ], + 'as property (getter)' => [ + 'template' => '$getMyProperty', + 'expected' => 'Nothing passed in', + ], + 'as method (getter)' => [ + 'template' => '$getMyProperty()', + 'expected' => 'Nothing passed in', + ], + 'as method (getter), with arg' => [ + 'template' => '$getMyProperty("Some Value")', + 'expected' => 'Was passed in: Some Value', + ], + ]; + } + + #[DataProvider('provideGetterMethod')] + public function testGetterMethod(string $template, string $expected): void + { + $model = new SSTemplateEngineTest\TestObject(); + $this->assertSame($expected, $this->render($template, $model)); + } + + /** + * Small helper to render templates from strings + */ + private function render(string $templateString, mixed $data = null, bool $cacheTemplate = false): string + { + $engine = new SSTemplateEngine(); + if (!$data) { + $data = new SSTemplateEngineTest\TestFixture(); + } + $data = new ViewLayerData($data); + return trim('' . $engine->renderString($templateString, $data, cache: $cacheTemplate)); + } + + private function _renderWithSourceFileComments($name, $expected) + { + $viewer = new SSViewer([$name]); + $data = new ArrayData([]); + $result = $viewer->process($data); + $expected = str_replace(["\r", "\n"], '', $expected ?? ''); + $result = str_replace(["\r", "\n"], '', $result ?? ''); + $this->assertEquals($result, $expected); + } + + private function getScopeInheritanceTestData() + { + return new ArrayData([ + 'Title' => 'TopTitleValue', + 'Items' => new ArrayList([ + new ArrayData(['Title' => 'Item 1']), + new ArrayData(['Title' => 'Item 2']), + new ArrayData(['Title' => 'Item 3']), + new ArrayData(['Title' => 'Item 4']), + new ArrayData(['Title' => 'Item 5']), + new ArrayData(['Title' => 'Item 6']) + ]) + ]); + } + + private function assertExpectedStrings($result, $expected) + { + foreach ($expected as $expectedStr) { + $this->assertTrue( + (boolean) preg_match("/{$expectedStr}/", $result ?? ''), + "Didn't find '{$expectedStr}' in:\n{$result}" + ); + } + } + + private function assertEqualIgnoringWhitespace($a, $b, $message = '') + { + $this->assertEquals(preg_replace('/\s+/', '', $a ?? ''), preg_replace('/\s+/', '', $b ?? ''), $message); + } +} diff --git a/tests/php/View/SSViewerTest/CacheTestData.php b/tests/php/View/SSTemplateEngineTest/CacheTestData.php similarity index 92% rename from tests/php/View/SSViewerTest/CacheTestData.php rename to tests/php/View/SSTemplateEngineTest/CacheTestData.php index 3be03ae74..b155b9826 100644 --- a/tests/php/View/SSViewerTest/CacheTestData.php +++ b/tests/php/View/SSTemplateEngineTest/CacheTestData.php @@ -1,6 +1,6 @@ name = $name; + } + + public function __call(string $name, array $arguments = []): static|array|null + { + return $this->getValue($name, $arguments); + } + + public function __get(string $name): static|array|null + { + return $this->getValue($name); + } + + public function __isset(string $name): bool + { + if (preg_match('/NotSet/i', $name)) { + return false; + } + $reflectionScope = new ReflectionClass(SSViewer_Scope::class); + $globalProperties = $reflectionScope->getStaticPropertyValue('globalProperties'); + if (array_key_exists($name, $globalProperties)) { + return false; + } + return true; + } + + public function __toString(): string + { + if (preg_match('/NotSet/i', $this->name ?? '')) { + return ''; + } + if (preg_match('/Raw/i', $this->name ?? '')) { + return $this->name ?? ''; + } + return '[out:' . $this->name . ']'; + } + + private function getValue(string $name, array $arguments = []): static|array|null + { + $childName = $this->argedName($name, $arguments); + + // Special field name Loop### to create a list + if (preg_match('/^Loop([0-9]+)$/', $name ?? '', $matches)) { + $output = []; + for ($i = 0; $i < $matches[1]; $i++) { + $output[] = new TestFixture($childName); + } + return $output; + } + + if (preg_match('/NotSet/i', $name)) { + return null; + } + + return new TestFixture($childName); + } + + private function argedName(string $fieldName, array $arguments): string + { + $childName = $this->name ? "$this->name.$fieldName" : $fieldName; + if ($arguments) { + return $childName . '(' . implode(',', $arguments) . ')'; + } else { + return $childName; + } + } +} diff --git a/tests/php/View/SSTemplateEngineTest/TestGlobalProvider.php b/tests/php/View/SSTemplateEngineTest/TestGlobalProvider.php new file mode 100644 index 000000000..6896f43ba --- /dev/null +++ b/tests/php/View/SSTemplateEngineTest/TestGlobalProvider.php @@ -0,0 +1,51 @@ + ['method' => 'get_html', 'casting' => 'HTMLFragment'], + 'SSTemplateEngineTest_GlobalHTMLEscaped' => ['method' => 'get_html'], + + 'SSTemplateEngineTest_GlobalAutomatic', + 'SSTemplateEngineTest_GlobalReferencedByString' => 'get_reference', + 'SSTemplateEngineTest_GlobalReferencedInArray' => ['method' => 'get_reference'], + + 'SSTemplateEngineTest_GlobalThatTakesArguments' => ['method' => 'get_argmix', 'casting' => 'HTMLFragment'], + 'SSTemplateEngineTest_GlobalReturnsNull' => 'getNull', + ]; + } + + public static function get_html() + { + return '
'; + } + + public static function SSTemplateEngineTest_GlobalAutomatic() + { + return 'automatic'; + } + + public static function get_reference() + { + return 'reference'; + } + + public static function get_argmix() + { + $args = func_get_args(); + return 'z' . implode(':', $args) . 'z'; + } + + public static function getNull() + { + return null; + } +} diff --git a/tests/php/View/SSViewerTest/TestObject.php b/tests/php/View/SSTemplateEngineTest/TestObject.php similarity index 70% rename from tests/php/View/SSViewerTest/TestObject.php rename to tests/php/View/SSTemplateEngineTest/TestObject.php index dc0d948b4..5698fcf38 100644 --- a/tests/php/View/SSViewerTest/TestObject.php +++ b/tests/php/View/SSTemplateEngineTest/TestObject.php @@ -1,13 +1,13 @@ <% loop Children %> -<% include SSViewerTestRecursiveInclude %> +<% include SSTemplateEngineTestRecursiveInclude %> <% end_loop %> <% end_if %> diff --git a/tests/php/View/SSViewerTest/templates/Includes/SSViewerTestTypePreservation.ss b/tests/php/View/SSTemplateEngineTest/templates/Includes/SSTemplateEngineTestTypePreservation.ss similarity index 100% rename from tests/php/View/SSViewerTest/templates/Includes/SSViewerTestTypePreservation.ss rename to tests/php/View/SSTemplateEngineTest/templates/Includes/SSTemplateEngineTestTypePreservation.ss diff --git a/tests/php/View/SSViewerTest/templates/Namespace/IncludedOnceBase.ss b/tests/php/View/SSTemplateEngineTest/templates/Namespace/IncludedOnceBase.ss similarity index 100% rename from tests/php/View/SSViewerTest/templates/Namespace/IncludedOnceBase.ss rename to tests/php/View/SSTemplateEngineTest/templates/Namespace/IncludedOnceBase.ss diff --git a/tests/php/View/SSViewerTest/templates/Namespace/IncludedTwice.ss b/tests/php/View/SSTemplateEngineTest/templates/Namespace/IncludedTwice.ss similarity index 100% rename from tests/php/View/SSViewerTest/templates/Namespace/IncludedTwice.ss rename to tests/php/View/SSTemplateEngineTest/templates/Namespace/IncludedTwice.ss diff --git a/tests/php/View/SSViewerTest/templates/Namespace/Includes/IncludedOnceSub.ss b/tests/php/View/SSTemplateEngineTest/templates/Namespace/Includes/IncludedOnceSub.ss similarity index 100% rename from tests/php/View/SSViewerTest/templates/Namespace/Includes/IncludedOnceSub.ss rename to tests/php/View/SSTemplateEngineTest/templates/Namespace/Includes/IncludedOnceSub.ss diff --git a/tests/php/View/SSViewerTest/templates/Namespace/Includes/IncludedTwice.ss b/tests/php/View/SSTemplateEngineTest/templates/Namespace/Includes/IncludedTwice.ss similarity index 100% rename from tests/php/View/SSViewerTest/templates/Namespace/Includes/IncludedTwice.ss rename to tests/php/View/SSTemplateEngineTest/templates/Namespace/Includes/IncludedTwice.ss diff --git a/tests/php/View/SSViewerTest/templates/Namespace/Includes/NamespaceInclude.ss b/tests/php/View/SSTemplateEngineTest/templates/Namespace/Includes/NamespaceInclude.ss similarity index 100% rename from tests/php/View/SSViewerTest/templates/Namespace/Includes/NamespaceInclude.ss rename to tests/php/View/SSTemplateEngineTest/templates/Namespace/Includes/NamespaceInclude.ss diff --git a/tests/php/View/SSViewerTest/templates/RSSFeedTest.ss b/tests/php/View/SSTemplateEngineTest/templates/RSSFeedTest.ss similarity index 100% rename from tests/php/View/SSViewerTest/templates/RSSFeedTest.ss rename to tests/php/View/SSTemplateEngineTest/templates/RSSFeedTest.ss diff --git a/tests/php/View/SSViewerTest/templates/RequirementsTest_Conditionals.ss b/tests/php/View/SSTemplateEngineTest/templates/RequirementsTest_Conditionals.ss similarity index 100% rename from tests/php/View/SSViewerTest/templates/RequirementsTest_Conditionals.ss rename to tests/php/View/SSTemplateEngineTest/templates/RequirementsTest_Conditionals.ss diff --git a/tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsFullSource.ss b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsFullSource.ss similarity index 100% rename from tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsFullSource.ss rename to tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsFullSource.ss diff --git a/tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsFullSourceHTML4Doctype.ss b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsFullSourceHTML4Doctype.ss similarity index 100% rename from tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsFullSourceHTML4Doctype.ss rename to tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsFullSourceHTML4Doctype.ss diff --git a/tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsFullSourceIfIE.ss b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsFullSourceIfIE.ss similarity index 100% rename from tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsFullSourceIfIE.ss rename to tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsFullSourceIfIE.ss diff --git a/tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsFullSourceIfIENoDoctype.ss b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsFullSourceIfIENoDoctype.ss similarity index 100% rename from tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsFullSourceIfIENoDoctype.ss rename to tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsFullSourceIfIENoDoctype.ss diff --git a/tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsFullSourceNoDoctype.ss b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsFullSourceNoDoctype.ss similarity index 100% rename from tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsFullSourceNoDoctype.ss rename to tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsFullSourceNoDoctype.ss diff --git a/tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsPartialSource.ss b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsPartialSource.ss similarity index 100% rename from tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsPartialSource.ss rename to tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsPartialSource.ss diff --git a/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsWithInclude.ss b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsWithInclude.ss new file mode 100644 index 000000000..a3a494945 --- /dev/null +++ b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestComments/SSTemplateEngineTestCommentsWithInclude.ss @@ -0,0 +1 @@ +
<% include SSTemplateEngineTestCommentsInclude %>
diff --git a/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestIncludeScopeInheritance.ss b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestIncludeScopeInheritance.ss new file mode 100644 index 000000000..f588c9d46 --- /dev/null +++ b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestIncludeScopeInheritance.ss @@ -0,0 +1,3 @@ +<% loop Items %> + <% include SSTemplateEngineTestIncludeScopeInheritanceInclude %> +<% end_loop %> diff --git a/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestIncludeScopeInheritanceWithArgs.ss b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestIncludeScopeInheritanceWithArgs.ss new file mode 100644 index 000000000..772f76ae4 --- /dev/null +++ b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestIncludeScopeInheritanceWithArgs.ss @@ -0,0 +1,3 @@ +<% loop Items %> + <% include SSTemplateEngineTestIncludeScopeInheritanceInclude ArgA=$Title %> +<% end_loop %> diff --git a/tests/php/View/SSViewerTest/templates/SSViewerTestLoopArray.ss b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestLoopArray.ss similarity index 100% rename from tests/php/View/SSViewerTest/templates/SSViewerTestLoopArray.ss rename to tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestLoopArray.ss diff --git a/tests/php/View/SSViewerTest/templates/SSViewerTestPartialTemplate.ss b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestPartialTemplate.ss similarity index 100% rename from tests/php/View/SSViewerTest/templates/SSViewerTestPartialTemplate.ss rename to tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestPartialTemplate.ss diff --git a/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestProcess.ss b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestProcess.ss new file mode 100644 index 000000000..7486f81db --- /dev/null +++ b/tests/php/View/SSTemplateEngineTest/templates/SSTemplateEngineTestProcess.ss @@ -0,0 +1,6 @@ + + <% include SSTemplateEngineTestProcessHead %> + + + + diff --git a/tests/php/View/SSViewerTest/themes/layouttest/templates/Controller.ss b/tests/php/View/SSTemplateEngineTest/themes/layouttest/templates/Controller.ss similarity index 100% rename from tests/php/View/SSViewerTest/themes/layouttest/templates/Controller.ss rename to tests/php/View/SSTemplateEngineTest/themes/layouttest/templates/Controller.ss diff --git a/tests/php/View/SSViewerTest/themes/layouttest/templates/Layout/Page.ss b/tests/php/View/SSTemplateEngineTest/themes/layouttest/templates/Layout/Page.ss similarity index 100% rename from tests/php/View/SSViewerTest/themes/layouttest/templates/Layout/Page.ss rename to tests/php/View/SSTemplateEngineTest/themes/layouttest/templates/Layout/Page.ss diff --git a/tests/php/View/SSViewerTest/themes/layouttest/templates/Layout/Shortcodes.ss b/tests/php/View/SSTemplateEngineTest/themes/layouttest/templates/Layout/Shortcodes.ss similarity index 100% rename from tests/php/View/SSViewerTest/themes/layouttest/templates/Layout/Shortcodes.ss rename to tests/php/View/SSTemplateEngineTest/themes/layouttest/templates/Layout/Shortcodes.ss diff --git a/tests/php/View/SSViewerTest/themes/layouttest/templates/Page.ss b/tests/php/View/SSTemplateEngineTest/themes/layouttest/templates/Page.ss similarity index 100% rename from tests/php/View/SSViewerTest/themes/layouttest/templates/Page.ss rename to tests/php/View/SSTemplateEngineTest/themes/layouttest/templates/Page.ss diff --git a/tests/php/View/SSTemplateEngineTest/themes/layouttest/templates/TestNamespace/SSTemplateEngineTestModel_Controller.ss b/tests/php/View/SSTemplateEngineTest/themes/layouttest/templates/TestNamespace/SSTemplateEngineTestModel_Controller.ss new file mode 100644 index 000000000..b3b85b793 --- /dev/null +++ b/tests/php/View/SSTemplateEngineTest/themes/layouttest/templates/TestNamespace/SSTemplateEngineTestModel_Controller.ss @@ -0,0 +1 @@ +SSTemplateEngineTest diff --git a/tests/php/View/SSViewerTest.php b/tests/php/View/SSViewerTest.php index d9de2385f..3bdcec27b 100644 --- a/tests/php/View/SSViewerTest.php +++ b/tests/php/View/SSViewerTest.php @@ -2,69 +2,19 @@ namespace SilverStripe\View\Tests; -use Exception; -use InvalidArgumentException; -use LogicException; -use PHPUnit\Framework\MockObject\MockObject; -use Silverstripe\Assets\Dev\TestAssetStore; -use SilverStripe\Control\ContentNegotiator; use SilverStripe\Control\Controller; -use SilverStripe\Control\Director; -use SilverStripe\Control\HTTPResponse; use SilverStripe\Core\Convert; -use SilverStripe\Core\Injector\Injector; use SilverStripe\Dev\SapphireTest; -use SilverStripe\i18n\i18n; -use SilverStripe\Model\List\ArrayList; use SilverStripe\ORM\DataObject; -use SilverStripe\ORM\FieldType\DBField; -use SilverStripe\Model\List\PaginatedList; -use SilverStripe\Security\Permission; -use SilverStripe\Security\Security; -use SilverStripe\Security\SecurityToken; -use SilverStripe\Model\ArrayData; use SilverStripe\View\Requirements; -use SilverStripe\View\Requirements_Backend; -use SilverStripe\View\SSTemplateParseException; -use SilverStripe\View\SSTemplateParser; use SilverStripe\View\SSViewer; -use SilverStripe\View\SSViewer_FromString; use SilverStripe\View\Tests\SSViewerTest\SSViewerTestModel; use SilverStripe\View\Tests\SSViewerTest\SSViewerTestModelController; -use SilverStripe\View\Tests\SSViewerTest\TestModelData; -use SilverStripe\Model\ModelData; -use PHPUnit\Framework\Attributes\DataProvider; -use PHPUnit\Framework\Attributes\DoesNotPerformAssertions; +use SilverStripe\View\Tests\SSViewerTest\DummyTemplateEngine; class SSViewerTest extends SapphireTest { - - /** - * Backup of $_SERVER global - * - * @var array - */ - protected $oldServer = []; - - protected static $extra_dataobjects = [ - SSViewerTest\TestObject::class, - ]; - - protected function setUp(): void - { - parent::setUp(); - SSViewer::config()->set('source_file_comments', false); - SSViewer_FromString::config()->set('cache_template', false); - TestAssetStore::activate('SSViewerTest'); - $this->oldServer = $_SERVER; - } - - protected function tearDown(): void - { - $_SERVER = $this->oldServer; - TestAssetStore::reset(); - parent::tearDown(); - } + protected $usesDatabase = false; /** * Tests for themes helper functions, ensuring they behave as defined in the RFC at @@ -85,1786 +35,28 @@ class SSViewerTest extends SapphireTest $this->assertEquals(['mytheme', 'my_more_important_theme', '$default'], SSViewer::get_themes()); } - /** - * Test that a template without a tag still renders. - */ - public function testTemplateWithoutHeadRenders() + public function testRequirementsInjected() { - $data = new ArrayData([ 'Var' => 'var value' ]); - $result = $data->renderWith("SSViewerTestPartialTemplate"); - $this->assertEquals('Test partial template: var value', trim(preg_replace("//U", '', $result ?? '') ?? '')); - } + Requirements::clear(); - /** - * Ensure global methods aren't executed - */ - public function testTemplateExecution() - { - $data = new ArrayData([ 'Var' => 'phpinfo' ]); - $result = $data->renderWith("SSViewerTestPartialTemplate"); - $this->assertEquals('Test partial template: phpinfo', trim(preg_replace("//U", '', $result ?? '') ?? '')); - } - - public function testIncludeScopeInheritance() - { - $data = $this->getScopeInheritanceTestData(); - $expected = [ - 'Item 1 - First-ODD top:Item 1', - 'Item 2 - EVEN top:Item 2', - 'Item 3 - ODD top:Item 3', - 'Item 4 - EVEN top:Item 4', - 'Item 5 - ODD top:Item 5', - 'Item 6 - Last-EVEN top:Item 6', - ]; - - $result = $data->renderWith('SSViewerTestIncludeScopeInheritance'); - $this->assertExpectedStrings($result, $expected); - - // reset results for the tests that include arguments (the title is passed as an arg) - $expected = [ - 'Item 1 _ Item 1 - First-ODD top:Item 1', - 'Item 2 _ Item 2 - EVEN top:Item 2', - 'Item 3 _ Item 3 - ODD top:Item 3', - 'Item 4 _ Item 4 - EVEN top:Item 4', - 'Item 5 _ Item 5 - ODD top:Item 5', - 'Item 6 _ Item 6 - Last-EVEN top:Item 6', - ]; - - $result = $data->renderWith('SSViewerTestIncludeScopeInheritanceWithArgs'); - $this->assertExpectedStrings($result, $expected); - } - - public function testIncludeTruthyness() - { - $data = new ArrayData([ - 'Title' => 'TruthyTest', - 'Items' => new ArrayList([ - new ArrayData(['Title' => 'Item 1']), - new ArrayData(['Title' => '']), - new ArrayData(['Title' => true]), - new ArrayData(['Title' => false]), - new ArrayData(['Title' => null]), - new ArrayData(['Title' => 0]), - new ArrayData(['Title' => 7]) - ]) - ]); - $result = $data->renderWith('SSViewerTestIncludeScopeInheritanceWithArgs'); - - // We should not end up with empty values appearing as empty - $expected = [ - 'Item 1 _ Item 1 - First-ODD top:Item 1', - 'Untitled - EVEN top:', - '1 _ 1 - ODD top:1', - 'Untitled - EVEN top:', - 'Untitled - ODD top:', - 'Untitled - EVEN top:0', - '7 _ 7 - Last-ODD top:7', - ]; - $this->assertExpectedStrings($result, $expected); - } - - private function getScopeInheritanceTestData() - { - return new ArrayData([ - 'Title' => 'TopTitleValue', - 'Items' => new ArrayList([ - new ArrayData(['Title' => 'Item 1']), - new ArrayData(['Title' => 'Item 2']), - new ArrayData(['Title' => 'Item 3']), - new ArrayData(['Title' => 'Item 4']), - new ArrayData(['Title' => 'Item 5']), - new ArrayData(['Title' => 'Item 6']) - ]) - ]); - } - - private function assertExpectedStrings($result, $expected) - { - foreach ($expected as $expectedStr) { - $this->assertTrue( - (boolean) preg_match("/{$expectedStr}/", $result ?? ''), - "Didn't find '{$expectedStr}' in:\n{$result}" - ); + try { + Requirements::customCSS('pretend this is real css'); + $viewer = new SSViewer([], new DummyTemplateEngine()); + $result1 = $viewer->process('pretend this is a model')->getValue(); + // if we disable the requirements then we should get nothing + $viewer->includeRequirements(false); + $result2 = $viewer->process('pretend this is a model')->getValue(); + } finally { + Requirements::restore(); } - } - /** - * Small helper to render templates from strings - * - * @param string $templateString - * @param null $data - * @param bool $cacheTemplate - * @return string - */ - public function render($templateString, $data = null, $cacheTemplate = false) - { - $t = SSViewer::fromString($templateString, $cacheTemplate); - if (!$data) { - $data = new SSViewerTest\TestFixture(); - } - return trim('' . $t->process($data)); - } - - public function testRequirements() - { - /** @var Requirements_Backend|MockObject $requirements */ - $requirements = $this - ->getMockBuilder(Requirements_Backend::class) - ->onlyMethods(["javascript", "css"]) - ->getMock(); - $jsFile = FRAMEWORK_DIR . '/tests/forms/a.js'; - $cssFile = FRAMEWORK_DIR . '/tests/forms/a.js'; - - $requirements->expects($this->once())->method('javascript')->with($jsFile); - $requirements->expects($this->once())->method('css')->with($cssFile); - - $origReq = Requirements::backend(); - Requirements::set_backend($requirements); - $template = $this->render( - "<% require javascript($jsFile) %> - <% require css($cssFile) %>" - ); - Requirements::set_backend($origReq); - - $this->assertFalse((bool)trim($template ?? ''), "Should be no content in this return."); - } - - public function testRequirementsCombine() - { - /** @var Requirements_Backend $testBackend */ - $testBackend = Injector::inst()->create(Requirements_Backend::class); - $testBackend->setSuffixRequirements(false); - $testBackend->setCombinedFilesEnabled(true); - - //$combinedTestFilePath = BASE_PATH . '/' . $testBackend->getCombinedFilesFolder() . '/testRequirementsCombine.js'; - - $jsFile = $this->getCurrentRelativePath() . '/SSViewerTest/javascript/bad.js'; - $jsFileContents = file_get_contents(BASE_PATH . '/' . $jsFile); - $testBackend->combineFiles('testRequirementsCombine.js', [$jsFile]); - - // secondly, make sure that requirements is generated, even though minification failed - $testBackend->processCombinedFiles(); - $js = array_keys($testBackend->getJavascript() ?? []); - $combinedTestFilePath = Director::publicFolder() . reset($js); - $this->assertStringContainsString('_combinedfiles/testRequirementsCombine-4c0e97a.js', $combinedTestFilePath); - - // and make sure the combined content matches the input content, i.e. no loss of functionality - if (!file_exists($combinedTestFilePath ?? '')) { - $this->fail('No combined file was created at expected path: ' . $combinedTestFilePath); - } - $combinedTestFileContents = file_get_contents($combinedTestFilePath ?? ''); - $this->assertStringContainsString($jsFileContents, $combinedTestFileContents); - } - - public function testComments() - { - $input = <<This is some content<%-- this is another comment --%>Final content -<%-- Alone multi - line comment --%> -Some more content -Mixing content and <%-- multi - line comment --%> Final final -content -<%--commentwithoutwhitespace--%>last content -SS; - $actual = $this->render($input); - $expected = <<assertEquals($expected, $actual); - - $input = <<empty comment1 -<%-- --%>empty comment2 -<%----%>empty comment3 -SS; - $actual = $this->render($input); - $expected = <<assertEquals($expected, $actual); - } - - public function testBasicText() - { - $this->assertEquals('"', $this->render('"'), 'Double-quotes are left alone'); - $this->assertEquals("'", $this->render("'"), 'Single-quotes are left alone'); - $this->assertEquals('A', $this->render('\\A'), 'Escaped characters are unescaped'); - $this->assertEquals('\\A', $this->render('\\\\A'), 'Escaped back-slashed are correctly unescaped'); - } - - public function testBasicInjection() - { - $this->assertEquals('[out:Test]', $this->render('$Test'), 'Basic stand-alone injection'); - $this->assertEquals('[out:Test]', $this->render('{$Test}'), 'Basic stand-alone wrapped injection'); - $this->assertEquals('A[out:Test]!', $this->render('A$Test!'), 'Basic surrounded injection'); - $this->assertEquals('A[out:Test]B', $this->render('A{$Test}B'), 'Basic surrounded wrapped injection'); - - $this->assertEquals('A$B', $this->render('A\\$B'), 'No injection as $ escaped'); - $this->assertEquals('A$ B', $this->render('A$ B'), 'No injection as $ not followed by word character'); - $this->assertEquals('A{$ B', $this->render('A{$ B'), 'No injection as {$ not followed by word character'); - - $this->assertEquals('{$Test}', $this->render('{\\$Test}'), 'Escapes can be used to avoid injection'); - $this->assertEquals( - '{\\[out:Test]}', - $this->render('{\\\\$Test}'), - 'Escapes before injections are correctly unescaped' - ); - } - - public function testBasicInjectionMismatchedBrackets() - { - $this->expectException(SSTemplateParseException::class); - $this->expectExceptionMessageMatches('/Malformed bracket injection {\$Value(.*)/'); - $this->render('A {$Value here'); - $this->fail("Parser didn't error when encountering mismatched brackets in an injection"); - } - - public function testGlobalVariableCalls() - { - $this->assertEquals('automatic', $this->render('$SSViewerTest_GlobalAutomatic')); - $this->assertEquals('reference', $this->render('$SSViewerTest_GlobalReferencedByString')); - $this->assertEquals('reference', $this->render('$SSViewerTest_GlobalReferencedInArray')); - } - - public function testGlobalVariableCallsWithArguments() - { - $this->assertEquals('zz', $this->render('$SSViewerTest_GlobalThatTakesArguments')); - $this->assertEquals('zFooz', $this->render('$SSViewerTest_GlobalThatTakesArguments("Foo")')); - $this->assertEquals( - 'zFoo:Bar:Bazz', - $this->render('$SSViewerTest_GlobalThatTakesArguments("Foo", "Bar", "Baz")') - ); - $this->assertEquals( - 'zreferencez', - $this->render('$SSViewerTest_GlobalThatTakesArguments($SSViewerTest_GlobalReferencedByString)') - ); - } - - public function testGlobalVariablesAreEscaped() - { - $this->assertEquals('
', $this->render('$SSViewerTest_GlobalHTMLFragment')); - $this->assertEquals('<div></div>', $this->render('$SSViewerTest_GlobalHTMLEscaped')); - - $this->assertEquals( - 'z
z', - $this->render('$SSViewerTest_GlobalThatTakesArguments($SSViewerTest_GlobalHTMLFragment)') - ); - $this->assertEquals( - 'z<div></div>z', - $this->render('$SSViewerTest_GlobalThatTakesArguments($SSViewerTest_GlobalHTMLEscaped)') - ); - } - - public function testGlobalVariablesReturnNull() - { - $this->assertEquals('

', $this->render('

$SSViewerTest_GlobalReturnsNull

')); - $this->assertEquals('

', $this->render('

$SSViewerTest_GlobalReturnsNull.Chained.Properties

')); - } - - public function testCoreGlobalVariableCalls() - { - $this->assertEquals( - Director::absoluteBaseURL(), - $this->render('{$absoluteBaseURL}'), - 'Director::absoluteBaseURL can be called from within template' - ); - $this->assertEquals( - Director::absoluteBaseURL(), - $this->render('{$AbsoluteBaseURL}'), - 'Upper-case %AbsoluteBaseURL can be called from within template' - ); - - $this->assertEquals( - Director::is_ajax(), - $this->render('{$isAjax}'), - 'All variations of is_ajax result in the correct call' - ); - $this->assertEquals( - Director::is_ajax(), - $this->render('{$IsAjax}'), - 'All variations of is_ajax result in the correct call' - ); - $this->assertEquals( - Director::is_ajax(), - $this->render('{$is_ajax}'), - 'All variations of is_ajax result in the correct call' - ); - $this->assertEquals( - Director::is_ajax(), - $this->render('{$Is_ajax}'), - 'All variations of is_ajax result in the correct call' - ); - - $this->assertEquals( - i18n::get_locale(), - $this->render('{$i18nLocale}'), - 'i18n template functions result correct result' - ); - $this->assertEquals( - i18n::get_locale(), - $this->render('{$get_locale}'), - 'i18n template functions result correct result' - ); - - $this->assertEquals( - (string)Security::getCurrentUser(), - $this->render('{$CurrentMember}'), - 'Member template functions result correct result' - ); - $this->assertEquals( - (string)Security::getCurrentUser(), - $this->render('{$CurrentUser}'), - 'Member template functions result correct result' - ); - $this->assertEquals( - (string)Security::getCurrentUser(), - $this->render('{$currentMember}'), - 'Member template functions result correct result' - ); - $this->assertEquals( - (string)Security::getCurrentUser(), - $this->render('{$currentUser}'), - 'Member template functions result correct result' - ); - - $this->assertEquals( - SecurityToken::getSecurityID(), - $this->render('{$getSecurityID}'), - 'SecurityToken template functions result correct result' - ); - $this->assertEquals( - SecurityToken::getSecurityID(), - $this->render('{$SecurityID}'), - 'SecurityToken template functions result correct result' - ); - - $this->assertEquals( - Permission::check("ADMIN"), - (bool)$this->render('{$HasPerm(\'ADMIN\')}'), - 'Permissions template functions result correct result' - ); - $this->assertEquals( - Permission::check("ADMIN"), - (bool)$this->render('{$hasPerm(\'ADMIN\')}'), - 'Permissions template functions result correct result' - ); - } - - public function testNonFieldCastingHelpersNotUsedInHasValue() - { - // check if Link without $ in front of variable - $result = $this->render( - 'A<% if Link %>$Link<% end_if %>B', - new SSViewerTest\TestObject() - ); - $this->assertEquals('Asome/url.htmlB', $result, 'casting helper not used for <% if Link %>'); - - // check if Link with $ in front of variable - $result = $this->render( - 'A<% if $Link %>$Link<% end_if %>B', - new SSViewerTest\TestObject() - ); - $this->assertEquals('Asome/url.htmlB', $result, 'casting helper not used for <% if $Link %>'); - } - - public function testLocalFunctionsTakePriorityOverGlobals() - { - $data = new ArrayData([ - 'Page' => new SSViewerTest\TestObject() - ]); - - //call method with lots of arguments - $result = $this->render( - '<% with Page %>$lotsOfArguments11("a","b","c","d","e","f","g","h","i","j","k")<% end_with %>', - $data - ); - $this->assertEquals("abcdefghijk", $result, "public function can accept up to 11 arguments"); - - //call method that does not exist - $result = $this->render('<% with Page %><% if IDoNotExist %>hello<% end_if %><% end_with %>', $data); - $this->assertEquals("", $result, "Method does not exist - empty result"); - - //call if that does not exist - $result = $this->render('<% with Page %>$IDoNotExist("hello")<% end_with %>', $data); - $this->assertEquals("", $result, "Method does not exist - empty result"); - - //call method with same name as a global method (local call should take priority) - $result = $this->render('<% with Page %>$absoluteBaseURL<% end_with %>', $data); - $this->assertEquals( - "testLocalFunctionPriorityCalled", - $result, - "Local Object's public function called. Did not return the actual baseURL of the current site" - ); - } - - public function testCurrentScopeLoop(): void - { - $data = new ArrayList([['Val' => 'one'], ['Val' => 'two'], ['Val' => 'three']]); $this->assertEqualIgnoringWhitespace( - 'one two three', - $this->render('<% loop %>$Val<% end_loop %>', $data) + '', + $result1 ); - } - - public function testCurrentScopeLoopWith() - { - // Data to run the loop tests on - one sequence of three items, each with a subitem - $data = new ArrayData([ - 'Foo' => new ArrayList([ - 'Subocean' => new ArrayData([ - 'Name' => 'Higher' - ]), - new ArrayData([ - 'Sub' => new ArrayData([ - 'Name' => 'SubKid1' - ]) - ]), - new ArrayData([ - 'Sub' => new ArrayData([ - 'Name' => 'SubKid2' - ]) - ]), - new SSViewerTest\TestObject('Number6') - ]) - ]); - - $result = $this->render( - '<% loop Foo %>$Number<% if Sub %><% with Sub %>$Name<% end_with %><% end_if %><% end_loop %>', - $data - ); - $this->assertEquals("SubKid1SubKid2Number6", $result, "Loop works"); - - $result = $this->render( - '<% loop Foo %>$Number<% if Sub %><% with Sub %>$Name<% end_with %><% end_if %><% end_loop %>', - $data - ); - $this->assertEquals("SubKid1SubKid2Number6", $result, "Loop works"); - - $result = $this->render('<% with Foo %>$Count<% end_with %>', $data); - $this->assertEquals("4", $result, "4 items in the DataObjectSet"); - - $result = $this->render( - '<% with Foo %><% loop Up.Foo %>$Number<% if Sub %><% with Sub %>$Name<% end_with %>' - . '<% end_if %><% end_loop %><% end_with %>', - $data - ); - $this->assertEquals("SubKid1SubKid2Number6", $result, "Loop in with Up.Foo scope works"); - - $result = $this->render( - '<% with Foo %><% loop %>$Number<% if Sub %><% with Sub %>$Name<% end_with %>' - . '<% end_if %><% end_loop %><% end_with %>', - $data - ); - $this->assertEquals("SubKid1SubKid2Number6", $result, "Loop in current scope works"); - } - - public static function provideArgumentTypes() - { - return [ - [ - 'arg1:0,arg2:"string",arg3:true', - '$methodWithTypedArguments(0, "string", true).RAW', - ], - [ - 'arg1:false,arg2:"string",arg3:true', - '$methodWithTypedArguments(false, "string", true).RAW', - ], - [ - 'arg1:null,arg2:"string",arg3:true', - '$methodWithTypedArguments(null, "string", true).RAW', - ], - [ - 'arg1:"",arg2:"string",arg3:true', - '$methodWithTypedArguments("", "string", true).RAW', - ], - [ - 'arg1:0,arg2:1,arg3:2', - '$methodWithTypedArguments(0, 1, 2).RAW', - ], - ]; - } - - #[DataProvider('provideArgumentTypes')] - public function testArgumentTypes(string $expected, string $template) - { - $this->assertEquals($expected, $this->render($template, new TestModelData())); - } - - public function testObjectDotArguments() - { - $this->assertEquals( - '[out:TestObject.methodWithOneArgument(one)] - [out:TestObject.methodWithTwoArguments(one,two)] - [out:TestMethod(Arg1,Arg2).Bar.Val] - [out:TestMethod(Arg1,Arg2).Bar] - [out:TestMethod(Arg1,Arg2)] - [out:TestMethod(Arg1).Bar.Val] - [out:TestMethod(Arg1).Bar] - [out:TestMethod(Arg1)]', - $this->render( - '$TestObject.methodWithOneArgument(one) - $TestObject.methodWithTwoArguments(one,two) - $TestMethod(Arg1, Arg2).Bar.Val - $TestMethod(Arg1, Arg2).Bar - $TestMethod(Arg1, Arg2) - $TestMethod(Arg1).Bar.Val - $TestMethod(Arg1).Bar - $TestMethod(Arg1)' - ) - ); - } - - public function testEscapedArguments() - { - $this->assertEquals( - '[out:Foo(Arg1,Arg2).Bar.Val].Suffix - [out:Foo(Arg1,Arg2).Val]_Suffix - [out:Foo(Arg1,Arg2)]/Suffix - [out:Foo(Arg1).Bar.Val]textSuffix - [out:Foo(Arg1).Bar].Suffix - [out:Foo(Arg1)].Suffix - [out:Foo.Bar.Val].Suffix - [out:Foo.Bar].Suffix - [out:Foo].Suffix', - $this->render( - '{$Foo(Arg1, Arg2).Bar.Val}.Suffix - {$Foo(Arg1, Arg2).Val}_Suffix - {$Foo(Arg1, Arg2)}/Suffix - {$Foo(Arg1).Bar.Val}textSuffix - {$Foo(Arg1).Bar}.Suffix - {$Foo(Arg1)}.Suffix - {$Foo.Bar.Val}.Suffix - {$Foo.Bar}.Suffix - {$Foo}.Suffix' - ) - ); - } - - public function testLoopWhitespace() - { - $data = new ArrayList([new SSViewerTest\TestFixture()]); - $this->assertEquals( - 'before[out:Test]after - beforeTestafter', - $this->render( - 'before<% loop %>$Test<% end_loop %>after - before<% loop %>Test<% end_loop %>after', - $data - ) - ); - - // The control tags are removed from the output, but no whitespace - // This is a quirk that could be changed, but included in the test to make the current - // behaviour explicit - $this->assertEquals( - 'before - -[out:ItemOnItsOwnLine] - -after', - $this->render( - 'before -<% loop %> -$ItemOnItsOwnLine -<% end_loop %> -after', - $data - ) - ); - - // The whitespace within the control tags is preserve in a loop - // This is a quirk that could be changed, but included in the test to make the current - // behaviour explicit - $this->assertEquals( - 'before - -[out:Loop3.ItemOnItsOwnLine] - -[out:Loop3.ItemOnItsOwnLine] - -[out:Loop3.ItemOnItsOwnLine] - -after', - $this->render( - 'before -<% loop Loop3 %> -$ItemOnItsOwnLine -<% end_loop %> -after' - ) - ); - } - - public static function typePreservationDataProvider() - { - return [ - // Null - ['NULL:', 'null'], - ['NULL:', 'NULL'], - // Booleans - ['boolean:1', 'true'], - ['boolean:1', 'TRUE'], - ['boolean:', 'false'], - ['boolean:', 'FALSE'], - // Strings which may look like booleans/null to the parser - ['string:nullish', 'nullish'], - ['string:notnull', 'notnull'], - ['string:truethy', 'truethy'], - ['string:untrue', 'untrue'], - ['string:falsey', 'falsey'], - // Integers - ['integer:0', '0'], - ['integer:1', '1'], - ['integer:15', '15'], - ['integer:-15', '-15'], - // Octal integers - ['integer:83', '0123'], - ['integer:-83', '-0123'], - // Hexadecimal integers - ['integer:26', '0x1A'], - ['integer:-26', '-0x1A'], - // Binary integers - ['integer:255', '0b11111111'], - ['integer:-255', '-0b11111111'], - // Floats (aka doubles) - ['double:0', '0.0'], - ['double:1', '1.0'], - ['double:15.25', '15.25'], - ['double:-15.25', '-15.25'], - ['double:1200', '1.2e3'], - ['double:-1200', '-1.2e3'], - ['double:0.07', '7E-2'], - ['double:-0.07', '-7E-2'], - // Explicitly quoted strings - ['string:0', '"0"'], - ['string:1', '\'1\''], - ['string:foobar', '"foobar"'], - ['string:foo bar baz', '"foo bar baz"'], - ['string:false', '\'false\''], - ['string:true', '\'true\''], - ['string:null', '\'null\''], - ['string:false', '"false"'], - ['string:true', '"true"'], - ['string:null', '"null"'], - // Implicit strings - ['string:foobar', 'foobar'], - ['string:foo bar baz', 'foo bar baz'] - ]; - } - - #[DataProvider('typePreservationDataProvider')] - public function testTypesArePreserved($expected, $templateArg) - { - $data = new ArrayData([ - 'Test' => new TestModelData() - ]); - - $this->assertEquals($expected, $this->render("\$Test.Type({$templateArg})", $data)); - } - - #[DataProvider('typePreservationDataProvider')] - public function testTypesArePreservedAsIncludeArguments($expected, $templateArg) - { - $data = new ArrayData([ - 'Test' => new TestModelData() - ]); - - $this->assertEquals( - $expected, - $this->render("<% include SSViewerTestTypePreservation Argument={$templateArg} %>", $data) - ); - } - - public function testTypePreservationInConditionals() - { - $data = new ArrayData([ - 'Test' => new TestModelData() - ]); - - // Types in conditionals - $this->assertEquals('pass', $this->render('<% if true %>pass<% else %>fail<% end_if %>', $data)); - $this->assertEquals('pass', $this->render('<% if false %>fail<% else %>pass<% end_if %>', $data)); - $this->assertEquals('pass', $this->render('<% if 1 %>pass<% else %>fail<% end_if %>', $data)); - $this->assertEquals('pass', $this->render('<% if 0 %>fail<% else %>pass<% end_if %>', $data)); - } - - public function testControls() - { - // Single item controls - $this->assertEquals( - 'a[out:Foo.Bar.Item]b - [out:Foo.Bar(Arg1).Item] - [out:Foo(Arg1).Item] - [out:Foo(Arg1,Arg2).Item] - [out:Foo(Arg1,Arg2,Arg3).Item]', - $this->render( - '<% with Foo.Bar %>a{$Item}b<% end_with %> - <% with Foo.Bar(Arg1) %>$Item<% end_with %> - <% with Foo(Arg1) %>$Item<% end_with %> - <% with Foo(Arg1, Arg2) %>$Item<% end_with %> - <% with Foo(Arg1, Arg2, Arg3) %>$Item<% end_with %>' - ) - ); - - // Loop controls - $this->assertEquals( - 'a[out:Foo.Loop2.Item]ba[out:Foo.Loop2.Item]b', - $this->render('<% loop Foo.Loop2 %>a{$Item}b<% end_loop %>') - ); - - $this->assertEquals( - '[out:Foo.Loop2(Arg1).Item][out:Foo.Loop2(Arg1).Item]', - $this->render('<% loop Foo.Loop2(Arg1) %>$Item<% end_loop %>') - ); - - $this->assertEquals( - '[out:Loop2(Arg1).Item][out:Loop2(Arg1).Item]', - $this->render('<% loop Loop2(Arg1) %>$Item<% end_loop %>') - ); - - $this->assertEquals( - '[out:Loop2(Arg1,Arg2).Item][out:Loop2(Arg1,Arg2).Item]', - $this->render('<% loop Loop2(Arg1, Arg2) %>$Item<% end_loop %>') - ); - - $this->assertEquals( - '[out:Loop2(Arg1,Arg2,Arg3).Item][out:Loop2(Arg1,Arg2,Arg3).Item]', - $this->render('<% loop Loop2(Arg1, Arg2, Arg3) %>$Item<% end_loop %>') - ); - } - - public function testIfBlocks() - { - // Basic test - $this->assertEquals( - 'AC', - $this->render('A<% if NotSet %>B$NotSet<% end_if %>C') - ); - - // Nested test - $this->assertEquals( - 'AB1C', - $this->render('A<% if IsSet %>B$NotSet<% if IsSet %>1<% else %>2<% end_if %><% end_if %>C') - ); - - // else_if - $this->assertEquals( - 'ACD', - $this->render('A<% if NotSet %>B<% else_if IsSet %>C<% end_if %>D') - ); - $this->assertEquals( - 'AD', - $this->render('A<% if NotSet %>B<% else_if AlsoNotset %>C<% end_if %>D') - ); - $this->assertEquals( - 'ADE', - $this->render('A<% if NotSet %>B<% else_if AlsoNotset %>C<% else_if IsSet %>D<% end_if %>E') - ); - - $this->assertEquals( - 'ADE', - $this->render('A<% if NotSet %>B<% else_if AlsoNotset %>C<% else_if IsSet %>D<% end_if %>E') - ); - - // Dot syntax - $this->assertEquals( - 'ACD', - $this->render('A<% if Foo.NotSet %>B<% else_if Foo.IsSet %>C<% end_if %>D') - ); - $this->assertEquals( - 'ACD', - $this->render('A<% if Foo.Bar.NotSet %>B<% else_if Foo.Bar.IsSet %>C<% end_if %>D') - ); - - // Params - $this->assertEquals( - 'ACD', - $this->render('A<% if NotSet(Param) %>B<% else %>C<% end_if %>D') - ); - $this->assertEquals( - 'ABD', - $this->render('A<% if IsSet(Param) %>B<% else %>C<% end_if %>D') - ); - - // Negation - $this->assertEquals( - 'AC', - $this->render('A<% if not IsSet %>B<% end_if %>C') - ); - $this->assertEquals( - 'ABC', - $this->render('A<% if not NotSet %>B<% end_if %>C') - ); - - // Or - $this->assertEquals( - 'ABD', - $this->render('A<% if IsSet || NotSet %>B<% else_if A %>C<% end_if %>D') - ); - $this->assertEquals( - 'ACD', - $this->render('A<% if NotSet || AlsoNotSet %>B<% else_if IsSet %>C<% end_if %>D') - ); - $this->assertEquals( - 'AD', - $this->render('A<% if NotSet || AlsoNotSet %>B<% else_if NotSet3 %>C<% end_if %>D') - ); - $this->assertEquals( - 'ACD', - $this->render('A<% if NotSet || AlsoNotSet %>B<% else_if IsSet || NotSet %>C<% end_if %>D') - ); - $this->assertEquals( - 'AD', - $this->render('A<% if NotSet || AlsoNotSet %>B<% else_if NotSet2 || NotSet3 %>C<% end_if %>D') - ); - - // Negated Or - $this->assertEquals( - 'ACD', - $this->render('A<% if not IsSet || AlsoNotSet %>B<% else_if A %>C<% end_if %>D') - ); - $this->assertEquals( - 'ABD', - $this->render('A<% if not NotSet || AlsoNotSet %>B<% else_if A %>C<% end_if %>D') - ); - $this->assertEquals( - 'ABD', - $this->render('A<% if NotSet || not AlsoNotSet %>B<% else_if A %>C<% end_if %>D') - ); - - // And - $this->assertEquals( - 'ABD', - $this->render('A<% if IsSet && AlsoSet %>B<% else_if A %>C<% end_if %>D') - ); - $this->assertEquals( - 'ACD', - $this->render('A<% if IsSet && NotSet %>B<% else_if IsSet %>C<% end_if %>D') - ); - $this->assertEquals( - 'AD', - $this->render('A<% if NotSet && NotSet2 %>B<% else_if NotSet3 %>C<% end_if %>D') - ); - $this->assertEquals( - 'ACD', - $this->render('A<% if IsSet && NotSet %>B<% else_if IsSet && AlsoSet %>C<% end_if %>D') - ); - $this->assertEquals( - 'AD', - $this->render('A<% if NotSet && NotSet2 %>B<% else_if IsSet && NotSet3 %>C<% end_if %>D') - ); - - // Equality - $this->assertEquals( - 'ABC', - $this->render('A<% if RawVal == RawVal %>B<% end_if %>C') - ); - $this->assertEquals( - 'ACD', - $this->render('A<% if Right == Wrong %>B<% else_if RawVal == RawVal %>C<% end_if %>D') - ); - $this->assertEquals( - 'ABC', - $this->render('A<% if Right != Wrong %>B<% end_if %>C') - ); - $this->assertEquals( - 'AD', - $this->render('A<% if Right == Wrong %>B<% else_if RawVal != RawVal %>C<% end_if %>D') - ); - - // test inequalities with simple numbers - $this->assertEquals('ABD', $this->render('A<% if 5 > 3 %>B<% else %>C<% end_if %>D')); - $this->assertEquals('ABD', $this->render('A<% if 5 >= 3 %>B<% else %>C<% end_if %>D')); - $this->assertEquals('ACD', $this->render('A<% if 3 > 5 %>B<% else %>C<% end_if %>D')); - $this->assertEquals('ACD', $this->render('A<% if 3 >= 5 %>B<% else %>C<% end_if %>D')); - - $this->assertEquals('ABD', $this->render('A<% if 3 < 5 %>B<% else %>C<% end_if %>D')); - $this->assertEquals('ABD', $this->render('A<% if 3 <= 5 %>B<% else %>C<% end_if %>D')); - $this->assertEquals('ACD', $this->render('A<% if 5 < 3 %>B<% else %>C<% end_if %>D')); - $this->assertEquals('ACD', $this->render('A<% if 5 <= 3 %>B<% else %>C<% end_if %>D')); - - $this->assertEquals('ABD', $this->render('A<% if 4 <= 4 %>B<% else %>C<% end_if %>D')); - $this->assertEquals('ABD', $this->render('A<% if 4 >= 4 %>B<% else %>C<% end_if %>D')); - $this->assertEquals('ACD', $this->render('A<% if 4 > 4 %>B<% else %>C<% end_if %>D')); - $this->assertEquals('ACD', $this->render('A<% if 4 < 4 %>B<% else %>C<% end_if %>D')); - - // empty else_if and else tags, if this would not be supported, - // the output would stop after A, thereby failing the assert - $this->assertEquals('AD', $this->render('A<% if IsSet %><% else %><% end_if %>D')); - $this->assertEquals( - 'AD', - $this->render('A<% if NotSet %><% else_if IsSet %><% else %><% end_if %>D') - ); - $this->assertEquals( - 'AD', - $this->render('A<% if NotSet %><% else_if AlsoNotSet %><% else %><% end_if %>D') - ); - - // Bare words with ending space - $this->assertEquals( - 'ABC', - $this->render('A<% if "RawVal" == RawVal %>B<% end_if %>C') - ); - - // Else - $this->assertEquals( - 'ADE', - $this->render('A<% if Right == Wrong %>B<% else_if RawVal != RawVal %>C<% else %>D<% end_if %>E') - ); - - // Empty if with else - $this->assertEquals( - 'ABC', - $this->render('A<% if NotSet %><% else %>B<% end_if %>C') - ); - } - - public static function provideIfBlockWithIterable(): array - { - $scenarios = [ - 'empty array' => [ - 'iterable' => [], - 'inScope' => false, - ], - 'array' => [ - 'iterable' => [1, 2, 3], - 'inScope' => false, - ], - 'ArrayList' => [ - 'iterable' => new ArrayList([['Val' => 1], ['Val' => 2], ['Val' => 3]]), - 'inScope' => false, - ], - ]; - foreach ($scenarios as $name => $scenario) { - $scenario['inScope'] = true; - $scenarios[$name . ' in scope'] = $scenario; - } - return $scenarios; - } - - #[DataProvider('provideIfBlockWithIterable')] - public function testIfBlockWithIterable(iterable $iterable, bool $inScope): void - { - $expected = count($iterable) ? 'has value' : 'no value'; - $data = new ArrayData(['Iterable' => $iterable]); - if ($inScope) { - $template = '<% with $Iterable %><% if $Me %>has value<% else %>no value<% end_if %><% end_with %>'; - } else { - $template = '<% if $Iterable %>has value<% else %>no value<% end_if %>'; - } - $this->assertEqualIgnoringWhitespace($expected, $this->render($template, $data)); - } - - public function testBaseTagGeneration() - { - // XHTML will have a closed base tag - $tmpl1 = ' - - - <% base_tag %> -

test

- '; - $this->assertMatchesRegularExpression('/<\/head>/', $this->render($tmpl1)); - - // HTML4 and 5 will only have it for IE - $tmpl2 = ' - - <% base_tag %> -

test

- '; - $this->assertMatchesRegularExpression( - '/<\/head>/', - $this->render($tmpl2) - ); - - - $tmpl3 = ' - - <% base_tag %> -

test

- '; - $this->assertMatchesRegularExpression( - '/<\/head>/', - $this->render($tmpl3) - ); - - // Check that the content negotiator converts to the equally legal formats - $negotiator = new ContentNegotiator(); - - $response = new HTTPResponse($this->render($tmpl1)); - $negotiator->html($response); - $this->assertMatchesRegularExpression( - '/<\/head>/', - $response->getBody() - ); - - $response = new HTTPResponse($this->render($tmpl1)); - $negotiator->xhtml($response); - $this->assertMatchesRegularExpression('/<\/head>/', $response->getBody()); - } - - public function testIncludeWithArguments() - { - $this->assertEquals( - $this->render('<% include SSViewerTestIncludeWithArguments %>'), - '

[out:Arg1]

[out:Arg2]

[out:Arg2.Count]

' - ); - - $this->assertEquals( - $this->render('<% include SSViewerTestIncludeWithArguments Arg1=A %>'), - '

A

[out:Arg2]

[out:Arg2.Count]

' - ); - - $this->assertEquals( - $this->render('<% include SSViewerTestIncludeWithArguments Arg1=A, Arg2=B %>'), - '

A

B

' - ); - - $this->assertEquals( - $this->render('<% include SSViewerTestIncludeWithArguments Arg1=A Bare String, Arg2=B Bare String %>'), - '

A Bare String

B Bare String

' - ); - - $this->assertEquals( - $this->render( - '<% include SSViewerTestIncludeWithArguments Arg1="A", Arg2=$B %>', - new ArrayData(['B' => 'Bar']) - ), - '

A

Bar

' - ); - - $this->assertEquals( - $this->render( - '<% include SSViewerTestIncludeWithArguments Arg1="A" %>', - new ArrayData(['Arg1' => 'Foo', 'Arg2' => 'Bar']) - ), - '

A

Bar

' - ); - - $this->assertEquals( - $this->render('<% include SSViewerTestIncludeWithArguments Arg1="A", Arg2=0 %>'), - '

A

0

' - ); - - $this->assertEquals( - $this->render('<% include SSViewerTestIncludeWithArguments Arg1="A", Arg2=false %>'), - '

A

' - ); - - $this->assertEquals( - $this->render('<% include SSViewerTestIncludeWithArguments Arg1="A", Arg2=null %>'), - '

A

' - ); - - $this->assertEquals( - $this->render( - '<% include SSViewerTestIncludeScopeInheritanceWithArgsInLoop Title="SomeArg" %>', - new ArrayData( - ['Items' => new ArrayList( - [ - new ArrayData(['Title' => 'Foo']), - new ArrayData(['Title' => 'Bar']) - ] - )] - ) - ), - 'SomeArg - Foo - Bar - SomeArg' - ); - - $this->assertEquals( - $this->render( - '<% include SSViewerTestIncludeScopeInheritanceWithArgsInWith Title="A" %>', - new ArrayData(['Item' => new ArrayData(['Title' =>'B'])]) - ), - 'A - B - A' - ); - - $this->assertEquals( - $this->render( - '<% include SSViewerTestIncludeScopeInheritanceWithArgsInNestedWith Title="A" %>', - new ArrayData( - [ - 'Item' => new ArrayData( - [ - 'Title' =>'B', 'NestedItem' => new ArrayData(['Title' => 'C']) - ] - )] - ) - ), - 'A - B - C - B - A' - ); - - $this->assertEquals( - $this->render( - '<% include SSViewerTestIncludeScopeInheritanceWithUpAndTop Title="A" %>', - new ArrayData( - [ - 'Item' => new ArrayData( - [ - 'Title' =>'B', 'NestedItem' => new ArrayData(['Title' => 'C']) - ] - )] - ) - ), - 'A - A - A' - ); - - $data = new ArrayData( - [ - 'Nested' => new ArrayData( - [ - 'Object' => new ArrayData(['Key' => 'A']) - ] - ), - 'Object' => new ArrayData(['Key' => 'B']) - ] - ); - - $tmpl = SSViewer::fromString('<% include SSViewerTestIncludeObjectArguments A=$Nested.Object, B=$Object %>'); - $res = $tmpl->process($data); - $this->assertEqualIgnoringWhitespace('A B', $res, 'Objects can be passed as named arguments'); - } - - public function testNamespaceInclude() - { - $data = new ArrayData([]); - - $this->assertEquals( - "tests:( NamespaceInclude\n )", - $this->render('tests:( <% include Namespace\NamespaceInclude %> )', $data), - 'Backslashes work for namespace references in includes' - ); - - $this->assertEquals( - "tests:( NamespaceInclude\n )", - $this->render('tests:( <% include Namespace\\NamespaceInclude %> )', $data), - 'Escaped backslashes work for namespace references in includes' - ); - - $this->assertEquals( - "tests:( NamespaceInclude\n )", - $this->render('tests:( <% include Namespace/NamespaceInclude %> )', $data), - 'Forward slashes work for namespace references in includes' - ); - } - - /** - * Test search for includes fallback to non-includes folder - */ - public function testIncludeFallbacks() - { - $data = new ArrayData([]); - - $this->assertEquals( - "tests:( Namespace/Includes/IncludedTwice.ss\n )", - $this->render('tests:( <% include Namespace\\IncludedTwice %> )', $data), - 'Prefer Includes in the Includes folder' - ); - - $this->assertEquals( - "tests:( Namespace/Includes/IncludedOnceSub.ss\n )", - $this->render('tests:( <% include Namespace\\IncludedOnceSub %> )', $data), - 'Includes in only Includes folder can be found' - ); - - $this->assertEquals( - "tests:( Namespace/IncludedOnceBase.ss\n )", - $this->render('tests:( <% include Namespace\\IncludedOnceBase %> )', $data), - 'Includes outside of Includes folder can be found' - ); - } - - public function testRecursiveInclude() - { - $view = new SSViewer(['Includes/SSViewerTestRecursiveInclude']); - - $data = new ArrayData( - [ - 'Title' => 'A', - 'Children' => new ArrayList( - [ - new ArrayData( - [ - 'Title' => 'A1', - 'Children' => new ArrayList( - [ - new ArrayData([ 'Title' => 'A1 i', ]), - new ArrayData([ 'Title' => 'A1 ii', ]), - ] - ), - ] - ), - new ArrayData([ 'Title' => 'A2', ]), - new ArrayData([ 'Title' => 'A3', ]), - ] - ), - ] - ); - - $result = $view->process($data); - // We don't care about whitespace - $rationalisedResult = trim(preg_replace('/\s+/', ' ', $result ?? '') ?? ''); - - $this->assertEquals('A A1 A1 i A1 ii A2 A3', $rationalisedResult); - } - - public function assertEqualIgnoringWhitespace($a, $b, $message = '') - { - $this->assertEquals(preg_replace('/\s+/', '', $a ?? ''), preg_replace('/\s+/', '', $b ?? ''), $message); - } - - /** - * See {@link ModelDataTest} for more extensive casting tests, - * this test just ensures that basic casting is correctly applied during template parsing. - */ - public function testCastingHelpers() - { - $vd = new SSViewerTest\TestModelData(); - $vd->TextValue = 'html'; - $vd->HTMLValue = 'html'; - $vd->UncastedValue = 'html'; - - // Value casted as "Text" - $this->assertEquals( - '<b>html</b>', - $t = SSViewer::fromString('$TextValue')->process($vd) - ); - $this->assertEquals( - 'html', - $t = SSViewer::fromString('$TextValue.RAW')->process($vd) - ); - $this->assertEquals( - '<b>html</b>', - $t = SSViewer::fromString('$TextValue.XML')->process($vd) - ); - - // Value casted as "HTMLText" - $this->assertEquals( - 'html', - $t = SSViewer::fromString('$HTMLValue')->process($vd) - ); - $this->assertEquals( - 'html', - $t = SSViewer::fromString('$HTMLValue.RAW')->process($vd) - ); - $this->assertEquals( - '<b>html</b>', - $t = SSViewer::fromString('$HTMLValue.XML')->process($vd) - ); - - // Uncasted value (falls back to ModelData::$default_cast="Text") - $vd = new SSViewerTest\TestModelData(); - $vd->UncastedValue = 'html'; - $this->assertEquals( - '<b>html</b>', - $t = SSViewer::fromString('$UncastedValue')->process($vd) - ); - $this->assertEquals( - 'html', - $t = SSViewer::fromString('$UncastedValue.RAW')->process($vd) - ); - $this->assertEquals( - '<b>html</b>', - $t = SSViewer::fromString('$UncastedValue.XML')->process($vd) - ); - } - - public static function provideLoop(): array - { - return [ - 'nested array and iterator' => [ - 'iterable' => [ - [ - 'value 1', - 'value 2', - ], - new ArrayList([ - 'value 3', - 'value 4', - ]), - ], - 'template' => '<% loop $Iterable %><% loop $Me %>$Me<% end_loop %><% end_loop %>', - 'expected' => 'value 1 value 2 value 3 value 4', - ], - 'nested associative arrays' => [ - 'iterable' => [ - [ - 'Foo' => 'one', - ], - [ - 'Foo' => 'two', - ], - [ - 'Foo' => 'three', - ], - ], - 'template' => '<% loop $Iterable %>$Foo<% end_loop %>', - 'expected' => 'one two three', - ], - ]; - } - - #[DataProvider('provideLoop')] - public function testLoop(iterable $iterable, string $template, string $expected): void - { - $data = new ArrayData(['Iterable' => $iterable]); - $this->assertEqualIgnoringWhitespace($expected, $this->render($template, $data)); - } - - public static function provideCountIterable(): array - { - $scenarios = [ - 'empty array' => [ - 'iterable' => [], - 'inScope' => false, - ], - 'array' => [ - 'iterable' => [1, 2, 3], - 'inScope' => false, - ], - 'ArrayList' => [ - 'iterable' => new ArrayList([['Val' => 1], ['Val' => 2], ['Val' => 3]]), - 'inScope' => false, - ], - ]; - foreach ($scenarios as $name => $scenario) { - $scenario['inScope'] = true; - $scenarios[$name . ' in scope'] = $scenario; - } - return $scenarios; - } - - #[DataProvider('provideCountIterable')] - public function testCountIterable(iterable $iterable, bool $inScope): void - { - $expected = count($iterable); - $data = new ArrayData(['Iterable' => $iterable]); - if ($inScope) { - $template = '<% with $Iterable %>$Count<% end_with %>'; - } else { - $template = '$Iterable.Count'; - } - $this->assertEqualIgnoringWhitespace($expected, $this->render($template, $data)); - } - - public function testSSViewerBasicIteratorSupport() - { - $data = new ArrayData( - [ - 'Set' => new ArrayList( - [ - new SSViewerTest\TestObject("1"), - new SSViewerTest\TestObject("2"), - new SSViewerTest\TestObject("3"), - new SSViewerTest\TestObject("4"), - new SSViewerTest\TestObject("5"), - new SSViewerTest\TestObject("6"), - new SSViewerTest\TestObject("7"), - new SSViewerTest\TestObject("8"), - new SSViewerTest\TestObject("9"), - new SSViewerTest\TestObject("10"), - ] - ) - ] - ); - - //base test - $result = $this->render('<% loop Set %>$Number<% end_loop %>', $data); - $this->assertEquals("12345678910", $result, "Numbers rendered in order"); - - //test First - $result = $this->render('<% loop Set %><% if $IsFirst %>$Number<% end_if %><% end_loop %>', $data); - $this->assertEquals("1", $result, "Only the first number is rendered"); - - //test Last - $result = $this->render('<% loop Set %><% if $IsLast %>$Number<% end_if %><% end_loop %>', $data); - $this->assertEquals("10", $result, "Only the last number is rendered"); - - //test Even - $result = $this->render('<% loop Set %><% if $Even() %>$Number<% end_if %><% end_loop %>', $data); - $this->assertEquals("246810", $result, "Even numbers rendered in order"); - - //test Even with quotes - $result = $this->render('<% loop Set %><% if $Even("1") %>$Number<% end_if %><% end_loop %>', $data); - $this->assertEquals("246810", $result, "Even numbers rendered in order"); - - //test Even without quotes - $result = $this->render('<% loop Set %><% if $Even(1) %>$Number<% end_if %><% end_loop %>', $data); - $this->assertEquals("246810", $result, "Even numbers rendered in order"); - - //test Even with zero-based start index - $result = $this->render('<% loop Set %><% if $Even("0") %>$Number<% end_if %><% end_loop %>', $data); - $this->assertEquals("13579", $result, "Even (with zero-based index) numbers rendered in order"); - - //test Odd - $result = $this->render('<% loop Set %><% if $Odd %>$Number<% end_if %><% end_loop %>', $data); - $this->assertEquals("13579", $result, "Odd numbers rendered in order"); - - //test FirstLast - $result = $this->render('<% loop Set %><% if $FirstLast %>$Number$FirstLast<% end_if %><% end_loop %>', $data); - $this->assertEquals("1first10last", $result, "First and last numbers rendered in order"); - - //test Middle - $result = $this->render('<% loop Set %><% if $Middle %>$Number<% end_if %><% end_loop %>', $data); - $this->assertEquals("23456789", $result, "Middle numbers rendered in order"); - - //test MiddleString - $result = $this->render( - '<% loop Set %><% if MiddleString == "middle" %>$Number$MiddleString<% end_if %>' - . '<% end_loop %>', - $data - ); - $this->assertEquals( - "2middle3middle4middle5middle6middle7middle8middle9middle", - $result, - "Middle numbers rendered in order" - ); - - //test EvenOdd - $result = $this->render('<% loop Set %>$EvenOdd<% end_loop %>', $data); - $this->assertEquals( - "oddevenoddevenoddevenoddevenoddeven", - $result, - "Even and Odd is returned in sequence numbers rendered in order" - ); - - //test Pos - $result = $this->render('<% loop Set %>$Pos<% end_loop %>', $data); - $this->assertEquals("12345678910", $result, '$Pos is rendered in order'); - - //test Pos - $result = $this->render('<% loop Set %>$Pos(0)<% end_loop %>', $data); - $this->assertEquals("0123456789", $result, '$Pos(0) is rendered in order'); - - //test FromEnd - $result = $this->render('<% loop Set %>$FromEnd<% end_loop %>', $data); - $this->assertEquals("10987654321", $result, '$FromEnd is rendered in order'); - - //test FromEnd - $result = $this->render('<% loop Set %>$FromEnd(0)<% end_loop %>', $data); - $this->assertEquals("9876543210", $result, '$FromEnd(0) rendered in order'); - - //test Total - $result = $this->render('<% loop Set %>$TotalItems<% end_loop %>', $data); - $this->assertEquals("10101010101010101010", $result, "10 total items X 10 are returned"); - - //test Modulus - $result = $this->render('<% loop Set %>$Modulus(2,1)<% end_loop %>', $data); - $this->assertEquals("1010101010", $result, "1-indexed pos modular divided by 2 rendered in order"); - - //test MultipleOf 3 - $result = $this->render('<% loop Set %><% if MultipleOf(3) %>$Number<% end_if %><% end_loop %>', $data); - $this->assertEquals("369", $result, "Only numbers that are multiples of 3 are returned"); - - //test MultipleOf 4 - $result = $this->render('<% loop Set %><% if MultipleOf(4) %>$Number<% end_if %><% end_loop %>', $data); - $this->assertEquals("48", $result, "Only numbers that are multiples of 4 are returned"); - - //test MultipleOf 5 - $result = $this->render('<% loop Set %><% if MultipleOf(5) %>$Number<% end_if %><% end_loop %>', $data); - $this->assertEquals("510", $result, "Only numbers that are multiples of 5 are returned"); - - //test MultipleOf 10 - $result = $this->render('<% loop Set %><% if MultipleOf(10,1) %>$Number<% end_if %><% end_loop %>', $data); - $this->assertEquals("10", $result, "Only numbers that are multiples of 10 (with 1-based indexing) are returned"); - - //test MultipleOf 9 zero-based - $result = $this->render('<% loop Set %><% if MultipleOf(9,0) %>$Number<% end_if %><% end_loop %>', $data); - $this->assertEquals( - "110", - $result, - "Only numbers that are multiples of 9 with zero-based indexing are returned. (The first and last item)" - ); - - //test MultipleOf 11 - $result = $this->render('<% loop Set %><% if MultipleOf(11) %>$Number<% end_if %><% end_loop %>', $data); - $this->assertEquals("", $result, "Only numbers that are multiples of 11 are returned. I.e. nothing returned"); - } - - /** - * Test $Up works when the scope $Up refers to was entered with a "with" block - */ - public function testUpInWith() - { - - // Data to run the loop tests on - three levels deep - $data = new ArrayData( - [ - 'Name' => 'Top', - 'Foo' => new ArrayData( - [ - 'Name' => 'Foo', - 'Bar' => new ArrayData( - [ - 'Name' => 'Bar', - 'Baz' => new ArrayData( - [ - 'Name' => 'Baz' - ] - ), - 'Qux' => new ArrayData( - [ - 'Name' => 'Qux' - ] - ) - ] - ) - ] - ) - ] - ); - - // Basic functionality - $this->assertEquals( - 'BarFoo', - $this->render('<% with Foo %><% with Bar %>{$Name}{$Up.Name}<% end_with %><% end_with %>', $data) - ); - - // Two level with block, up refers to internally referenced Bar - $this->assertEquals( - 'BarTop', - $this->render('<% with Foo.Bar %>{$Name}{$Up.Name}<% end_with %>', $data) - ); - - // Stepping up & back down the scope tree - $this->assertEquals( - 'BazFooBar', - $this->render('<% with Foo.Bar.Baz %>{$Name}{$Up.Foo.Name}{$Up.Foo.Bar.Name}<% end_with %>', $data) - ); - - // Using $Up in a with block - $this->assertEquals( - 'BazTopBar', - $this->render( - '<% with Foo.Bar.Baz %>{$Name}<% with $Up %>{$Name}{$Foo.Bar.Name}<% end_with %>' - . '<% end_with %>', - $data - ) - ); - - // Stepping up & back down the scope tree with with blocks - $this->assertEquals( - 'BazTopBarTopBaz', - $this->render( - '<% with Foo.Bar.Baz %>{$Name}<% with $Up %>{$Name}<% with Foo.Bar %>{$Name}<% end_with %>' - . '{$Name}<% end_with %>{$Name}<% end_with %>', - $data - ) - ); - - // Using $Up.Up, where first $Up points to a previous scope entered using $Up, thereby skipping up to Foo - $this->assertEquals( - 'Foo', - $this->render( - '<% with Foo %><% with Bar %><% with Baz %>{$Up.Up.Name}<% end_with %><% end_with %>' - . '<% end_with %>', - $data - ) - ); - - // Using $Up as part of a lookup chain in <% with %> - $this->assertEquals( - 'Top', - $this->render('<% with Foo.Bar.Baz.Up.Qux %>{$Up.Name}<% end_with %>', $data) - ); - } - - public function testTooManyUps() - { - $this->expectException(LogicException::class); - $this->expectExceptionMessage("Up called when we're already at the top of the scope"); - $data = new ArrayData([ - 'Foo' => new ArrayData([ - 'Name' => 'Foo', - 'Bar' => new ArrayData([ - 'Name' => 'Bar' - ]) - ]) - ]); - - $this->assertEquals( - 'Foo', - $this->render('<% with Foo.Bar %>{$Up.Up.Name}<% end_with %>', $data) - ); - } - - /** - * Test $Up works when the scope $Up refers to was entered with a "loop" block - */ - public function testUpInLoop() - { - - // Data to run the loop tests on - one sequence of three items, each with a subitem - $data = new ArrayData( - [ - 'Name' => 'Top', - 'Foo' => new ArrayList( - [ - new ArrayData( - [ - 'Name' => '1', - 'Sub' => new ArrayData( - [ - 'Name' => 'Bar' - ] - ) - ] - ), - new ArrayData( - [ - 'Name' => '2', - 'Sub' => new ArrayData( - [ - 'Name' => 'Baz' - ] - ) - ] - ), - new ArrayData( - [ - 'Name' => '3', - 'Sub' => new ArrayData( - [ - 'Name' => 'Qux' - ] - ) - ] - ) - ] - ) - ] - ); - - // Make sure inside a loop, $Up refers to the current item of the loop $this->assertEqualIgnoringWhitespace( - '111 222 333', - $this->render( - '<% loop $Foo %>$Name<% with $Sub %>$Up.Name<% end_with %>$Name<% end_loop %>', - $data - ) - ); - - // Make sure inside a loop, looping over $Up uses a separate iterator, - // and doesn't interfere with the original iterator - $this->assertEqualIgnoringWhitespace( - '1Bar123Bar1 2Baz123Baz2 3Qux123Qux3', - $this->render( - '<% loop $Foo %> - $Name - <% with $Sub %> - $Name - <% loop $Up %>$Name<% end_loop %> - $Name - <% end_with %> - $Name - <% end_loop %>', - $data - ) - ); - - // Make sure inside a loop, looping over $Up uses a separate iterator, - // and doesn't interfere with the original iterator or local lookups - $this->assertEqualIgnoringWhitespace( - '1 Bar1 123 1Bar 1 2 Baz2 123 2Baz 2 3 Qux3 123 3Qux 3', - $this->render( - '<% loop $Foo %> - $Name - <% with $Sub %> - {$Name}{$Up.Name} - <% loop $Up %>$Name<% end_loop %> - {$Up.Name}{$Name} - <% end_with %> - $Name - <% end_loop %>', - $data - ) - ); - } - - /** - * Test that nested loops restore the loop variables correctly when pushing and popping states - */ - public function testNestedLoops() - { - - // Data to run the loop tests on - one sequence of three items, one with child elements - // (of a different size to the main sequence) - $data = new ArrayData( - [ - 'Foo' => new ArrayList( - [ - new ArrayData( - [ - 'Name' => '1', - 'Children' => new ArrayList( - [ - new ArrayData( - [ - 'Name' => 'a' - ] - ), - new ArrayData( - [ - 'Name' => 'b' - ] - ), - ] - ), - ] - ), - new ArrayData( - [ - 'Name' => '2', - 'Children' => new ArrayList(), - ] - ), - new ArrayData( - [ - 'Name' => '3', - 'Children' => new ArrayList(), - ] - ), - ] - ), - ] - ); - - // Make sure that including a loop inside a loop will not destroy the internal count of - // items, checked by using "Last" - $this->assertEqualIgnoringWhitespace( - '1ab23last', - $this->render( - '<% loop $Foo %>$Name<% loop Children %>$Name<% end_loop %><% if $IsLast %>last<% end_if %>' - . '<% end_loop %>', - $data - ) - ); - } - - public function testLayout() - { - $this->useTestTheme( - __DIR__ . '/SSViewerTest', - 'layouttest', - function () { - $template = new SSViewer(['Page']); - $this->assertEquals("Foo\n\n", $template->process(new ArrayData([]))); - - $template = new SSViewer(['Shortcodes', 'Page']); - $this->assertEquals("[file_link]\n\n", $template->process(new ArrayData([]))); - } + '', + $result2 ); } @@ -1874,7 +66,7 @@ after' __DIR__ . '/SSViewerTest', 'layouttest', function () { - // Test passing a string + // Test passing a string $templates = SSViewer::get_templates_by_class( SSViewerTestModelController::class, '', @@ -1897,7 +89,7 @@ after' $templates ); - // Test to ensure we're stopping at the base class. + // Test to ensure we're stopping at the base class. $templates = SSViewer::get_templates_by_class( SSViewerTestModelController::class, '', @@ -1915,7 +107,7 @@ after' $templates ); - // Make sure we can search templates by suffix. + // Make sure we can search templates by suffix. $templates = SSViewer::get_templates_by_class( SSViewerTestModel::class, 'Controller', @@ -1947,94 +139,76 @@ after' public function testRewriteHashlinks() { SSViewer::setRewriteHashLinksDefault(true); + $oldServerVars = $_SERVER; - $_SERVER['HTTP_HOST'] = 'www.mysite.com'; - $_SERVER['REQUEST_URI'] = '//file.com?foo"onclick="alert(\'xss\')""'; + try { + $_SERVER['REQUEST_URI'] = '//file.com?foo"onclick="alert(\'xss\')""'; - // Emulate SSViewer::process() - // Note that leading double slashes have been rewritten to prevent these being mis-interepreted - // as protocol-less absolute urls - $base = Convert::raw2att('/file.com?foo"onclick="alert(\'xss\')""'); + // Note that leading double slashes have been rewritten to prevent these being mis-interepreted + // as protocol-less absolute urls + $base = Convert::raw2att('/file.com?foo"onclick="alert(\'xss\')""'); - $tmplFile = TEMP_PATH . DIRECTORY_SEPARATOR . 'SSViewerTest_testRewriteHashlinks_' . sha1(rand()) . '.ss'; - - // Note: SSViewer_FromString doesn't rewrite hash links. - file_put_contents( - $tmplFile ?? '', - ' - - <% base_tag %> - - ExternalInlineLink - $ExternalInsertedLink - InlineLink - $InsertedLink - - - ' - ); - $tmpl = new SSViewer($tmplFile); - $obj = new ModelData(); - $obj->InsertedLink = DBField::create_field( - 'HTMLFragment', - 'InsertedLink' - ); - $obj->ExternalInsertedLink = DBField::create_field( - 'HTMLFragment', - 'ExternalInsertedLink' - ); - $result = $tmpl->process($obj); - $this->assertStringContainsString( - 'InsertedLink', - $result - ); - $this->assertStringContainsString( - 'ExternalInsertedLink', - $result - ); - $this->assertStringContainsString( - 'InlineLink', - $result - ); - $this->assertStringContainsString( - 'ExternalInlineLink', - $result - ); - $this->assertStringContainsString( - '', - $result, - 'SSTemplateParser should only rewrite anchor hrefs' - ); - - unlink($tmplFile ?? ''); + $engine = new DummyTemplateEngine(); + $engine->setOutput( + ' + + + + ExternalInlineLink + ExternalInsertedLink + InlineLink + InsertedLink + + + ' + ); + // Note: SSViewer_FromString doesn't rewrite hash links. + $tmpl = new SSViewer([], $engine); + $result = $tmpl->process('pretend this is a model'); + $this->assertStringContainsString( + 'InsertedLink', + $result + ); + $this->assertStringContainsString( + 'ExternalInsertedLink', + $result + ); + $this->assertStringContainsString( + 'InlineLink', + $result + ); + $this->assertStringContainsString( + 'ExternalInlineLink', + $result + ); + $this->assertStringContainsString( + '', + $result, + 'SSTemplateParser should only rewrite anchor hrefs' + ); + } finally { + $_SERVER = $oldServerVars; + } } public function testRewriteHashlinksInPhpMode() { SSViewer::setRewriteHashLinksDefault('php'); - - $tmplFile = TEMP_PATH . DIRECTORY_SEPARATOR . 'SSViewerTest_testRewriteHashlinksInPhpMode_' . sha1(rand()) . '.ss'; - - // Note: SSViewer_FromString doesn't rewrite hash links. - file_put_contents( - $tmplFile ?? '', + $engine = new DummyTemplateEngine(); + $engine->setOutput( ' - - <% base_tag %> - - InlineLink - $InsertedLink - - - ' + + + + InlineLink + InsertedLink + + + ' ); - $tmpl = new SSViewer($tmplFile); - $obj = new ModelData(); - $obj->InsertedLink = DBField::create_field( - 'HTMLFragment', - 'InsertedLink' - ); - $result = $tmpl->process($obj); + // Note: SSViewer_FromString doesn't rewrite hash links. + $tmpl = new SSViewer([], $engine); + $result = $tmpl->process('pretend this is a model'); $code = <<<'EOC' #anchor">InsertedLink @@ -2045,339 +219,10 @@ EOC; $result, 'SSTemplateParser should only rewrite anchor hrefs' ); - - unlink($tmplFile ?? ''); } - public function testRenderWithSourceFileComments() + private function assertEqualIgnoringWhitespace(string $a, string $b, string $message = ''): void { - SSViewer::config()->set('source_file_comments', true); - $i = __DIR__ . '/SSViewerTest/templates/Includes'; - $f = __DIR__ . '/SSViewerTest/templates/SSViewerTestComments'; - $templates = [ - [ - 'name' => 'SSViewerTestCommentsFullSource', - 'expected' => "" - . "" - . "" - . "" - . "\t" - . "\t" - . "" - . "", - ], - [ - 'name' => 'SSViewerTestCommentsFullSourceHTML4Doctype', - 'expected' => "" - . "" - . "" - . "" - . "\t" - . "\t" - . "" - . "", - ], - [ - 'name' => 'SSViewerTestCommentsFullSourceNoDoctype', - 'expected' => "" - . "" - . "\t" - . "\t" - . "", - ], - [ - 'name' => 'SSViewerTestCommentsFullSourceIfIE', - 'expected' => "" - . "" - . "" - . "" - . "" - . " " - . "\t" - . "\t" - . "" - . "", - ], - [ - 'name' => 'SSViewerTestCommentsFullSourceIfIENoDoctype', - 'expected' => "" - . "" - . "" - . " " - . "" - . " " - . "\t" - . "\t" - . "", - ], - [ - 'name' => 'SSViewerTestCommentsPartialSource', - 'expected' => - "" - . "
" - . "", - ], - [ - 'name' => 'SSViewerTestCommentsWithInclude', - 'expected' => - "" - . "
" - . "" - . "" - . "Included" - . "" - . "" - . "
" - . "", - ], - ]; - foreach ($templates as $template) { - $this->_renderWithSourceFileComments('SSViewerTestComments/' . $template['name'], $template['expected']); - } - } - private function _renderWithSourceFileComments($name, $expected) - { - $viewer = new SSViewer([$name]); - $data = new ArrayData([]); - $result = $viewer->process($data); - $expected = str_replace(["\r", "\n"], '', $expected ?? ''); - $result = str_replace(["\r", "\n"], '', $result ?? ''); - $this->assertEquals($result, $expected); - } - - public function testLoopIteratorIterator() - { - $list = new PaginatedList(new ArrayList()); - $viewer = new SSViewer_FromString('<% loop List %>$ID - $FirstName
<% end_loop %>'); - $result = $viewer->process(new ArrayData(['List' => $list])); - $this->assertEquals($result, ''); - } - - public function testProcessOnlyIncludesRequirementsOnce() - { - $template = new SSViewer(['SSViewerTestProcess']); - $basePath = $this->getCurrentRelativePath() . '/SSViewerTest'; - - $backend = Injector::inst()->create(Requirements_Backend::class); - $backend->setCombinedFilesEnabled(false); - $backend->combineFiles( - 'RequirementsTest_ab.css', - [ - $basePath . '/css/RequirementsTest_a.css', - $basePath . '/css/RequirementsTest_b.css' - ] - ); - - Requirements::set_backend($backend); - - $this->assertEquals(1, substr_count($template->process(new ModelData()) ?? '', "a.css")); - $this->assertEquals(1, substr_count($template->process(new ModelData()) ?? '', "b.css")); - - // if we disable the requirements then we should get nothing - $template->includeRequirements(false); - $this->assertEquals(0, substr_count($template->process(new ModelData()) ?? '', "a.css")); - $this->assertEquals(0, substr_count($template->process(new ModelData()) ?? '', "b.css")); - } - - public function testRequireCallInTemplateInclude() - { - if (FRAMEWORK_DIR === 'framework') { - $template = new SSViewer(['SSViewerTestProcess']); - - Requirements::set_suffix_requirements(false); - - $this->assertEquals( - 1, - substr_count( - $template->process(new ModelData()) ?? '', - "tests/php/View/SSViewerTest/javascript/RequirementsTest_a.js" - ) - ); - } else { - $this->markTestSkipped( - 'Requirement will always fail if the framework dir is not ' . - 'named \'framework\', since templates require hard coded paths' - ); - } - } - - public function testCallsWithArguments() - { - $data = new ArrayData( - [ - 'Set' => new ArrayList( - [ - new SSViewerTest\TestObject("1"), - new SSViewerTest\TestObject("2"), - new SSViewerTest\TestObject("3"), - new SSViewerTest\TestObject("4"), - new SSViewerTest\TestObject("5"), - ] - ), - 'Level' => new SSViewerTest\LevelTestData(1), - 'Nest' => [ - 'Level' => new SSViewerTest\LevelTestData(2), - ], - ] - ); - - $tests = [ - '$Level.output(1)' => '1-1', - '$Nest.Level.output($Set.First.Number)' => '2-1', - '<% with $Set %>$Up.Level.output($First.Number)<% end_with %>' => '1-1', - '<% with $Set %>$Top.Nest.Level.output($First.Number)<% end_with %>' => '2-1', - '<% loop $Set %>$Up.Nest.Level.output($Number)<% end_loop %>' => '2-12-22-32-42-5', - '<% loop $Set %>$Top.Level.output($Number)<% end_loop %>' => '1-11-21-31-41-5', - '<% with $Nest %>$Level.output($Top.Set.First.Number)<% end_with %>' => '2-1', - '<% with $Level %>$output($Up.Set.Last.Number)<% end_with %>' => '1-5', - '<% with $Level.forWith($Set.Last.Number) %>$output("hi")<% end_with %>' => '5-hi', - '<% loop $Level.forLoop($Set.First.Number) %>$Number<% end_loop %>' => '!0', - '<% with $Nest %> - <% with $Level.forWith($Up.Set.First.Number) %>$output("hi")<% end_with %> - <% end_with %>' => '1-hi', - '<% with $Nest %> - <% loop $Level.forLoop($Top.Set.Last.Number) %>$Number<% end_loop %> - <% end_with %>' => '!0!1!2!3!4', - ]; - - foreach ($tests as $template => $expected) { - $this->assertEquals($expected, trim($this->render($template, $data) ?? '')); - } - } - - public function testRepeatedCallsAreCached() - { - $data = new SSViewerTest\CacheTestData(); - $template = ' - <% if $TestWithCall %> - <% with $TestWithCall %> - {$Message} - <% end_with %> - - {$TestWithCall.Message} - <% end_if %>'; - - $this->assertEquals('HiHi', preg_replace('/\s+/', '', $this->render($template, $data) ?? '')); - $this->assertEquals( - 1, - $data->testWithCalls, - 'SSViewerTest_CacheTestData::TestWithCall() should only be called once. Subsequent calls should be cached' - ); - - $data = new SSViewerTest\CacheTestData(); - $template = ' - <% if $TestLoopCall %> - <% loop $TestLoopCall %> - {$Message} - <% end_loop %> - <% end_if %>'; - - $this->assertEquals('OneTwo', preg_replace('/\s+/', '', $this->render($template, $data) ?? '')); - $this->assertEquals( - 1, - $data->testLoopCalls, - 'SSViewerTest_CacheTestData::TestLoopCall() should only be called once. Subsequent calls should be cached' - ); - } - - public function testClosedBlockExtension() - { - $count = 0; - $parser = new SSTemplateParser(); - $parser->addClosedBlock( - 'test', - function ($res) use (&$count) { - $count++; - } - ); - - $template = new SSViewer_FromString("<% test %><% end_test %>", $parser); - $template->process(new SSViewerTest\TestFixture()); - - $this->assertEquals(1, $count); - } - - public function testOpenBlockExtension() - { - $count = 0; - $parser = new SSTemplateParser(); - $parser->addOpenBlock( - 'test', - function ($res) use (&$count) { - $count++; - } - ); - - $template = new SSViewer_FromString("<% test %>", $parser); - $template->process(new SSViewerTest\TestFixture()); - - $this->assertEquals(1, $count); - } - - /** - * Tests if caching for SSViewer_FromString is working - */ - public function testFromStringCaching() - { - $content = 'Test content'; - $cacheFile = TEMP_PATH . DIRECTORY_SEPARATOR . '.cache.' . sha1($content ?? ''); - if (file_exists($cacheFile ?? '')) { - unlink($cacheFile ?? ''); - } - - // Test global behaviors - $this->render($content, null, null); - $this->assertFalse(file_exists($cacheFile ?? ''), 'Cache file was created when caching was off'); - - SSViewer_FromString::config()->set('cache_template', true); - $this->render($content, null, null); - $this->assertTrue(file_exists($cacheFile ?? ''), 'Cache file wasn\'t created when it was meant to'); - unlink($cacheFile ?? ''); - - // Test instance behaviors - $this->render($content, null, false); - $this->assertFalse(file_exists($cacheFile ?? ''), 'Cache file was created when caching was off'); - - $this->render($content, null, true); - $this->assertTrue(file_exists($cacheFile ?? ''), 'Cache file wasn\'t created when it was meant to'); - unlink($cacheFile ?? ''); - } - - public function testPrimitivesConvertedToDBFields() - { - $data = new ArrayData([ - // null value should not be rendered, though should also not throw exception - 'Foo' => new ArrayList(['hello', true, 456, 7.89, null]) - ]); - $this->assertEqualIgnoringWhitespace( - 'hello 1 456 7.89', - $this->render('<% loop $Foo %>$Me<% end_loop %>', $data) - ); - } - - #[DoesNotPerformAssertions] - public function testMe(): void - { - $myArrayData = new class extends ArrayData { - public function forTemplate() - { - return ''; - } - }; - $this->render('$Me', $myArrayData); - } - - public function testLoopingThroughArrayInOverlay(): void - { - $modelData = new ModelData(); - $theArray = [ - ['Val' => 'one'], - ['Val' => 'two'], - ['Val' => 'red'], - ['Val' => 'blue'], - ]; - $output = $modelData->renderWith('SSViewerTestLoopArray', ['MyArray' => $theArray]); - $this->assertEqualIgnoringWhitespace('one two red blue', $output); + $this->assertEquals(preg_replace('/\s+/', '', $a ), preg_replace('/\s+/', '', $b), $message); } } diff --git a/tests/php/View/SSViewerTest/DummyTemplateEngine.php b/tests/php/View/SSViewerTest/DummyTemplateEngine.php new file mode 100644 index 000000000..9800aaf4d --- /dev/null +++ b/tests/php/View/SSViewerTest/DummyTemplateEngine.php @@ -0,0 +1,45 @@ +'; + + public function __construct(string|array $templateCandidates = []) + { + // no-op + } + + public function setTemplate(string|array $templateCandidates): static + { + return $this; + } + + public function hasTemplate(string|array $templateCandidates): bool + { + return true; + } + + public function renderString(string $template, ViewLayerData $model, array $overlay = [], bool $cache = true): string + { + return $this->output; + } + + public function render(ViewLayerData $model, array $overlay = []): string + { + return $this->output; + } + + public function setOutput(string $output): void + { + $this->output = $output; + } +} diff --git a/tests/php/View/SSViewerTest/TestFixture.php b/tests/php/View/SSViewerTest/TestFixture.php deleted file mode 100644 index f0abb39bc..000000000 --- a/tests/php/View/SSViewerTest/TestFixture.php +++ /dev/null @@ -1,72 +0,0 @@ -name = $name; - parent::__construct(); - } - - private function argedName($fieldName, $arguments) - { - $childName = $this->name ? "$this->name.$fieldName" : $fieldName; - if ($arguments) { - return $childName . '(' . implode(',', $arguments) . ')'; - } else { - return $childName; - } - } - - public function obj( - string $fieldName, - array $arguments = [], - bool $cache = false, - ?string $cacheName = null - ): ?object { - $childName = $this->argedName($fieldName, $arguments); - - // Special field name Loop### to create a list - if (preg_match('/^Loop([0-9]+)$/', $fieldName ?? '', $matches)) { - $output = new ArrayList(); - for ($i = 0; $i < $matches[1]; $i++) { - $output->push(new TestFixture($childName)); - } - return $output; - } else { - if (preg_match('/NotSet/i', $fieldName ?? '')) { - return new ModelData(); - } else { - return new TestFixture($childName); - } - } - } - - public function XML_val(string $fieldName, array $arguments = [], bool $cache = false): string - { - if (preg_match('/NotSet/i', $fieldName ?? '')) { - return ''; - } else { - if (preg_match('/Raw/i', $fieldName ?? '')) { - return $fieldName; - } else { - return '[out:' . $this->argedName($fieldName, $arguments) . ']'; - } - } - } - - public function hasValue(string $fieldName, array $arguments = [], bool $cache = true): bool - { - return (bool)$this->XML_val($fieldName, $arguments); - } -} diff --git a/tests/php/View/SSViewerTest/TestGlobalProvider.php b/tests/php/View/SSViewerTest/TestGlobalProvider.php deleted file mode 100644 index f005f24ce..000000000 --- a/tests/php/View/SSViewerTest/TestGlobalProvider.php +++ /dev/null @@ -1,51 +0,0 @@ - ['method' => 'get_html', 'casting' => 'HTMLFragment'], - 'SSViewerTest_GlobalHTMLEscaped' => ['method' => 'get_html'], - - 'SSViewerTest_GlobalAutomatic', - 'SSViewerTest_GlobalReferencedByString' => 'get_reference', - 'SSViewerTest_GlobalReferencedInArray' => ['method' => 'get_reference'], - - 'SSViewerTest_GlobalThatTakesArguments' => ['method' => 'get_argmix', 'casting' => 'HTMLFragment'], - 'SSViewerTest_GlobalReturnsNull' => 'getNull', - ]; - } - - public static function get_html() - { - return '
'; - } - - public static function SSViewerTest_GlobalAutomatic() - { - return 'automatic'; - } - - public static function get_reference() - { - return 'reference'; - } - - public static function get_argmix() - { - $args = func_get_args(); - return 'z' . implode(':', $args) . 'z'; - } - - public static function getNull() - { - return null; - } -} diff --git a/tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsWithInclude.ss b/tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsWithInclude.ss deleted file mode 100644 index 1a3cb8443..000000000 --- a/tests/php/View/SSViewerTest/templates/SSViewerTestComments/SSViewerTestCommentsWithInclude.ss +++ /dev/null @@ -1 +0,0 @@ -
<% include SSViewerTestCommentsInclude %>
diff --git a/tests/php/View/SSViewerTest/templates/SSViewerTestIncludeScopeInheritance.ss b/tests/php/View/SSViewerTest/templates/SSViewerTestIncludeScopeInheritance.ss deleted file mode 100644 index 6c106c703..000000000 --- a/tests/php/View/SSViewerTest/templates/SSViewerTestIncludeScopeInheritance.ss +++ /dev/null @@ -1,3 +0,0 @@ -<% loop Items %> - <% include SSViewerTestIncludeScopeInheritanceInclude %> -<% end_loop %> diff --git a/tests/php/View/SSViewerTest/templates/SSViewerTestIncludeScopeInheritanceWithArgs.ss b/tests/php/View/SSViewerTest/templates/SSViewerTestIncludeScopeInheritanceWithArgs.ss deleted file mode 100644 index d897bf044..000000000 --- a/tests/php/View/SSViewerTest/templates/SSViewerTestIncludeScopeInheritanceWithArgs.ss +++ /dev/null @@ -1,3 +0,0 @@ -<% loop Items %> - <% include SSViewerTestIncludeScopeInheritanceInclude ArgA=$Title %> -<% end_loop %> diff --git a/tests/php/View/SSViewerTest/templates/SSViewerTestProcess.ss b/tests/php/View/SSViewerTest/templates/SSViewerTestProcess.ss deleted file mode 100644 index 60561e017..000000000 --- a/tests/php/View/SSViewerTest/templates/SSViewerTestProcess.ss +++ /dev/null @@ -1,6 +0,0 @@ - - <% include SSViewerTestProcessHead %> - - - - diff --git a/tests/php/View/SSViewerTest/themes/layouttest/templates/TestNamespace/SSViewerTestModel_Controller.ss b/tests/php/View/SSViewerTest/themes/layouttest/templates/TestNamespace/SSViewerTestModel_Controller.ss deleted file mode 100644 index e4284ad10..000000000 --- a/tests/php/View/SSViewerTest/themes/layouttest/templates/TestNamespace/SSViewerTestModel_Controller.ss +++ /dev/null @@ -1 +0,0 @@ -SSViewerTest diff --git a/tests/php/i18n/i18nTestManifest.php b/tests/php/i18n/i18nTestManifest.php index d2fd62a13..2a8bcfb9e 100644 --- a/tests/php/i18n/i18nTestManifest.php +++ b/tests/php/i18n/i18nTestManifest.php @@ -17,10 +17,10 @@ use SilverStripe\i18n\Tests\i18nTest\MyObject; use SilverStripe\i18n\Tests\i18nTest\MySubObject; use SilverStripe\i18n\Tests\i18nTest\TestDataObject; use SilverStripe\View\SSViewer; -use SilverStripe\View\SSViewer_DataPresenter; use SilverStripe\View\ThemeResourceLoader; use SilverStripe\View\ThemeManifest; use SilverStripe\Model\ModelData; +use SilverStripe\View\SSViewer_Scope; use Symfony\Component\Translation\Loader\ArrayLoader; use Symfony\Component\Translation\Translator; @@ -71,9 +71,9 @@ trait i18nTestManifest public function setupManifest() { - // force SSViewer_DataPresenter to cache global template vars before we switch to the + // force SSViewer_Scope 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 ModelData()); + $presenter = new SSViewer_Scope(new ModelData()); unset($presenter); // Switch to test manifest