RFC examples, fixes

Author: DanielEScherzer

Zend/tests/friends/example_001.phpt

@@ -0,0 +1,59 @@
+--TEST--
+Friends: RFC example 1 (User and UserFactory)
+--FILE--
+<?php
+
+class User {
+    friend UserFactory;
+
+    // Private constructor - user information must come from a trusted source
+    private function __construct(
+        public readonly int $userId,
+        public readonly string $username,
+    ) {}
+}
+
+class UserFactory {
+
+    public function newFromId(int $userId): ?User {
+        // In reality this would query a database or something
+        return match ($userId) {
+            1 => new User(1, "Alice"),
+            2 => new User(2, "Bob"),
+            default => null,
+        };
+    }
+}
+
+$factory = new UserFactory;
+
+$alice = $factory->newFromId(1);
+var_dump($alice);
+
+$bob = $factory->newFromId(2);
+var_dump($bob);
+
+// Creation outside of the factory fails
+try {
+	$unknown = new User(3, "Camille");
+} catch (Error $e) {
+	echo $e;
+}
+
+?>
+--EXPECTF--
+object(User)#%d (2) {
+  ["userId"]=>
+  int(1)
+  ["username"]=>
+  string(5) "Alice"
+}
+object(User)#%d (2) {
+  ["userId"]=>
+  int(2)
+  ["username"]=>
+  string(3) "Bob"
+}
+Error: Call to private User::__construct() from global scope in %s:%d
+Stack trace:
+#0 {main}

Zend/tests/friends/example_002.phpt

@@ -0,0 +1,62 @@
+--TEST--
+Friends: RFC example 2 (User and UserBuilder)
+--FILE--
+<?php
+
+class User {
+    friend UserBuilder;
+
+    public private(set) ?int $userId = null;
+    public private(set) ?string $username = null;
+
+    // Private constructor - use the UserBuilder
+    private function __construct() {}
+}
+
+class UserBuilder {
+
+    public function newWithId(int $userId): User {
+        $u = new User();
+        $u->userId = $userId;
+        return $u;
+    }
+
+    public function newWithName(string $username): User {
+        $u = new User();
+        $u->username = $username;
+        return $u;
+    }
+}
+
+$builder = new UserBuilder();
+
+$alice = $builder->newWithId(1);
+var_dump($alice);
+
+$bob = $builder->newWithName("Bob");
+var_dump($bob);
+
+// Creation outside of the builder fails
+try {
+	$unknown = new User();
+} catch (Error $e) {
+	echo $e;
+}
+
+?>
+--EXPECTF--
+object(User)#%d (2) {
+  ["userId"]=>
+  int(1)
+  ["username"]=>
+  NULL
+}
+object(User)#%d (2) {
+  ["userId"]=>
+  NULL
+  ["username"]=>
+  string(3) "Bob"
+}
+Error: Call to private User::__construct() from global scope in %s:%d
+Stack trace:
+#0 {main}

Zend/tests/friends/not_reserved.phpt

@@ -0,0 +1,54 @@
+--TEST--
+Friends: `friend` is not reserved
+--FILE--
+<?php
+
+namespace ClazzDemo {
+	class Friend implements \InterfaceDemo\Friend {
+		use \TraitDemo\Friend;
+
+		public mixed $Friend;
+
+		public function Friend(): Friend {
+			var_dump($this->Friend);
+			return $this;
+		}
+	}
+
+	class Subclass extends Friend {}
+}
+
+namespace InterfaceDemo {
+	interface Friend {}
+}
+
+namespace TraitDemo {
+	trait Friend {}
+}
+
+namespace EnumDemo {
+	enum Friend {
+		case Friend;
+	}
+}
+
+namespace {
+	use ClazzDemo\Friend;
+	use ClazzDemo\Subclass;
+
+	$f = new Friend;
+	$f->Friend = "demo";
+	$f->Friend();
+
+	$f = new Subclass;
+	$f->Friend = "demo";
+	$f->Friend();
+
+	var_dump(\EnumDemo\Friend::Friend);
+}
+
+?>
+--EXPECT--
+string(4) "demo"
+string(4) "demo"
+enum(EnumDemo\Friend::Friend)

Zend/tests/friends/property_access.phpt

@@ -34,7 +34,7 @@ try {
 	echo $e . "\n\n";
 }
 try {
-	Foo::$privateInstance = 2;
+	Foo::$privateStatic = 2;
 } catch (Error $e) {
 	echo $e . "\n\n";
 }
