PHP 8.4 Support: Property hooks (Part 7)

- apache#8035
- https://wiki.php.net/rfc#php_84
- https://wiki.php.net/rfc/property-hooks

- Fix `ModifiersCheckHintError`
- Add unit tests

Example:
```php
class PropertyHooksClass {
    private $invalidPrivateFinal {
        final get{} // cannot use final
    }
    private $invalidPublic01 {
        public get; // cannot use public
    }
    public $invalidStatic01 {
        static get {} // cannot use static
    }
    public static $invalidStatic02 { // cannot use static
        get{}
        set{}
    }
    public $invalidNonAbstract {
        get; // need a body
        set; // need a body
    }
    public readonly int $invalidReadonly { get{} set{} } // cannot use readonly
}

interface PropertyHookInterface {
    abstract public $invalid01 { get; set; } // cannot use abstract
    protected $invalid02 {get; set;} // cannot use protected
    private $invalid03 { // cannot use private
        get;
        set;
    }
    public $invalid04 {
        final get; // cannot use final
    }
    final public $invalid05 { // cannot use final
        get;
        set;
    }
    public $invalid06 {
        get {} // cannot has a body
    }
    public private(set) int $invalid07 { // cannot use private(set)
        set;
    }
    final public int $invalid08 { // cannot use final
        set;
    }
    public readonly int $invalid09 { // cannot use readonly
        get;
    }
}
```

- Fix a formatting issue

Example:
```
interface TestInterface {
    public int $prop1 {get; set;}
    public int $prop2 {}
    ^^^^^^^ selected here
}

// before
interface TestInterface {
    public int $prop1 {get; set;}
public int $prop2 {}
}

// after
interface TestInterface {
    public int $prop1 {get; set;}
    public int $prop2 {}
}
```

Author: junichi11

php/php.editor/src/org/netbeans/modules/php/editor/indent/TokenFormatter.java

@@ -2923,7 +2923,16 @@ private int replaceString(BaseDocument document, int offset, int indexInFormatTo
                         && newText != null && newText.indexOf('\n') > -1) {
                     // will be formatted new line that the first one has to be special
                     previousNewIndentText = newText;
-                    previousOldIndentText = oldText;
+                    // e.g.
+                    // class C {
+                    //     public function example1(): void {} : in this case, oldText is an empty string("")
+                    //     public function example2(): void {}
+                    //     ^^^^^^^ format
+                    //
+                    //     public $hooked1 { get; set; } : in this case, oldText is " "
+                    //     public $hooked2 {}
+                    //     ^^^^^^^ format
+                    previousOldIndentText = oldText.indexOf('\n') > -1 ? oldText : newText;
                 }
                 if (newText != null && (!oldText.equals(newText)
                         || (startOffset > 0 && (startOffset - oldText.length()) == offset))) {

php/php.editor/src/org/netbeans/modules/php/editor/verification/ModifiersCheckHintError.java

@@ -0,0 +1,23 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+interface TestInterface {
+    public int $prop1 {get; set;}
+    /*FORMAT_START*/public /*FORMAT_END*/int $prop2 {}
+}

php/php.editor/test/unit/data/testfiles/formatting/selected/visibilityHookedInterfaceProperty_01.php

@@ -0,0 +1,23 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+interface TestInterface {
+    public int $prop1 {get; set;}
+    public int $prop2 {}
+}

php/php.editor/test/unit/data/testfiles/formatting/selected/visibilityHookedInterfaceProperty_01.php.formatted

@@ -0,0 +1,23 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+interface TestInterface {
+    public int $prop1 {    get;    set;    }
+    /*FORMAT_START*/public /*FORMAT_END*/int $prop2 {}
+}

php/php.editor/test/unit/data/testfiles/formatting/selected/visibilityHookedInterfaceProperty_02.php

@@ -0,0 +1,23 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+interface TestInterface {
+    public int $prop1 {    get;    set;    }
+    public int $prop2 {}
+}

php/php.editor/test/unit/data/testfiles/formatting/selected/visibilityHookedInterfaceProperty_02.php.formatted

@@ -0,0 +1,23 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+interface TestInterface {
+    public int $prop1 {}
+    /*FORMAT_START*/public /*FORMAT_END*/int $prop2 {}
+}

php/php.editor/test/unit/data/testfiles/formatting/selected/visibilityHookedInterfaceProperty_03.php

@@ -0,0 +1,23 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+interface TestInterface {
+    public int $prop1 {}
+    public int $prop2 {}
+}

php/php.editor/test/unit/data/testfiles/formatting/selected/visibilityHookedInterfaceProperty_03.php.formatted

@@ -0,0 +1,23 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+class TestClass {
+    public function emptyBody01() {}
+    /*FORMAT_START*/public /*FORMAT_END*/ function emptyBody02() {}
+}

php/php.editor/test/unit/data/testfiles/formatting/selected/visibilityMethodWithEmptyBody_01.php

@@ -0,0 +1,23 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+class TestClass {
+    public function emptyBody01() {}
+    public function emptyBody02() {}
+}

php/php.editor/test/unit/data/testfiles/formatting/selected/visibilityMethodWithEmptyBody_01.php.formatted

@@ -0,0 +1,23 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+class TestClass {
+    public function emptyBody01() {       }
+    /*FORMAT_START*/public /*FORMAT_END*/ function emptyBody02() {}
+}

php/php.editor/test/unit/data/testfiles/formatting/selected/visibilityMethodWithEmptyBody_02.php

@@ -0,0 +1,23 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+class TestClass {
+    public function emptyBody01() {       }
+    public function emptyBody02() {}
+}

php/php.editor/test/unit/data/testfiles/formatting/selected/visibilityMethodWithEmptyBody_02.php.formatted

@@ -0,0 +1,24 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+class TestClass {
+    public function emptyBody01() {
+    }
+    /*FORMAT_START*/public /*FORMAT_END*/ function emptyBody02() {}
+}

php/php.editor/test/unit/data/testfiles/formatting/selected/visibilityMethodWithEmptyBody_03.php

@@ -0,0 +1,24 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+class TestClass {
+    public function emptyBody01() {
+    }
+    public function emptyBody02() {}
+}

php/php.editor/test/unit/data/testfiles/formatting/selected/visibilityMethodWithEmptyBody_03.php.formatted

@@ -1,6 +1,6 @@
 class ClassMethods {
       ------------
-HINT:Class "ClassMethods" contains abstract methods and must be declared abstract
+HINT:Class "ClassMethods" contains abstract members and must be declared abstract
 FIX:Add modifier: abstract
     abstract private function classAbstractPrivate();
                               --------------------
@@ -24,11 +24,11 @@ HINT:Interface method "ifaceFinalMethod" can not be declared final
 FIX:Remove modifier: final
 class PossibleAbstract {
       ----------------
-HINT:Class "PossibleAbstract" contains abstract methods and must be declared abstract
+HINT:Class "PossibleAbstract" contains abstract members and must be declared abstract
 FIX:Add modifier: abstract
 final class FinalAbstract {
             -------------
-HINT:Class "FinalAbstract" contains abstract methods and can not be declared final
+HINT:Class "FinalAbstract" contains abstract members and can not be declared final
 FIX:Remove modifier: final
-HINT:Class "FinalAbstract" contains abstract methods and must be declared abstract
+HINT:Class "FinalAbstract" contains abstract members and must be declared abstract
 FIX:Add modifier: abstract

php/php.editor/test/unit/data/testfiles/verification/ModifiersCheckHintError/testModifiersCheckHint.php.testModifiersCheckHint.hints

@@ -0,0 +1,31 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+abstract class AbstractClass {
+    // invalid properties
+    public abstract $invalid01 { // invalid1
+        get{}
+        set{}
+    }
+    abstract private int $invalid02 { get; set; } // invalid2
+}
+
+class NonAbstractClass { // invalid3
+    public abstract int $invalid03 { get; set; }
+}

php/php.editor/test/unit/data/testfiles/verification/ModifiersCheckHintError/testPropertyHooksAbstractInvalid.php

@@ -0,0 +1,15 @@
+        get{}
+        ---
+HINT:Abstract property hook must specify at least one abstract hook
+        set{}
+        ---
+HINT:Abstract property hook must specify at least one abstract hook
+    abstract private int $invalid02 { get; set; } // invalid2
+                          ---------
+HINT:Hooked property cannot be both private and abstract
+FIX:Remove modifier: private
+FIX:Remove modifier: abstract
+class NonAbstractClass { // invalid3
+      ----------------
+HINT:Class "NonAbstractClass" contains abstract members and must be declared abstract
+FIX:Add modifier: abstract