PHP 8.4 Property hooks.

[dcolt]

Hi, I'm trying to use property hooks in my projects, and currently I'm having the issue that phpcs (Generic.WhiteSpace.ScopeIndent) incorrectly seems to handle control structures inside the hooks.

Is there anyone else who has been running into this issue and found a working solution?

Using the full example from the php manual

<?php
class Example
{
    private bool $modified = false;

    public string $foo = 'default value' {
        get {
            if ($this->modified) {
                return $this->foo . ' (modified)';
            }
            return $this->foo;
        }
        set(string $value) {
            $this->foo = strtolower($value);
            $this->modified = true;
        }
    }
}

$example = new Example();
$example->foo = 'changed';
print $example->foo;
?>

phpcs thinks it should be formatted the following way:

<?php
class Example
{
    private bool $modified = false;

    public string $foo = 'default value' {
        get {
    if ($this->modified) {
        return $this->foo . ' (modified)';
    }
            return $this->foo;
        }
        set(string $value) {
            $this->foo = strtolower($value);
            $this->modified = true;
        }
    }
}

$example = new Example();
$example->foo = 'changed';
print $example->foo;
?>

Reported error from bin/phpcs --standard=Generic --sniffs=Generic.WhiteSpace.ScopeIndent:

-------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
-------------------------------------------------------------------------
  8 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 12
 10 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 12
-------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------------------------------------------------------------

[derrabus]

See #734.

[dcolt]

So in short.

1. it's not currently existing/working.
2. It's been an open issue since November 2024
3. No current active development on it? But PRs welcome?

[jrfnl]

@dcolt Before development can start, it needs an (approved) design on how property hooks should be tokenized for PHPCS to not break existing sniffs. Submitting a PR for this, is not the way to do things as it will hinder the discussion about the design.

[dcolt]

@jrfnl Thank you for the reply, then I at least have a decent idea of understanding where it would need to start.

How much can the current test suite be trusted to not break anything, assuming I would work on a proposal and POC implementation based on the design?

[jrfnl]

How much can the current test suite be trusted to not break anything, assuming I would work on a proposal and POC implementation based on the design?

You can't ever rely on the current test suite for gauging breakage caused by new PHP syntaxes as the tests will not contain code using the new syntax yet.