Add optional hook parameter to Property::modifiers()

Author: thekid

src/main/php/lang/reflection/Modifiers.class.php

@@ -15,9 +15,9 @@ class Modifiers implements Value {
   const IS_PROTECTED     = MODIFIER_PROTECTED;
   const IS_PRIVATE       = MODIFIER_PRIVATE;
   const IS_READONLY      = MODIFIER_READONLY;
-  const IS_PRIVATE_SET   = 0x0400;
+  const IS_PUBLIC_SET    = 0x0400;
   const IS_PROTECTED_SET = 0x0800;
-  const IS_PUBLIC_SET    = 0x1000;
+  const IS_PRIVATE_SET   = 0x1000;
   const IS_NATIVE        = 0x10000;
 
   private static $names= [
@@ -29,9 +29,9 @@ class Modifiers implements Value {
     'abstract'       => self::IS_ABSTRACT,
     'native'         => self::IS_NATIVE,
     'readonly'       => self::IS_READONLY,
-    'private(set)'   => self::IS_PRIVATE_SET,
-    'protected(set)' => self::IS_PROTECTED_SET,
     'public(set)'    => self::IS_PUBLIC_SET,
+    'protected(set)' => self::IS_PROTECTED_SET,
+    'private(set)'   => self::IS_PRIVATE_SET,
   ];
   private $bits;
 
@@ -117,7 +117,7 @@ public function isReadonly() { return 0 !== ($this->bits & self::IS_READONLY); }
   /**
    * Gets whether these modifiers are public in regard to the specified hook
    *
-   * @param  ?string $hook
+   * @param  string $hook
    * @return bool
    * @throws lang.IllegalArgumentException
    */
@@ -132,7 +132,7 @@ public function isPublic($hook= 'get') {
   /**
    * Gets whether these modifiers are protected in regard to the specified hook
    *
-   * @param  ?string $hook
+   * @param  string $hook
    * @return bool
    * @throws lang.IllegalArgumentException
    */
@@ -147,7 +147,7 @@ public function isProtected($hook= 'get') {
   /**
    * Gets whether these modifiers are private in regard to the specified hook
    *
-   * @param  ?string $hook
+   * @param  string $hook
    * @return bool
    * @throws lang.IllegalArgumentException
    */

src/main/php/lang/reflection/Property.class.php

@@ -1,7 +1,7 @@
 <?php namespace lang\reflection;
 
 use ReflectionException, ReflectionUnionType, Throwable;
-use lang\{Reflection, XPClass, Type, VirtualProperty, TypeUnion};
+use lang\{Reflection, XPClass, Type, VirtualProperty, TypeUnion, IllegalArgumentException};
 
 /**
  * Reflection for a single property
@@ -38,6 +38,29 @@ public function constraint() {
     return new Constraint($t ?? Type::$VAR, $present);
   }
 
+  /**
+   * Gets whether these modifiers are public in regard to the specified hook
+   *
+   * @param  ?string $hook Optionally, filter for specified hook only
+   * @return lang.reflection.Modifiers
+   * @throws lang.IllegalArgumentException
+   */
+  public function modifiers($hook= null) {
+    static $set= [
+      Modifiers::IS_PUBLIC_SET    => Modifiers::IS_PUBLIC,
+      Modifiers::IS_PROTECTED_SET => Modifiers::IS_PROTECTED,
+      Modifiers::IS_PRIVATE_SET   => Modifiers::IS_PRIVATE,
+    ];
+
+    $bits= $this->reflect->getModifiers();
+    switch ($hook) {
+      case null: return new Modifiers($bits);
+      case 'get': return new Modifiers($bits & ~0x1c00);
+      case 'set': return new Modifiers($set[$bits & 0x1c00] ?? $bits);
+      default: throw new IllegalArgumentException('Unknown hook '.$hook);
+    }
+  }
+
   /**
    * Gets this property's value
    *

src/test/php/lang/reflection/unittest/PropertiesTest.class.php

@@ -1,13 +1,19 @@
 <?php namespace lang\reflection\unittest;
 
 use lang\reflection\{AccessingFailed, CannotAccess, Constraint, Modifiers};
-use lang\{Primitive, Type, TypeIntersection, TypeUnion, XPClass, IllegalStateException};
-use test\verify\Runtime;
+use lang\{Primitive, Type, TypeIntersection, TypeUnion, XPClass, IllegalArgumentException};
+use test\verify\{Condition, Runtime};
 use test\{Action, Assert, Expect, Test, Values};
 
 class PropertiesTest {
   use TypeDefinition;
 
+  private static $ASYMMETRIC;
+
+  static function __static() {
+    self::$ASYMMETRIC= method_exists(\ReflectionProperty::class, 'isPrivateSet');
+  }
+
   #[Test]
   public function name() {
     Assert::equals('fixture', $this->declare('{ public $fixture; }')->property('fixture')->name());
@@ -27,6 +33,27 @@ public function modifiers() {
     );
   }
 
+  #[Test, Values(['public', 'protected', 'private'])]
+  public function get_modifiers($modifier) {
+    Assert::equals(
+      new Modifiers($modifier),
+      $this->declare('{ '.$modifier.' $fixture; }')->property('fixture')->modifiers('get')
+    );
+  }
+
+  #[Test, Values(['public', 'protected', 'private'])]
+  public function set_modifiers($modifier) {
+    Assert::equals(
+      new Modifiers($modifier),
+      $this->declare('{ '.$modifier.' $fixture; }')->property('fixture')->modifiers('set')
+    );
+  }
+
+  #[Test, Expect(IllegalArgumentException::class)]
+  public function modifiers_unknown_hook() {
+    $this->declare('{ private $fixture; }')->property('fixture')->modifiers('@unknown');
+  }
+
   #[Test]
   public function no_comment() {
     Assert::null($this->declare('{ private $fixture; }')->property('fixture')->comment());
@@ -228,12 +255,37 @@ public function set_accessing_failed_exceptions_target_member() {
     }
   }
 
-  #[Test, Runtime(php: '>=8.4')]
-  public function asymmetric_visibility() {
-    $t= $this->declare('{ public private(set) string $fixture; }');
+  #[Test, Condition(assert: 'self::$ASYMMETRIC'), Values(['public protected(set)', 'public private(set)', 'protected private(set)'])]
+  public function asymmetric_visibility($modifiers) {
+    $t= $this->declare('{ '.$modifiers.' int $fixture; }');
     Assert::equals(
-      'public private(set) string $name',
+      $modifiers.' int $fixture',
       $t->property('fixture')->toString()
     );
   }
+
+  #[Test, Condition(assert: 'self::$ASYMMETRIC'), Values(['public', 'protected', 'private'])]
+  public function set_implicit_when_same_as_get($modifier) {
+    $t= $this->declare('{ '.$modifier.' '.$modifier.'(set) int $fixture; }');
+    Assert::equals(
+      $modifier.' int $fixture',
+      $t->property('fixture')->toString()
+    );
+  }
+
+  #[Test, Condition(assert: 'self::$ASYMMETRIC'), Values(['public', 'protected', 'private'])]
+  public function asymmetric_get($modifier) {
+    Assert::equals(
+      new Modifiers($modifier),
+      $this->declare('{ '.$modifier.' private(set) int $fixture; }')->property('fixture')->modifiers('get')
+    );
+  }
+
+  #[Test, Condition(assert: 'self::$ASYMMETRIC'), Values(['public', 'protected', 'private'])]
+  public function asymmetric_set($modifier) {
+    Assert::equals(
+      new Modifiers($modifier),
+      $this->declare('{ public '.$modifier.'(set) int $fixture; }')->property('fixture')->modifiers('set')
+    );
+  }
 }