Skip to content
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.

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

Make all hook params consistent #376

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

Conversation

Tastaturberuf
Copy link
Contributor

No description provided.

@fritzmg
Copy link
Contributor

fritzmg commented May 25, 2020

I would like to stay consistent. In one hook we now have ModuleModel $model and Module $module.

So here it should either be PageModel $model and PageRegular $page or PageModel $pageModel and PageRegular $pageRegular.

@Tastaturberuf
Copy link
Contributor Author

Ah i know what you mean. i will check all hooks and push it in this PR. My goal is to be consistent too.

@Tastaturberuf Tastaturberuf changed the title simplify page model params Make all hook params consistent May 25, 2020
@Tastaturberuf Tastaturberuf marked this pull request as draft May 27, 2020 08:36
@Tastaturberuf
Copy link
Contributor Author

Tastaturberuf commented May 28, 2020

Here is an overview with all Contao hooks: https://gist.github.com/Tastaturberuf/8851fc3348dcc229f4a49d81bc9220d0

On first sign i think we should suffix all models with Model to make clear what it is.

e.g.
https://docs.contao.org/dev/reference/hooks/getPageLayout/
https://docs.contao.org/dev/reference/hooks/getFrontendModule/

Base automatically changed from master to main January 22, 2021 12:03
@fritzmg
Copy link
Contributor

fritzmg commented Nov 10, 2024

@Tastaturberuf not sure you'd still be working on this - but: in Contao itself we usually use just $page for a PageModel for example. So I think we should do the same in the docs (I have adjusted the getPageLayout hook accordingly).

Regarding the getFrontendModule case: there I think it makes sense to just use $model and $module as this hook specifically handles modules and thus you only have to distinguish this way.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants