DOC Document changes to template layer #591

GuySartorelli · 2024-09-26T04:27:33Z

Issue

Abstract template layer into its own dedicated module silverstripe-framework#11322

en/02_Developer_Guides/01_Templates/01_Syntax.md

en/02_Developer_Guides/01_Templates/09_Casting.md

en/02_Developer_Guides/15_Customising_the_Admin_Interface/04_Preview.md

en/08_Changelogs/6.0.0.md

emteknetnz · 2024-10-15T02:14:32Z

en/02_Developer_Guides/01_Templates/01_Syntax.md

+
+Just like in PHP, method names are case insensitive, but property names are case sensitive.
+
+Using `$MyValue` in a template will successfully call a `myValue()` method, or a `getMyvalue()` method even though the case doesn't match what you used in the template. But it *will not* match a `myValue` property or database field because the case doesn't match.


Suggested change

Using `$MyValue` in a template will successfully call a `myValue()` method, or a `getMyvalue()` method even though the case doesn't match what you used in the template. But it *will not* match a `myValue` property or database field because the case doesn't match.

Using `$MyValue` in a template will successfully call a `myValue()` method, or a `getMyValue()` method even though the case doesn't match what you used in the template. But it *will not* match a `myValue` property or database field because the case doesn't match.

Done (found an unrelated method with the same bad casing in php coding conventions which I also updated)

emteknetnz · 2024-10-15T02:27:52Z

en/08_Changelogs/6.0.0.md

