Include Template can't read parent's variables

[dylangrech92]

4.6.2

Description

I have to explicitly pass variables to Include templates when using renderWith().
Is this the correct behaviour?

Steps to Reproduce

return $this->renderWith('MyTemplate', [
    'MyVar' => new MyClass()
]);

This works

MyTemplate.ss

<p>$MyVar.SomeMethod</p>

This doesn't work

MyTemplate.ss 
<% include MyInclude %>

MyInclude.ss
<p>$MyVar.SomeMethod</p>

This works

MyTemplate.ss 
<% include MyInclude MyVar=$MyVar %>

MyInclude.ss
<p>$MyVar.SomeMethod</p>

[kinglozzer]

Just out of curiosity - does this behave differently if you use:

return $this->customise([
    'MyVar' => new MyClass()
])->renderWith('MyTemplate');

[dhensby]

I believe this is by design

[lerni]

related? to #8580 (comment) and also links to "by design".

[dhensby]

I'm not sure those two are related, but includes are not meant to inherit scope; their context needs to be passed in as show in the "this works" section.

I even had this "problem" way back in ss3, I think. It's not necessarily intuitive (as in PHP an "include" will inherit the variables declared in scope), but the templates aren't PHP and I don't think there's any desire from maintainers to change this behaviour especially when a thought out and reasonable decision was made at the time to explicitly exclude the external scope.

As such, I'm going to close this issue

[dylangrech92]

Thanks for the clarifications guys, it's ok that it's by design just something to keep in mind moving forward :)

Thanks again.