Closes #7125: PHPStan: Ensure no hooks are present inside the ORM logic

[Miraeld]

Description

Fixes #7125
Nothing impacts the user.

Type of change

• Enhancement (non-breaking change which improves an existing functionality).
• Sub-task of PHPStan - Add Custom rules #7122

Detailed scenario

N/a

Technical description

Documentation

This pull request introduces a new PHPStan rule to ensure hooks are not used in ORM classes. It includes updates to the phpstan-baseline.neon and phpstan.neon.dist configuration files, as well as new test cases to verify the rule's functionality.

New PHPStan Rule:

• tests/phpstan/Rules/NoHooksInORM.php: Added a new rule NoHooksInORM to prevent the use of hooks in ORM classes.

Configuration Updates:

• phpstan-baseline.neon: Updated to include new error messages related to the NoHooksInORM rule. [1] [2] [3]
• phpstan.neon.dist: Added the NoHooksInORM rule to the list of PHPStan rules.

Test Cases:

• tests/phpstan/tests/Rules/NoHooksInORMTest.php: Added tests to verify that the NoHooksInORM rule correctly identifies the use of hooks in ORM classes.
• tests/phpstan/tests/data/NoHooksInORMTest/orm-class-with-hooks.php: Added a test class that includes hooks to ensure the rule triggers an error.
• tests/phpstan/tests/data/NoHooksInORMTest/orm-class-without-hooks.php: Added a test class without hooks to ensure the rule does not trigger an error.

Additional Changes:

• tests/phpstan/tests/bootstrap.php: Added a bootstrap file for the tests.
• tests/phpstan/tests/phpunit.xml: Added a PHPUnit configuration file for running the tests.

New dependencies

N/a

Risks

N/a

Mandatory Checklist

Code validation

• I validated all the Acceptance Criteria. If possible, provide screenshots or videos.
• I triggered all changed lines of code at least once without new errors/warnings/notices.
• I implemented built-in tests to cover the new/changed code.

Code style

• I wrote a self-explanatory code about what it does.
• I protected entry points against unexpected inputs.
• I did not introduce unnecessary complexity.
• Output messages (errors, notices, logs) are explicit enough for users to understand the issue and are actionnable.

[codacy-production]

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
Report missing for a8a58761	✅ ∅ (target: 50.00%)

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (a8a5876)	Report Missing	Report Missing	Report Missing
Head commit (0ffa9bc)	38228	16731	43.77%

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#7152)	0	0	∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

_{Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more}

Footnotes

1. Codacy didn't receive coverage data for the commit, or there was an error processing the received data. Check your integration for errors and validate that your coverage setup is correct. ↩