ClassType::addTrait() returns TraitUse instead of ClassType (BC break)

Author: dg

readme.md

@@ -314,7 +314,7 @@ Using Traits
 ```php
 $class = new Nette\PhpGenerator\ClassType('Demo');
 $class->addTrait('SmartObject');
-$class->addTrait('MyTrait', true)
+$class->addTrait('MyTrait')
 	->addResolution('sayHello as protected')
 	->addComment('@use MyTrait<Foo>');
 echo $class;

src/PhpGenerator/ClassType.php

@@ -343,15 +343,14 @@ public function getTraitResolutions(): array
 	}
 
 
-	public function addTrait(string $name, array|bool $resolutions = []): static|TraitUse
+	public function addTrait(string $name, array|bool|null $deprecatedParam = null): TraitUse
 	{
-		$this->traits[$name] = $trait = new TraitUse($name);
-		if ($resolutions === true) {
-			return $trait;
+		$this->traits[$name] = $trait = new TraitUse($name, $this);
+		if (is_array($deprecatedParam)) {
+			array_map(fn($item) => $trait->addResolution($item), $deprecatedParam);
 		}
 
-		array_map(fn($item) => $trait->addResolution($item), $resolutions);
-		return $this;
+		return $trait;
 	}
 
 

src/PhpGenerator/TraitUse.php

@@ -17,20 +17,25 @@
  */
 final class TraitUse
 {
-	use Nette\SmartObject;
+	use Nette\SmartObject {
+		__call as private parentCall;
+	}
 	use Traits\NameAware;
 	use Traits\CommentAware;
 
 	private array $resolutions = [];
 
+	private ?ClassType $parent;
+
 
-	public function __construct(string $name)
+	public function __construct(string $name, ?ClassType $parent = null)
 	{
 		if (!Nette\PhpGenerator\Helpers::isNamespaceIdentifier($name, true)) {
 			throw new Nette\InvalidArgumentException("Value '$name' is not valid trait name.");
 		}
 
 		$this->name = $name;
+		$this->parent = $parent;
 	}
 
 
@@ -45,4 +50,18 @@ public function getResolutions(): array
 	{
 		return $this->resolutions;
 	}
+
+
+	public function __call(string $nm, array $args): mixed
+	{
+		if (!$this->parent) {
+			return $this->parentCall($nm, $args);
+		}
+		$trace = debug_backtrace(0);
+		$loc = isset($trace[0]['file'])
+			? ' in ' . $trace[0]['file'] . ':' . $trace[0]['line']
+			: '';
+		trigger_error('The ClassType::addTrait() method now returns a TraitUse object instead of ClassType. Please fix the method chaining' . $loc, E_USER_DEPRECATED);
+		return $this->parent->$nm(...$args);
+	}
 }

tests/PhpGenerator/ClassType.phpt

@@ -35,7 +35,8 @@ $class
 	->addComment('@property-read Nette\Forms\Form $form');
 
 $class->addTrait('ObjectTrait');
-$class->addTrait('AnotherTrait', ['sayHello as protected']);
+$class->addTrait('AnotherTrait')
+	->addResolution('sayHello as protected');
 
 $class->addConstant('ROLE', 'admin');
 $class->addConstant('ACTIVE', false)
@@ -141,7 +142,7 @@ $class->addImplement('foo');
 $class->removeImplement('foo');
 
 $class
-	->addTrait('ThirdTrait', true)
+	->addTrait('ThirdTrait')
 		->addResolution('a as private foo')
 		->addResolution('b as private bar')
 		->addComment('@use Foo');

tests/PhpGenerator/PhpFile.phpt

@@ -32,9 +32,10 @@ Assert::same($namespaceFoo, $traitC->getNamespace());
 
 $classA
 	->addImplement('Foo\A')
-	->addTrait('Foo\C')
-	->addImplement('Bar\C')
-	->addTrait('Bar\D');
+	->addImplement('Bar\C');
+
+$classA->addTrait('Foo\C');
+$classA->addTrait('Bar\D');
 
 
 $namespaceBar = $file->addNamespace('Bar');

tests/PhpGenerator/PhpNamespace.fqn.phpt

@@ -18,9 +18,10 @@ $class = new ClassType('Example');
 $class
 	->setExtends('\ParentClass')
 	->addImplement('One')
-	->addImplement('\Two')
-	->addTrait('Three')
-	->addTrait('\Four');
+	->addImplement('\Two');
+
+$class->addTrait('Three');
+$class->addTrait('\Four');
 
 $class->addMethod('one')
 	->setReturnType('One');
@@ -45,9 +46,10 @@ $class = new ClassType('Example', new PhpNamespace(''));
 $class
 	->setExtends('\ParentClass')
 	->addImplement('One')
-	->addImplement('\Two')
-	->addTrait('Three')
-	->addTrait('\Four');
+	->addImplement('\Two');
+
+$class->addTrait('Three');
+$class->addTrait('\Four');
 
 $class->addMethod('one')
 	->setReturnType('One');

tests/PhpGenerator/PhpNamespace.print.phpt

@@ -20,9 +20,10 @@ $interfaceB = $namespace->addInterface('B');
 $classA
 	->addImplement('Foo\A')
 	->addImplement('Bar\C')
-	->addTrait('Bar\D')
 	->addAttribute('Foo\A');
 
+$classA->addTrait('Bar\D');
+
 $method = $classA->addMethod('test');
 $method->addAttribute('Foo\A');
 $method->setReturnType('static|Foo\A');

tests/PhpGenerator/Printer.phpt

@@ -21,7 +21,8 @@ $class = (new ClassType('Example'))
 	->addComment("Description of class.\nThis is example\n");
 
 $class->addTrait('ObjectTrait');
-$class->addTrait('AnotherTrait', ['sayHello as protected']);
+$class->addTrait('AnotherTrait')
+	->addResolution('sayHello as protected');
 
 $class->addConstant('FORCE_ARRAY', new Literal('Nette\Utils\Json::FORCE_ARRAY'))
 	->setPrivate()

tests/PhpGenerator/PsrPrinter.phpt

@@ -20,7 +20,8 @@ $class = (new ClassType('Example'))
 	->addComment("Description of class.\nThis is example\n");
 
 $class->addTrait('ObjectTrait');
-$class->addTrait('AnotherTrait', ['sayHello as protected']);
+$class->addTrait('AnotherTrait')
+	->addResolution('sayHello as protected');
 
 $class->addConstant('FORCE_ARRAY', new Literal('Nette\Utils\Json::FORCE_ARRAY'))
 	->setVisibility('private')