@@ -61,7 +61,7 @@ Error: Cannot access protected property Foo::$protectedStatic in %s:%d
 Stack trace:
 #0 {main}
 
-Error: Cannot access private property Foo::$privateInstance in %s:%d
+Error: Cannot access private property Foo::$privateStatic in %s:%d
 Stack trace:
 #0 {main}
 

Zend/tests/friends/property_access_aviz.phpt

@@ -0,0 +1,87 @@
+--TEST--
+Friends: allows access to properties with asymmetric visibility
+--FILE--
+<?php
+
+class Foo {
+	friend Bar;
+
+	public protected(set) static mixed $protectedStatic;
+	public private(set) static mixed $privateStatic;
+
+	public protected(set) mixed $protectedInstance;
+	public private(set) mixed $privateInstance;
+}
+
+class Bar {
+	public static function testPropertyAccess() {
+		Foo::$protectedStatic = 1;
+		var_dump(Foo::$protectedStatic);
+		Foo::$privateStatic = 2;
+		var_dump(Foo::$privateStatic);
+		$f = new Foo();
+		$f->protectedInstance = 3;
+		$f->privateInstance = 4;
+		var_dump($f);
+	}
+}
+
+// Confirm that the presence of a friend does not negate normal visibility
+// enforcement for non friends
+try {
+	Foo::$protectedStatic = 1;
+} catch (Error $e) {
+	echo $e . "\n\n";
+}
+try {
+	Foo::$privateStatic = 2;
+} catch (Error $e) {
+	echo $e . "\n\n";
+}
+$f = new Foo();
+try {
+	$f->protectedInstance = 3;
+} catch (Error $e) {
+	echo $e . "\n\n";
+}
+try {
+	$f->privateInstance = 4;
+} catch (Error $e) {
+	echo $e . "\n\n";
+}
+
+echo "\n\n-----\n\n";
+
+// But friend works
+Bar::testPropertyAccess();
+
+?>
+--EXPECTF--
+Error: Cannot modify protected(set) property Foo::$protectedStatic from global scope in %s:%d
+Stack trace:
+#0 {main}
+
+Error: Cannot modify private(set) property Foo::$privateStatic from global scope in %s:%d
+Stack trace:
+#0 {main}
+
+Error: Cannot modify protected(set) property Foo::$protectedInstance from global scope in %s:%d
+Stack trace:
+#0 {main}
+
+Error: Cannot modify private(set) property Foo::$privateInstance from global scope in %s:%d
+Stack trace:
+#0 {main}
+
+
+
+-----
+
+int(1)
+int(2)
+object(Foo)#%d (2) {
+  ["protectedInstance"]=>
+  int(3)
+  ["privateInstance"]=>
+  int(4)
+}

Zend/zend_language_scanner.l

@@ -1802,7 +1802,16 @@ OPTIONAL_WHITESPACE_OR_COMMENTS ({WHITESPACE}|{MULTI_LINE_COMMENT}|{SINGLE_LINE_
 	RETURN_TOKEN_WITH_IDENT(T_READONLY);
 }
 
-<ST_IN_SCRIPTING>"friend" {
+/*
+ * The friend keyword must be followed by whitespace and another identifier.
+ * This avoids the BC break of using friend in classes, namespaces, functions and constants.
+ */
+<ST_IN_SCRIPTING>"friend"{WHITESPACE_OR_COMMENTS}("extends"|"implements") {
+	yyless(6);
+	RETURN_TOKEN_WITH_STR(T_STRING, 0);
+}
+<ST_IN_SCRIPTING>"friend"{WHITESPACE_OR_COMMENTS}[a-zA-Z_\x80-\xff] {
+	yyless(6);
 	RETURN_TOKEN_WITH_IDENT(T_FRIEND);
 }
 

Zend/zend_object_handlers.c

@@ -611,8 +611,12 @@ ZEND_API bool ZEND_FASTCALL zend_asymmetric_property_has_set_access(const zend_p
 	if (prop_info->ce == scope) {
 		return true;
 	}
-	return EXPECTED((prop_info->flags & ZEND_ACC_PROTECTED_SET)
-		&& is_protected_compatible_scope(prop_info->prototype->ce, scope));
+	if (EXPECTED((prop_info->flags & ZEND_ACC_PROTECTED_SET)
+		&& is_protected_compatible_scope(prop_info->prototype->ce, scope))
+	) {
+		return true;
+	}
+	return zend_check_friend(prop_info->ce, scope);
 }
 
 static void zend_property_guard_dtor(zval *el) /* {{{ */ {