PhpFile, PhpNamespace: can contain functions [Closes #80]

Author: dg

readme.md

@@ -641,19 +641,20 @@ echo $printer->printNamespace($namespace);
 PHP Files
 ---------
 
-Classes and namespaces can be grouped into PHP files represented by the class [PhpFile](https://api.nette.org/php-generator/Nette/PhpGenerator/PhpFile.html):
+Classes, functions and namespaces can be grouped into PHP files represented by the class [PhpFile](https://api.nette.org/php-generator/Nette/PhpGenerator/PhpFile.html):
 
 ```php
 $file = new Nette\PhpGenerator\PhpFile;
 $file->addComment('This file is auto-generated.');
 $file->setStrictTypes(); // adds declare(strict_types=1)
 
-$namespace = $file->addNamespace('Foo');
-$class = $namespace->addClass('A');
-$class->addMethod('hello');
+$class = $file->addClass('Foo\A');
+$function = $file->addFunction('Foo\foo');
 
-// or insert an existing namespace into the file
-// $file->addNamespace(new Nette\PhpGenerator\PhpNamespace('Foo'));
+// or
+// $namespace = $file->addNamespace('Foo');
+// $class = $namespace->addClass('A');
+// $function = $namespace->addFunction('foo');
 
 echo $file;
 
@@ -676,9 +677,10 @@ namespace Foo;
 
 class A
 {
-	public function hello()
-	{
-	}
+}
+
+function foo()
+{
 }
 ```
 

src/PhpGenerator/PhpFile.php

@@ -84,6 +84,14 @@ public function addNamespace($namespace): PhpNamespace
 	}
 
 
+	public function addFunction(string $name): GlobalFunction
+	{
+		return $this
+			->addNamespace(Helpers::extractNamespace($name))
+			->addFunction(Helpers::extractShortName($name));
+	}
+
+
 	/** @return PhpNamespace[] */
 	public function getNamespaces(): array
 	{
@@ -105,6 +113,20 @@ public function getClasses(): array
 	}
 
 
+	/** @return GlobalFunction[] */
+	public function getFunctions(): array
+	{
+		$functions = [];
+		foreach ($this->namespaces as $n => $namespace) {
+			$n .= $n ? '\\' : '';
+			foreach ($namespace->getFunctions() as $c => $class) {
+				$functions[$n . $c] = $class;
+			}
+		}
+		return $functions;
+	}
+
+
 	/** @return static */
 	public function addUse(string $name, string $alias = null): self
 	{

src/PhpGenerator/PhpNamespace.php

@@ -44,6 +44,9 @@ final class PhpNamespace
 	/** @var ClassType[] */
 	private $classes = [];
 
+	/** @var GlobalFunction[] */
+	private $functions = [];
+
 
 	public function __construct(string $name)
 	{
@@ -195,13 +198,26 @@ public function addEnum(string $name): ClassType
 	}
 
 
+	public function addFunction(string $name): GlobalFunction
+	{
+		return $this->functions[$name] = new GlobalFunction($name);
+	}
+
+
 	/** @return ClassType[] */
 	public function getClasses(): array
 	{
 		return $this->classes;
 	}
 
 
+	/** @return GlobalFunction[] */
+	public function getFunctions(): array
+	{
+		return $this->functions;
+	}
+
+
 	public function __toString(): string
 	{
 		try {

src/PhpGenerator/Printer.php

@@ -203,13 +203,16 @@ public function printNamespace(PhpNamespace $namespace): string
 		$name = $namespace->getName();
 		$uses = $this->printUses($namespace);
 
-		$classes = [];
+		$items = [];
 		foreach ($namespace->getClasses() as $class) {
-			$classes[] = $this->printClass($class, $namespace);
+			$items[] = $this->printClass($class, $namespace);
+		}
+		foreach ($namespace->getFunctions() as $function) {
+			$items[] = $this->printFunction($function, $namespace);
 		}
 
 		$body = ($uses ? $uses . "\n\n" : '')
-			. implode("\n", $classes);
+			. implode("\n", $items);
 
 		if ($namespace->hasBracketedSyntax()) {
 			return 'namespace' . ($name ? " $name" : '') . "\n{\n"

tests/PhpGenerator/PhpFile.phpt

@@ -70,13 +70,19 @@ $interfaceF
 $traitG = $file->addTrait('Baz\G');
 Assert::same($file->addNamespace('Baz'), $traitG->getNamespace());
 
+$file->addFunction('Baz\\f2')
+	->setReturnType('Foo\B');
+
 
 sameFile(__DIR__ . '/expected/PhpFile.regular.expect', (string) $file);
 
 $file->addClass('H');
 
 $file->addClass('FooBar\I');
 
+$file->addFunction('f1')
+	->setBody('return 1;');
+
 sameFile(__DIR__ . '/expected/PhpFile.bracketed.expect', (string) $file);
 
 Assert::same([
@@ -102,6 +108,9 @@ Assert::same([
 	'FooBar\I',
 ], array_keys($file->getClasses()));
 
+Assert::same(['Baz\\f2', 'f1'], array_keys($file->getFunctions()));
+
+
 
 
 $file = new PhpFile;

tests/PhpGenerator/expected/PhpFile.bracketed.expect

@@ -57,6 +57,10 @@ namespace Baz
 	trait G
 	{
 	}
+
+	function f2(): \Foo\B
+	{
+	}
 }
 
 
@@ -65,6 +69,11 @@ namespace
 	class H
 	{
 	}
+
+	function f1()
+	{
+		return 1;
+	}
 }
 
 

tests/PhpGenerator/expected/PhpFile.regular.expect

@@ -55,3 +55,7 @@ interface F extends \Foo\B, \Bar\C
 trait G
 {
 }
+
+function f2(): \Foo\B
+{
+}