PHP 8.4 Support: Property hooks

[junichi11]

• PHP 8.4 Support #8035
• https://wiki.php.net/rfc#php_84
• https://wiki.php.net/rfc/property-hooks

PHP 8.4 Support: Property hooks (Part 1)

• Fix the lexer and parser(grammar)
• Add PropertyHookDeclaration as an ASTNode
• Fix PHP5ErrorHandlerImpl (handle missing tokens)
• Fix/Add unit tests for the lexer and parser
• Remove ArrayDimensionSyntaxSuggestionHint because this no longer works.

Example:

class PropertyHooksClass {
    public int $backed = 100 {
        get {
            return $this->backed;
        }
        set {
            $this->backed = $value;
        }
    }
    public $doubleArrow { // virtual
        get => $this->test();
        set => $this->test() . $value;
    }
    public $attributes {
        #[Attr1] get {}
        #[Attr2] set ($value) {
            $this->attributes = $value;
        }
    }
    public $reference {
        &get => $this->reference;
    }
    public $final {
        final get => $this->final;
    }

    // constructor property promotion
    public function __construct(
        public $prop {
            get {
                return $this->prop;
            }
            set {
                $this->prop = $value;
            }
        }
    ) {}
}

class Child extends PropertyHooksClass {
    public $prop {
        get => parent::$prop::get();
        set {
            parent::$prop::set($value);
        }
    }
}

interface PropertyHooksInterface {
    public string $prop1 {
        get;
    }
    public int $prop2 {
        set;
    }
    public $prop3 {
        get;
        set;
    }
    public $ref { &get; }
}

Note: Curly braces array access ({} e.g. $array{1}, $array{'key'}) can use no longer.
Because a conflict occurs in the following case:

"string"{1};
public string $prop = "string" {
    get => $this->prop;
    set {}
}

PHP 8.4

PHP 8.3

PHP 8.4 Support: Property hooks (Part 2)

• Fix the indexer and the model
• Use JSON format as a signature for property hooks
• Current format is semicolon separated but it's hard to add hooks to a field signature without JSON format

[
    {
        "name":"set",
        "start":3651,
        "end":3690,
        "mod":1,
        "isRef":false,
        "isAttr":false,
        "hasBody":true,
        "paramSig":"$value::0::1:1:0:0:0:0::"
    }
]

• Add interface methods

  • FieldElemnt.isHooked()
  • FieldElement.HookedFieldElemnt.isHooked()
  • FieldElement.HookedFieldElemnt.getPropertyHooks()
  • IndexScope.PHP84IndexScope.findFields()
  • TypeScope.FieldDeclarable.getDeclaredFields()
  • TypeScope.FieldDeclarable.getInheritedFields()
  • PropertyHookScope.isReference()
  • PropertyHookScope.hasBody()
  • PropertyHookScope.isAttributed()
  • PropertyHookScope.getParameterNames()
  • PropertyHookScope.getParameters()
  • PropertyHookScope.getOffsetRange()
  • PropertyHookElement.isReference()
  • PropertyHookElement.hasBody()
  • PropertyHookElement.isAttributed()
  • PropertyHookElement.getParameters()
  • PropertyHookElement.getOffsetRange()

• Add/Fix unit tests for the index and the model

PHP 8.4 Support: Property hooks (Part 3)

• Fix the navigator
• Fix/Add unit tests
• Add SVG icons for a property hook, a trait, and an enum case

PHP 8.4 Support: Property hooks (Part 4)

• Fix the folding feature
• Add unit tests

Expanded:

Collapsed:

PHP 8.4 Support: Property hooks (Part 5)

• Fix the formatter and PhpTypedBreakInterceptor
• New Formatting Options
  • Braces
    • Field Declaration (Same Line by default)
    • Property Hook (Same Line by default)
  • Blank Lines
    • Between Property Hooks (0 by default)
    • Empty Property Hook Body (Unchecked by default)
  • Spaces
    • Before Left Braces
      • Field Declaration (Checked by default)
      • Property Hook Declaration (Checked by default)
• Add unit tests

Example:

class PropertyHookClass {
    public string $prop1 {get{} set{}}
    public string $prop2 {
        get{return $this->prop2;}
        set{$this->prop2 = $value;}
    }
}

interface PropertyHookInterface {
    public string $prop1 {get; set;}
}

Formatted:

class PropertyHookClass {

    public string $prop1 {
        get {}
        set {}
    }
    public string $prop2 {
        get {
            return $this->prop2;
        }
        set {
            $this->prop2 = $value;
        }
    }
}

interface PropertyHookInterface {

    public string $prop1 {
        get;
        set;
    }
}

[junichi11]

@tmysik This is not done yet. I'm slowly going to add more commits to this PR. Could you please have a look at each commit when you have time?

[junichi11]

Time out occurs in Windows tests. I'll try adding commits one by one.

• The first commit is OK
• The second commit has a problem. But I'm not sure...

[junichi11]

@tmysik Please ignore this. I'll try to investigate this later...

[junichi11]

@tmysik It should be OK now. Probably, the cause is "Jackson". Instead, I used "JSON simple".

[tmysik]

Nitpick:

Suggested change

	List<PropertyHookElement> elements = new ArrayList<>();
	List<PropertyHookElement> elements = new ArrayList<>(signatureItems.size());

[junichi11]

Will fix it.

[junichi11]

Fixed: https://github.com/apache/netbeans/compare/33472a7a8c8a28e0896c06e55d656b1e9a9cd648..b7eb3b4cbfc2e915ecc84335650f39ea145074e6

[tmysik]

I did a very quick review, and it looks good to me. Thanks for changing the code to the modern one, e.g. the switches :)

[junichi11]

Fix folding feature: 8cff930

[junichi11]

IMPLICIT_PUBLIC is better if mod is 0 because the public modifier doesn't exist.

[junichi11]

There is a bug here:
e.g.

class C { // expected curly brace
    public function test() { // but found this brace
    }
^} // caret position

Instead, find a correct brace via the new method (findCurlyOpenOffset()).

[junichi11]

This is an existing bug. I didn't fix it (maybe, the priority is very low) because I don't think the New Line Indented option is important.

We can also reproduce this using a method.

class C {
    public function example() { return 100;}
}

[tmysik]

@junichi11, please, let me know once this PR is ready for the review (no rush!). Thank you.

[junichi11]

@tmysik OK. I'll do that after I fix the other features(Hints, CC, Go to Declaration, etc.) :)

[tmysik]

@junichi11, as I wrote, take your time, it is a very complex feature. Thank you