@@ -459,6 +459,62 @@ Note that the `SilverStripe\View\ViewableData` class has been renamed to [`Silve

 See [many renamed classes](#renamed-classes) for more information about this change.

+#### Improved separation between the view and model layers {#view-layer-separation}
+
+Historically the `ModelData` class did double-duty as being the base class for most models as well as being the presumed class wrapping data for the template layer. Part of this included methods like `XML_val()` being called on any object in the template layer, despite being methods very specifically implemented on `ModelData`.


Historically it's been called ViewableData ? Maybe mention that ModelData used to be called ViewableData

Directly above this it says

Note that the SilverStripe\View\ViewableData class has been renamed to SilverStripe\Model\ModelData. We will refer to it as ModelData in the rest of these change logs.

emteknetnz · 2024-10-25T01:39:30Z

en/02_Developer_Guides/01_Templates/04_Rendering_Templates.md

@@ -6,6 +6,9 @@ icon: code

 # Rendering data to a template

+> [!NOTE]
+> The template syntax, file extensions, and specifics about which tempaltes are chosen from a set as described on this page are specific to the default [`SSTemplateEngine`](api:SilverStripe\View\SSTemplateEngine) - but many of the concepts here (especially the PHP code) should work with any template engine you choose to use.


Suggested change

> The template syntax, file extensions, and specifics about which tempaltes are chosen from a set as described on this page are specific to the default [`SSTemplateEngine`](api:SilverStripe\View\SSTemplateEngine) - but many of the concepts here (especially the PHP code) should work with any template engine you choose to use.

> The template syntax, file extensions, and specifics about which templates are chosen from a set as described on this page are specific to the default [`SSTemplateEngine`](api:SilverStripe\View\SSTemplateEngine) - but many of the concepts here (especially the PHP code) should work with any template engine you choose to use.

emteknetnz · 2024-10-25T01:41:36Z

en/02_Developer_Guides/01_Templates/04_Rendering_Templates.md

@@ -194,5 +203,62 @@ class MyPageController extends PageController
 }
 ```

-> [!WARNING]
-> A common mistake is trying to loop over an array directly in a template - this won't work. You'll need to wrap the array in some `ModelData` instance as mentioned above.
+Or wrap the data in a `ModelData` subclass:


Suggested change

Or wrap the data in a `ModelData` subclass:

Or wrap the data in a `ModelData` subclass such as `ArrayList`:

Done, but said ArrayData since that's what the example shows.

emteknetnz · 2024-10-25T01:45:11Z

en/02_Developer_Guides/01_Templates/07_Caching.md

+
+Every time a raw template file is processed, some PHP code is generated from it which is then executed to produce the final rendered result.
+
+That PHP code is stored in the filesystem so that the raw template file doesn't need to be processed again until either the cache is flushed or the raw template file is updated.


Suggested change

That PHP code is stored in the filesystem so that the raw template file doesn't need to be processed again until either the cache is flushed or the raw template file is updated.

That PHP code is cached in the filesystem so that the raw template file doesn't need to be processed again until either the cache is flushed or the raw template file is updated.

Just ties it together a little better

GuySartorelli marked this pull request as draft September 26, 2024 04:27

GuySartorelli mentioned this pull request Sep 26, 2024

Abstract template layer into its own dedicated module silverstripe/silverstripe-framework#11322

Open

23 tasks

GuySartorelli force-pushed the pulls/6/refactor-template-layer branch 3 times, most recently from 94d90fe to 827cb70 Compare October 4, 2024 00:21

GuySartorelli force-pushed the pulls/6/refactor-template-layer branch 8 times, most recently from a6f45e5 to fd791b5 Compare October 14, 2024 02:57

GuySartorelli force-pushed the pulls/6/refactor-template-layer branch from fd791b5 to a23cf76 Compare October 22, 2024 00:11

GuySartorelli marked this pull request as ready for review October 23, 2024 02:37

GuySartorelli commented Oct 23, 2024

View reviewed changes

emteknetnz requested changes Oct 25, 2024

View reviewed changes

DOC Document changes to template layer

ecd38db

GuySartorelli force-pushed the pulls/6/refactor-template-layer branch from a23cf76 to ecd38db Compare October 29, 2024 21:03

emteknetnz approved these changes Oct 30, 2024

View reviewed changes

emteknetnz merged commit 9f14ed6 into silverstripe:6 Oct 30, 2024
3 checks passed

emteknetnz deleted the pulls/6/refactor-template-layer branch October 30, 2024 21:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC Document changes to template layer #591

DOC Document changes to template layer #591

GuySartorelli commented Sep 26, 2024

emteknetnz Oct 15, 2024

GuySartorelli Oct 29, 2024

emteknetnz Oct 15, 2024

GuySartorelli Oct 29, 2024

emteknetnz Oct 25, 2024

GuySartorelli Oct 29, 2024

emteknetnz Oct 25, 2024

GuySartorelli Oct 29, 2024

emteknetnz Oct 25, 2024

emteknetnz Oct 25, 2024

GuySartorelli Oct 29, 2024


		Just like in PHP, method names are case insensitive, but property names are case sensitive.

		Using `$MyValue` in a template will successfully call a `myValue()` method, or a `getMyvalue()` method even though the case doesn't match what you used in the template. But it will not match a `myValue` property or database field because the case doesn't match.

	> The template syntax, file extensions, and specifics about which tempaltes are chosen from a set as described on this page are specific to the default [`SSTemplateEngine`](api:SilverStripe\View\SSTemplateEngine) - but many of the concepts here (especially the PHP code) should work with any template engine you choose to use.
	> The template syntax, file extensions, and specifics about which templates are chosen from a set as described on this page are specific to the default [`SSTemplateEngine`](api:SilverStripe\View\SSTemplateEngine) - but many of the concepts here (especially the PHP code) should work with any template engine you choose to use.

	Or wrap the data in a `ModelData` subclass:
	Or wrap the data in a `ModelData` subclass such as `ArrayList`:


		Every time a raw template file is processed, some PHP code is generated from it which is then executed to produce the final rendered result.

		That PHP code is stored in the filesystem so that the raw template file doesn't need to be processed again until either the cache is flushed or the raw template file is updated.

	That PHP code is stored in the filesystem so that the raw template file doesn't need to be processed again until either the cache is flushed or the raw template file is updated.
	That PHP code is cached in the filesystem so that the raw template file doesn't need to be processed again until either the cache is flushed or the raw template file is updated.

DOC Document changes to template layer #591

DOC Document changes to template layer #591

Conversation

GuySartorelli commented Sep 26, 2024

Issue

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment