Skip to content

Make all hook params consistent #376

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Make all hook params consistent #376

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3bda1ce
simplify page model param
Tastaturberuf May 25, 2020
3b021e1
simplify page model param
Tastaturberuf May 25, 2020
ebbc9dc
simplify template param
Tastaturberuf May 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/dev/reference/hooks/generatePage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ and does not expect a return value.

## Parameters

1. *\Contao\PageModel* `$pageModel`
1. *\Contao\PageModel* `$page`

The current page object.

Expand Down Expand Up @@ -45,7 +45,7 @@ class GeneratePageListener implements ServiceAnnotationInterface
/**
* @Hook("generatePage")
*/
public function onGeneratePage(PageModel $pageModel, LayoutModel $layout, PageRegular $pageRegular): void
public function onGeneratePage(PageModel $page, LayoutModel $layout, PageRegular $pageRegular): void
{
// Do something …
}
Expand Down
4 changes: 2 additions & 2 deletions docs/dev/reference/hooks/getPageLayout.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ and does not expect a return value.

## Parameters

1. *\Contao\PageModel* `$pageModel`
1. *\Contao\PageModel* `$page`

The page model instance.

Expand Down Expand Up @@ -46,7 +46,7 @@ class GetPageLayoutListener implements ServiceAnnotationInterface
/**
* @Hook("getPageLayout")
*/
public function onGetPageLayout(PageModel $pageModel, LayoutModel $layout, PageRegular $pageRegular): void
public function onGetPageLayout(PageModel $page, LayoutModel $layout, PageRegular $pageRegular): void
{
// Modify the page or layout object
}
Expand Down
6 changes: 3 additions & 3 deletions docs/dev/reference/hooks/modifyFrontendPage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ insert tags, use the [`outputFrontendTemplate`](../outputFrontendTemplate) hook

Content of the rendered front end template.

2. *string* `$templateName`
2. *string* `$template`

The template name (e.g. `fe_page`) without file extension.

Expand All @@ -50,9 +50,9 @@ class ModifyFrontendPageListener implements ServiceAnnotationInterface
/**
* @Hook("modifyFrontendPage")
*/
public function onModifyFrontendPage(string $buffer, string $templateName): string
public function onModifyFrontendPage(string $buffer, string $template): string
{
if ('fe_page' === $templateName) {
if ('fe_page' === $template) {
// Modify $buffer
}

Expand Down