Add TestingAccessWrapper::construct() to use non-public constructors

cscott · Krinkle · commit 975c15cfecfd · 2023-11-14T20:14:06.000Z
Change-Id: Idaaae6ce699c15c57df7bc23cdbcf4b6e6e77ea6
diff --git a/README.md b/README.md
@@ -21,7 +21,14 @@ class NonPublic {
 	protected static function staticFunc() {}
 }
 
+class NonPublicCtor {
+	protected function __construct() {}
+}
+
 $object = new NonPublic();
+// or:
+// $object = TestingAccessWrapper::construct( NonPublicCtor::class );
+
 $wrapper = TestingAccessWrapper::newFromObject( $object );
 $classWrapper = TestingAccessWrapper::newFromClass( NonPublic::class );
 
diff --git a/src/TestingAccessWrapper.php b/src/TestingAccessWrapper.php
@@ -82,6 +82,22 @@ public static function constant( $className, $constantName ) {
 		return $classReflection->getConstant( $constantName );
 	}
 
+	/**
+	 * Allow constructing a class with a non-public constructor.
+	 * @param class-string<T> $className
+	 * @param mixed ...$args
+	 * @return T
+	 * @phan-template T
+	 */
+	public static function construct( string $className, ...$args ) {
+		$classReflection = new ReflectionClass( $className );
+		$constructor = $classReflection->getConstructor();
+		$constructor->setAccessible( true );
+		$object = $classReflection->newInstanceWithoutConstructor();
+		$constructor->invokeArgs( $object, $args );
+		return $object;
+	}
+
 	/**
 	 * @param string $method
 	 * @param array $args
diff --git a/tests/TestingAccessWrapperTest.php b/tests/TestingAccessWrapperTest.php
@@ -61,6 +61,26 @@ public function testConstantException() {
 		TestingAccessWrapper::constant( WellProtectedClass::class, 'NONEXISTENT_CONTENT' );
 	}
 
+	public function testConstructException() {
+		$this->expectException( \Error::class );
+		// @phan-suppress-next-line PhanAccessMethodProtected
+		return new WellProtectedParentClass();
+	}
+
+	public function testConstruct() {
+		$parent = TestingAccessWrapper::construct( WellProtectedParentClass::class );
+		$this->assertInstanceOf( WellProtectedParentClass::class, $parent );
+		$wrapped = TestingAccessWrapper::newFromObject( $parent );
+		$this->assertSame( 9000, $wrapped->privateParentProperty );
+	}
+
+	public function testConstructArg() {
+		$parent = TestingAccessWrapper::construct( WellProtectedParentClass::class, 1234 );
+		$this->assertInstanceOf( WellProtectedParentClass::class, $parent );
+		$wrapped = TestingAccessWrapper::newFromObject( $parent );
+		$this->assertSame( 1234, $wrapped->privateParentProperty );
+	}
+
 	public function testGetException_nonStatic() {
 		$this->expectException( \DomainException::class );
 		$this->wrappedStatic->property;
diff --git a/tests/WellProtectedParentClass.php b/tests/WellProtectedParentClass.php
@@ -11,8 +11,8 @@ class WellProtectedParentClass {
 
 	private const PARENT_CONSTANT = 'parent constant';
 
-	public function __construct() {
-		$this->privateParentProperty = 9000;
+	protected function __construct( $parentProperty = 9000 ) {
+		$this->privateParentProperty = $parentProperty;
 	}
 
 	private function incrementPrivateParentPropertyValue() {

Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,8 @@ class WellProtectedParentClass {`
`11`	`11`
`12`	`12`	`private const PARENT_CONSTANT = 'parent constant';`
`13`	`13`
`14`		`- public function __construct() {`
`15`		`- $this->privateParentProperty = 9000;`
	`14`	`+ protected function __construct( $parentProperty = 9000 ) {`
	`15`	`+ $this->privateParentProperty = $parentProperty;`
`16`	`16`	`}`
`17`	`17`
`18`	`18`	`private function incrementPrivateParentPropertyValue() {`