marked new deprecated stuff

dg · dg · commit c1d720e1762e · 2022-02-20T19:06:18.000+01:00
diff --git a/composer.json b/composer.json
@@ -25,7 +25,7 @@
 		"phpstan/phpstan": "^1.0"
 	},
 	"suggest": {
-		"nikic/php-parser": "to use ClassType::withBodiesFrom() & GlobalFunction::withBodyFrom()"
+		"nikic/php-parser": "to use ClassType::from(withBodies: true) & ClassType::fromCode()"
 	},
 	"autoload": {
 		"classmap": ["src/"]
diff --git a/readme.md b/readme.md
@@ -721,9 +721,9 @@ Function and method bodies are empty by default. If you want to load them as wel
 (it requires `nikic/php-parser` to be installed):
 
 ```php
-$class = Nette\PhpGenerator\ClassType::withBodiesFrom(MyClass::class);
+$class = Nette\PhpGenerator\ClassType::from(PDO::class, withBodies: true);
 
-$function = Nette\PhpGenerator\GlobalFunction::withBodyFrom('dump');
+$function = Nette\PhpGenerator\GlobalFunction::from('dump', withBody: true);
 ```
 
 Load class from file
diff --git a/src/PhpGenerator/ClassType.php b/src/PhpGenerator/ClassType.php
@@ -99,8 +99,10 @@ public static function from(string|object $class, bool $withBodies = false, bool
 	}
 
 
+	/** @deprecated  use ClassType::from(..., withBodies: true) */
 	public static function withBodiesFrom(string|object $class): self
 	{
+		trigger_error(__METHOD__ . '() is deprecated, use ClassType::from(..., withBodies: true)', E_USER_DEPRECATED);
 		return (new Factory)
 			->fromClassReflection(new \ReflectionClass($class), withBodies: true);
 	}
@@ -150,9 +152,10 @@ public function getName(): ?string
 	}
 
 
-	/** @deprecated */
+	/** @deprecated  use setType('class') or create using ClassType::class() */
 	public function setClass(): static
 	{
+		trigger_error(__METHOD__ . "() is deprecated, use setType('class').", E_USER_DEPRECATED);
 		$this->type = self::TYPE_CLASS;
 		return $this;
 	}
@@ -164,8 +167,10 @@ public function isClass(): bool
 	}
 
 
+	/** @deprecated  use setType('interface') or create using ClassType::interface() */
 	public function setInterface(): static
 	{
+		trigger_error(__METHOD__ . '() is deprecated, use $class->setType($class::TYPE_INTERFACE) or create object using ClassType::interface()', E_USER_DEPRECATED);
 		$this->type = self::TYPE_INTERFACE;
 		return $this;
 	}
@@ -177,8 +182,10 @@ public function isInterface(): bool
 	}
 
 
+	/** @deprecated  use setType('trait') or create using ClassType::trait() */
 	public function setTrait(): static
 	{
+		trigger_error(__METHOD__ . '() is deprecated, use $class->setType($class::TYPE_TRAIT) or create object using ClassType::trait()', E_USER_DEPRECATED);
 		$this->type = self::TYPE_TRAIT;
 		return $this;
 	}
diff --git a/src/PhpGenerator/GlobalFunction.php b/src/PhpGenerator/GlobalFunction.php
@@ -31,8 +31,10 @@ public static function from(string $function, bool $withBody = false): self
 	}
 
 
+	/** @deprecated  use GlobalFunction::from(..., withBody: true) */
 	public static function withBodyFrom(string $function): self
 	{
+		trigger_error(__METHOD__ . '() is deprecated, use GlobalFunction::from(..., withBody: true)', E_USER_DEPRECATED);
 		return (new Factory)->fromFunctionReflection(new \ReflectionFunction($function), withBody: true);
 	}
 
diff --git a/src/PhpGenerator/Helpers.php b/src/PhpGenerator/Helpers.php
@@ -51,20 +51,23 @@ final class Helpers
 	/** @deprecated  use (new Nette\PhpGenerator\Dumper)->dump() */
 	public static function dump($var): string
 	{
+		trigger_error(__METHOD__ . '() is deprecated, use (new Nette\PhpGenerator\Dumper)->dump().', E_USER_DEPRECATED);
 		return (new Dumper)->dump($var);
 	}
 
 
 	/** @deprecated  use (new Nette\PhpGenerator\Dumper)->format() */
 	public static function format(string $statement, ...$args): string
 	{
+		trigger_error(__METHOD__ . '() is deprecated, use (new Nette\PhpGenerator\Dumper)->format().', E_USER_DEPRECATED);
 		return (new Dumper)->format($statement, ...$args);
 	}
 
 
 	/** @deprecated  use (new Nette\PhpGenerator\Dumper)->format() */
 	public static function formatArgs(string $statement, array $args): string
 	{
+		trigger_error(__METHOD__ . '() is deprecated, use (new Nette\PhpGenerator\Dumper)->format().', E_USER_DEPRECATED);
 		return (new Dumper)->format($statement, ...$args);
 	}
 
diff --git a/src/PhpGenerator/Parameter.php b/src/PhpGenerator/Parameter.php
@@ -62,13 +62,15 @@ public function getType(bool $asObject = false): Type|string|null
 	/** @deprecated  use setType() */
 	public function setTypeHint(?string $type): static
 	{
+		trigger_error(__METHOD__ . '() is deprecated, use setType().', E_USER_DEPRECATED);
 		return $this->setType($type);
 	}
 
 
 	/** @deprecated  use getType() */
 	public function getTypeHint(): ?string
 	{
+		trigger_error(__METHOD__ . '() is deprecated, use getType().', E_USER_DEPRECATED);
 		return $this->getType();
 	}
 
diff --git a/src/PhpGenerator/PhpFile.php b/src/PhpGenerator/PhpFile.php
@@ -153,6 +153,7 @@ public function hasStrictTypes(): bool
 	/** @deprecated  use hasStrictTypes() */
 	public function getStrictTypes(): bool
 	{
+		trigger_error(__METHOD__ . '() is deprecated, use hasStrictTypes().', E_USER_DEPRECATED);
 		return $this->strictTypes;
 	}
 
diff --git a/src/PhpGenerator/PhpLiteral.php b/src/PhpGenerator/PhpLiteral.php
@@ -10,6 +10,7 @@
 namespace Nette\PhpGenerator;
 
 
+/** @deprecated  use Nette\PhpGenerator\Literal */
 class PhpLiteral extends Literal
 {
 }
diff --git a/src/PhpGenerator/PhpNamespace.php b/src/PhpGenerator/PhpNamespace.php
@@ -83,6 +83,7 @@ public function hasBracketedSyntax(): bool
 	/** @deprecated  use hasBracketedSyntax() */
 	public function getBracketedSyntax(): bool
 	{
+		trigger_error(__METHOD__ . '() is deprecated, use hasBracketedSyntax().', E_USER_DEPRECATED);
 		return $this->bracketedSyntax;
 	}
 
@@ -157,6 +158,7 @@ public function getUses(string $of = self::NAME_NORMAL): array
 	/** @deprecated  use simplifyName() */
 	public function unresolveName(string $name): string
 	{
+		trigger_error(__METHOD__ . '() is deprecated, use simplifyName()', E_USER_DEPRECATED);
 		return $this->simplifyName($name);
 	}
 
diff --git a/src/PhpGenerator/Traits/FunctionLike.php b/src/PhpGenerator/Traits/FunctionLike.php
@@ -155,6 +155,7 @@ public function isReturnNullable(): bool
 	/** @deprecated  use isReturnNullable() */
 	public function getReturnNullable(): bool
 	{
+		trigger_error(__METHOD__ . '() is deprecated, use isReturnNullable().', E_USER_DEPRECATED);
 		return $this->returnNullable;
 	}
 }
diff --git a/src/PhpGenerator/Type.php b/src/PhpGenerator/Type.php
@@ -52,8 +52,10 @@ public static function intersection(string ...$types): string
 	}
 
 
+	/** @deprecated  use get_debug_type() */
 	public static function getType($value): ?string
 	{
+		trigger_error(__METHOD__ . '() is deprecated, use PHP function get_debug_type()', E_USER_DEPRECATED);
 		return is_resource($value) ? null : get_debug_type($value);
 	}
 }
diff --git a/tests/PhpGenerator/ClassType.from.bodies.phpt b/tests/PhpGenerator/ClassType.from.bodies.phpt
@@ -11,18 +11,18 @@ require __DIR__ . '/fixtures/bodies.php';
 
 
 Assert::exception(function () {
-	ClassType::withBodiesFrom(PDO::class);
+	ClassType::from(PDO::class, withBodies: true);
 }, Nette\InvalidStateException::class, 'Source code of PDO not found.');
 
 
 Assert::exception(function () {
-	ClassType::withBodiesFrom(new class {
+	ClassType::from(new class {
 		public function f()
 		{
 		}
-	});
+	}, withBodies: true);
 }, Nette\NotSupportedException::class, 'The $withBodies parameter cannot be used for anonymous functions.');
 
 
-$res = ClassType::withBodiesFrom(Abc\Class7::class);
+$res = ClassType::from(Abc\Class7::class, withBodies: true);
 sameFile(__DIR__ . '/expected/ClassType.from.bodies.expect', (string) $res);
diff --git a/tests/PhpGenerator/ClassType.from.trait.phpt b/tests/PhpGenerator/ClassType.from.trait.phpt
@@ -25,7 +25,7 @@ $res = array_map(fn($class) => ClassType::from($class), $classes);
 sameFile(__DIR__ . '/expected/ClassType.from.trait-materialize.expect', implode("\n", $res));
 
 
-$res = array_map(fn($class) => ClassType::withBodiesFrom($class), $classes);
+$res = array_map(fn($class) => ClassType::from($class, withBodies: true), $classes);
 
 sameFile(__DIR__ . '/expected/ClassType.from.trait-materialize.bodies.expect', implode("\n", $res));
 
diff --git a/tests/PhpGenerator/GlobalFunction.phpt b/tests/PhpGenerator/GlobalFunction.phpt
@@ -48,7 +48,7 @@ function func(stdClass $a, $b = null)
 );
 
 
-$function = GlobalFunction::withBodyFrom('func');
+$function = GlobalFunction::from('func', withBody: true);
 same(<<<'XX'
 	/**
 	 * global
diff --git a/tests/PhpGenerator/Type.phpt b/tests/PhpGenerator/Type.phpt
@@ -16,10 +16,3 @@ Assert::same('A', Type::nullable(A::class, false));
 
 Assert::same('?A', Type::nullable('?A', true));
 Assert::same('A', Type::nullable('?A', false));
-
-Assert::same(stdClass::class, Type::getType(new stdClass));
-Assert::same(Type::STRING, Type::getType(''));
-Assert::same(Type::INT, Type::getType(1));
-Assert::same(Type::FLOAT, Type::getType(1.0));
-Assert::same(Type::ARRAY, Type::getType([]));
-Assert::same(null, Type::getType(fopen(__FILE__, 'r')));

Original file line number	Diff line number	Diff line change
`@@ -99,8 +99,10 @@ public static function from(string\|object $class, bool $withBodies = false, bool`
`99`	`99`	`}`
`100`	`100`
`101`	`101`
	`102`	`+ /** @deprecated use ClassType::from(..., withBodies: true) */`
`102`	`103`	`public static function withBodiesFrom(string\|object $class): self`
`103`	`104`	`{`
	`105`	`+ trigger_error(__METHOD__ . '() is deprecated, use ClassType::from(..., withBodies: true)', E_USER_DEPRECATED);`
`104`	`106`	`return (new Factory)`
`105`	`107`	`->fromClassReflection(new \ReflectionClass($class), withBodies: true);`
`106`	`108`	`}`
`@@ -150,9 +152,10 @@ public function getName(): ?string`
`150`	`152`	`}`
`151`	`153`
`152`	`154`
`153`		`- /** @deprecated */`
	`155`	`+ /** @deprecated use setType('class') or create using ClassType::class() */`
`154`	`156`	`public function setClass(): static`
`155`	`157`	`{`
	`158`	`+ trigger_error(__METHOD__ . "() is deprecated, use setType('class').", E_USER_DEPRECATED);`
`156`	`159`	`$this->type = self::TYPE_CLASS;`
`157`	`160`	`return $this;`
`158`	`161`	`}`
`@@ -164,8 +167,10 @@ public function isClass(): bool`
`164`	`167`	`}`
`165`	`168`
`166`	`169`
	`170`	`+ /** @deprecated use setType('interface') or create using ClassType::interface() */`
`167`	`171`	`public function setInterface(): static`
`168`	`172`	`{`
	`173`	`+ trigger_error(__METHOD__ . '() is deprecated, use $class->setType($class::TYPE_INTERFACE) or create object using ClassType::interface()', E_USER_DEPRECATED);`
`169`	`174`	`$this->type = self::TYPE_INTERFACE;`
`170`	`175`	`return $this;`
`171`	`176`	`}`
`@@ -177,8 +182,10 @@ public function isInterface(): bool`
`177`	`182`	`}`
`178`	`183`
`179`	`184`
	`185`	`+ /** @deprecated use setType('trait') or create using ClassType::trait() */`
`180`	`186`	`public function setTrait(): static`
`181`	`187`	`{`
	`188`	`+ trigger_error(__METHOD__ . '() is deprecated, use $class->setType($class::TYPE_TRAIT) or create object using ClassType::trait()', E_USER_DEPRECATED);`
`182`	`189`	`$this->type = self::TYPE_TRAIT;`
`183`	`190`	`return $this;`
`184`	`191`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,8 +31,10 @@ public static function from(string $function, bool $withBody = false): self`
`31`	`31`	`}`
`32`	`32`
`33`	`33`
	`34`	`+ /** @deprecated use GlobalFunction::from(..., withBody: true) */`
`34`	`35`	`public static function withBodyFrom(string $function): self`
`35`	`36`	`{`
	`37`	`+ trigger_error(__METHOD__ . '() is deprecated, use GlobalFunction::from(..., withBody: true)', E_USER_DEPRECATED);`
`36`	`38`	`return (new Factory)->fromFunctionReflection(new \ReflectionFunction($function), withBody: true);`
`37`	`39`	`}`
`38`	`40`
Original file line number	Diff line number	Diff line change
`@@ -51,20 +51,23 @@ final class Helpers`
`51`	`51`	`/** @deprecated use (new Nette\PhpGenerator\Dumper)->dump() */`
`52`	`52`	`public static function dump($var): string`
`53`	`53`	`{`
	`54`	`+ trigger_error(__METHOD__ . '() is deprecated, use (new Nette\PhpGenerator\Dumper)->dump().', E_USER_DEPRECATED);`
`54`	`55`	`return (new Dumper)->dump($var);`
`55`	`56`	`}`
`56`	`57`
`57`	`58`
`58`	`59`	`/** @deprecated use (new Nette\PhpGenerator\Dumper)->format() */`
`59`	`60`	`public static function format(string $statement, ...$args): string`
`60`	`61`	`{`
	`62`	`+ trigger_error(__METHOD__ . '() is deprecated, use (new Nette\PhpGenerator\Dumper)->format().', E_USER_DEPRECATED);`
`61`	`63`	`return (new Dumper)->format($statement, ...$args);`
`62`	`64`	`}`
`63`	`65`
`64`	`66`
`65`	`67`	`/** @deprecated use (new Nette\PhpGenerator\Dumper)->format() */`
`66`	`68`	`public static function formatArgs(string $statement, array $args): string`
`67`	`69`	`{`
	`70`	`+ trigger_error(__METHOD__ . '() is deprecated, use (new Nette\PhpGenerator\Dumper)->format().', E_USER_DEPRECATED);`
`68`	`71`	`return (new Dumper)->format($statement, ...$args);`
`69`	`72`	`}`
`70`	`73`
Original file line number	Diff line number	Diff line change
`@@ -62,13 +62,15 @@ public function getType(bool $asObject = false): Type\|string\|null`
`62`	`62`	`/** @deprecated use setType() */`
`63`	`63`	`public function setTypeHint(?string $type): static`
`64`	`64`	`{`
	`65`	`+ trigger_error(__METHOD__ . '() is deprecated, use setType().', E_USER_DEPRECATED);`
`65`	`66`	`return $this->setType($type);`
`66`	`67`	`}`
`67`	`68`
`68`	`69`
`69`	`70`	`/** @deprecated use getType() */`
`70`	`71`	`public function getTypeHint(): ?string`
`71`	`72`	`{`
	`73`	`+ trigger_error(__METHOD__ . '() is deprecated, use getType().', E_USER_DEPRECATED);`
`72`	`74`	`return $this->getType();`
`73`	`75`	`}`
`74`	`76`
Original file line number	Diff line number	Diff line change
`@@ -153,6 +153,7 @@ public function hasStrictTypes(): bool`
`153`	`153`	`/** @deprecated use hasStrictTypes() */`
`154`	`154`	`public function getStrictTypes(): bool`
`155`	`155`	`{`
	`156`	`+ trigger_error(__METHOD__ . '() is deprecated, use hasStrictTypes().', E_USER_DEPRECATED);`
`156`	`157`	`return $this->strictTypes;`
`157`	`158`	`}`
`158`	`159`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@`
`10`	`10`	`namespace Nette\PhpGenerator;`
`11`	`11`
`12`	`12`
	`13`	`+/** @deprecated use Nette\PhpGenerator\Literal */`
`13`	`14`	`class PhpLiteral extends Literal`
`14`	`15`	`{`
`15`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -83,6 +83,7 @@ public function hasBracketedSyntax(): bool`
`83`	`83`	`/** @deprecated use hasBracketedSyntax() */`
`84`	`84`	`public function getBracketedSyntax(): bool`
`85`	`85`	`{`
	`86`	`+ trigger_error(__METHOD__ . '() is deprecated, use hasBracketedSyntax().', E_USER_DEPRECATED);`
`86`	`87`	`return $this->bracketedSyntax;`
`87`	`88`	`}`
`88`	`89`
`@@ -157,6 +158,7 @@ public function getUses(string $of = self::NAME_NORMAL): array`
`157`	`158`	`/** @deprecated use simplifyName() */`
`158`	`159`	`public function unresolveName(string $name): string`
`159`	`160`	`{`
	`161`	`+ trigger_error(__METHOD__ . '() is deprecated, use simplifyName()', E_USER_DEPRECATED);`
`160`	`162`	`return $this->simplifyName($name);`
`161`	`163`	`}`
`162`	`164`
Original file line number	Diff line number	Diff line change
`@@ -155,6 +155,7 @@ public function isReturnNullable(): bool`
`155`	`155`	`/** @deprecated use isReturnNullable() */`
`156`	`156`	`public function getReturnNullable(): bool`
`157`	`157`	`{`
	`158`	`+ trigger_error(__METHOD__ . '() is deprecated, use isReturnNullable().', E_USER_DEPRECATED);`
`158`	`159`	`return $this->returnNullable;`
`159`	`160`	`}`
`160`	`161`	`}`