[GH-8334] PHP do not display override hint for constructors

[NReib]

The following leads to a compile error in PHP - so we should not display the Add Override hint for constructors.

<?php
class newPHPClass {

    public function __construct() {

    }
}

class newPHPClass1 extends newPHPClass {
    #[\Override]
    public function __construct() {
        parent::__construct();
    }
}

$anon = new class extends newPHPClass {
    #[\Override]
    public function __construct() {
        parent::__construct();
    }
};

Before:

After:

---

^Add meaningful description above

Click to collapse/expand PR instructions

By opening a pull request you confirm that, unless explicitly stated otherwise, the changes -

• are all your own work, and you have the right to contribute them.
• are contributed solely under the terms and conditions of the Apache License 2.0 (see section 5 of the license for more information).

Please make sure (eg. git log) that all commits have a valid name and email address for you in the Author field.

If you're a first time contributor, see the Contributing guidelines for more information.

If you're a committer, please label the PR before pressing "Create pull request" so that the right test jobs can run.

PR approval and merge checklist:

1. Was this PR correctly labeled, did the right tests run? When did they run?
2. Is this PR squashed?
3. Are author name / email address correct? Are co-authors correctly listed? Do the commit messages need updates?
4. Does the PR title and description still fit after the Nth iteration? Is the description sufficient to appear in the release notes?

If this PR targets the delivery branch: don't merge. (full wiki article)

[NReib]

I am receiving a mail "PR run failed" regarding this. What is the meaning of this? It seems to be related to github actions, which I am not familiar with.

NetBeans, Attempt #2 / Check Paperwork on Linux/JDK 17
Failed in 12 minutes and 27 seconds

[matthiasblaesing]

@NReib the unittests are not fully stable, so some of them run with retries. You see the fallout of this. If you have commit rights on the repo you can rerun checks from the "Checks" page of the corresponding PR, else you can at least see what failed.

When you look at the checks page right now, it shows, that all tests ran clean (now).

[matthiasblaesing]

@NReib please check if you can add a unittest for this (I bet @junichi11 would/will say the same). Have a look at org.netbeans.modules.php.editor.verification.AddOverrideAttributeHintTest. If you look at the first test (testImplementsInterface_01) you can glimpse the idea:

The unittests is just a call to checkHints. That call takes the name of a PHP file. The infratracture deduces from the test method and the target filename the name of a "golden" file. The idea here is, that the hinting infrastructure is run on the target file and the result is dumped into the golden file. On the first run the dump is checked manually, then checked in and in the future it is used as validation, that there are no regressions.

For the referenced case, look at:

• php/php.editor/test/unit/data/testfiles/verification/AddOverrideAttributeHint/testImplementsInterface.php
• php/php.editor/test/unit/data/testfiles/verification/AddOverrideAttributeHint/testImplementsInterface.php.testImplementsInterface_01.hints

You can experiment by removing the .hints file and see what happens when you run the test (it is expected, that the first run is reported as failed).

[matthiasblaesing]

@NReib you'll need to run the test locally, run it twice, on the first run it will fail (generating the hints file), the second run should be clean. Then check the generated hints file, if it looks sane to you. If it does, add and commit it.

[NReib]

@matthiasblaesing thank you for the detailed description. Luckily I already knew how to do that from my first pull request here :) Just struggled to include the generated file to the commit...
Do you receive a message everytime I push something to my pull request?

[junichi11]

Please add screenshots before and after. Thanks!

[junichi11]

@NReib Please use 4 spaces for the example of the commit message and remove the PHPDoc if unnecessary.

[junichi11]

Please add screenshots to not a comment but the description. Thanks!

[junichi11]

Thank you for your work!