ENH Improve type safety to support refactored template layer #3010
+101
−31
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closed
23 tasks
GuySartorelli
force-pushed
the
pulls/6/refactor-template-layer
branch
3 times, most recently
from
dc43d36
to
cde12fa
Compare
GuySartorelli
force-pushed
the
pulls/6/refactor-template-layer
branch
5 times, most recently
from
51186ef
to
1a5eab0
Compare
GuySartorelli
commented
Oct 10, 2024
Comment on lines
295
to
301
| public function Menu($level) | ||
| { | ||
| return $this->getMenu($level); | ||
| } |
There was a problem hiding this comment.
This method only exists to work around the fact that $Menu(2) doesn't pass the 2 arg to getMenu().
I've changed it so that the args are passed into getters, so this method isn't needed anymore.
GuySartorelli
commented
Oct 10, 2024
Comment on lines
422
to
415
| $templatesFound[] = SSViewer::get_templates_by_class(static::class, $action, Controller::class); | ||
| $templatesFound[] = SSViewer::get_templates_by_class(static::class, $action ?? '', Controller::class); |
There was a problem hiding this comment.
$action isn't typed, and null is pretty common to say "there's no action" so just a bit of type safety here.
GuySartorelli
force-pushed
the
pulls/6/refactor-template-layer
branch
from
1a5eab0
to
fe90886
Compare
GuySartorelli
force-pushed
the
pulls/6/refactor-template-layer
branch
from
fe90886
to
6157338
Compare
GuySartorelli
force-pushed
the
pulls/6/refactor-template-layer
branch
from
6157338
to
db61732
Compare
GuySartorelli
commented
Oct 23, 2024
Comment on lines
-293
to
-301
| /** | ||
| * @return ArrayList<SiteTree> | ||
| * @deprecated 5.4.0 Use getMenu() instead. You can continue to use $Menu in templates. | ||
| */ | ||
| public function Menu($level) | ||
| { | ||
| Deprecation::noticeWithNoReplacment('5.4.0', 'Use getMenu() instead. You can continue to use $Menu in templates.'); | ||
| return $this->getMenu($level); | ||
| } |
There was a problem hiding this comment.
This isn't needed anymore. It existed because you couldn't pass args into getters from a template using $Menu(2) syntax.
I've resolved that - the args now get passed through to the getter.
GuySartorelli
commented
Oct 23, 2024
| // Find templates for the controller + action together - e.g. PageController_action.ss | ||
| $templatesFound[] = SSViewer::get_templates_by_class(static::class, $action, Controller::class); | ||
| // Find templates for the controller + action together - e.g. PageController_action | ||
| $templatesFound[] = SSViewer::get_templates_by_class(static::class, $action ?? '', Controller::class); |
There was a problem hiding this comment.
$action isn't strongly typed so I've added a little type safety here.
GuySartorelli
commented
Oct 23, 2024
|
|
||
| $templates = array_merge(...$templatesFound); | ||
| return SSViewer::create($templates); | ||
| return SSViewer::create($templates, $this->getTemplateEngine()); |
There was a problem hiding this comment.
See Controller::getTemplateEngine() in the framework PR
GuySartorelli
commented
Oct 23, 2024
| 'content' => $this->obj('Title')->forTemplate() | ||
| 'content' => $this->obj('Title')?->forTemplate() |
There was a problem hiding this comment.
obj() can return null
emteknetnz
approved these changes
Oct 30, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue