Skip to content

DOC Add parameter naming code convention #782

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

Merged
merged 1 commit into from
Jul 17, 2025
Merged

DOC Add parameter naming code convention #782

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 4 additions & 0 deletions en/10_Contributing/05_Coding_Conventions/01_PHP_Coding_Conventions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,10 @@ Use an appropriate suffix or prefix for classnames when making a subclass or imp
- Prefer `private` over `protected` for non-public constants, unless they are intended to be used in subclasses.
- If someone requests a `private` method, property, or constant be made `protected` so that they can use it in their project or module code, that change should be made unless there's a really good reason not to.

## Parameter naming

- When adding new paramaters to a method which are then used to set properties on the class, which is very common for constructors, the parameter names should match the properties that are being set e.g. use a `string $myValue` parameter if it's going to set a `private string $myValue` property.

## Interfaces

- Create an interface for type hinting if there are (or are likely to be in the future) multiple classes implementing a specific feature. Use the interface for type hints (for example for parameters, properties, and return types), and as the service key for injector.
Expand Down