add Constant; class constants can have declared visibility and comment

Author: dg

src/PhpGenerator/ClassType.php

@@ -54,7 +54,7 @@ class ClassType
 	/** @var string|NULL */
 	private $comment;
 
-	/** @var array name => value */
+	/** @var Constant[] name => Constant */
 	private $consts = [];
 
 	/** @var Property[] name => Property */
@@ -112,8 +112,10 @@ public function __construct($name = '', PhpNamespace $namespace = NULL)
 	public function __toString()
 	{
 		$consts = [];
-		foreach ($this->consts as $name => $value) {
-			$consts[] = "const $name = " . Helpers::dump($value) . ";\n";
+		foreach ($this->consts as $const) {
+			$consts[] = Helpers::formatDocComment($const->getComment())
+				. ($const->getVisibility() ? $const->getVisibility() . ' ' : '')
+				. 'const ' . $const->getName() . ' = ' . Helpers::dump($const->getValue()) . ";\n";
 		}
 
 		$properties = [];
@@ -392,36 +394,72 @@ public function addDocument($s)
 
 
 	/**
+	 * @deprecated  use setConstants()
 	 * @return static
 	 */
 	public function setConsts(array $consts)
 	{
-		$this->consts = $consts;
-		return $this;
+		return $this->setConstants($consts);
 	}
 
 
 	/**
+	 * @deprecated  use getConstants()
 	 * @return array
 	 */
 	public function getConsts()
 	{
-		return $this->consts;
+		return array_map(function ($const) { return $const->getValue(); }, $this->consts);
 	}
 
 
 	/**
+	 * @deprecated  use addConstant()
 	 * @param  string
 	 * @param  mixed
 	 * @return static
 	 */
 	public function addConst($name, $value)
 	{
-		$this->consts[$name] = $value;
+		$this->addConstant($name, $value);
 		return $this;
 	}
 
 
+	/**
+	 * @return static
+	 */
+	public function setConstants(array $consts)
+	{
+		$this->consts = [];
+		foreach ($consts as $k => $v) {
+			$const = $v instanceof Constant ? $v : (new Constant($k))->setValue($v);
+			$this->consts[$const->getName()] = $const;
+		}
+		return $this;
+	}
+
+
+	/**
+	 * @return Constant[]
+	 */
+	public function getConstants()
+	{
+		return $this->consts;
+	}
+
+
+	/**
+	 * @param  string
+	 * @param  mixed
+	 * @return Constant
+	 */
+	public function addConstant($name, $value)
+	{
+		return $this->consts[$name] = (new Constant($name))->setValue($value);
+	}
+
+
 	/**
 	 * @param  Property[]
 	 * @return static

src/PhpGenerator/Constant.php

@@ -0,0 +1,40 @@
+<?php
+
+/**
+ * This file is part of the Nette Framework (https://nette.org)
+ * Copyright (c) 2004 David Grudl (https://davidgrudl.com)
+ */
+
+namespace Nette\PhpGenerator;
+
+use Nette;
+
+
+/**
+ * Class constant.
+ */
+class Constant extends Member
+{
+	/** @var mixed */
+	private $value;
+
+
+	/**
+	 * @return static
+	 */
+	public function setValue($val)
+	{
+		$this->value = $val;
+		return $this;
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function getValue()
+	{
+		return $this->value;
+	}
+
+}

tests/PhpGenerator/ClassType.expect

@@ -9,7 +9,9 @@ abstract final class Example extends ParentClass implements IExample, IOne
 	use ObjectTrait;
 
 	const ROLE = 'admin';
-	const FORCE_ARRAY = Nette\Utils\Json::FORCE_ARRAY;
+	const ACTIVE = FALSE;
+	/** Commented */
+	private const FORCE_ARRAY = Nette\Utils\Json::FORCE_ARRAY;
 
 	/** @var resource  orignal file handle */
 	private $handle;

tests/PhpGenerator/ClassType.phpt

@@ -21,11 +21,15 @@ $class
 	->addImplement('IOne')
 	->addTrait('ObjectTrait')
 	->addComment("Description of class.\nThis is example\n")
-	->addComment('@property-read Nette\Forms\Form $form');
+	->addComment('@property-read Nette\Forms\Form $form')
+	->setConsts(['ROLE' => 'admin'])
+	->addConst('ACTIVE', FALSE);
 
-$class
-	->addConst('ROLE', 'admin')
-	->addConst('FORCE_ARRAY', new PhpLiteral('Nette\Utils\Json::FORCE_ARRAY'));
+Assert::same(['ROLE' => 'admin', 'ACTIVE' => FALSE], $class->getConsts());
+
+$class->addConstant('FORCE_ARRAY', new PhpLiteral('Nette\Utils\Json::FORCE_ARRAY'))
+	->setVisibility('private')
+	->addComment('Commented');
 
 $class->addProperty('handle')
 	->setVisibility('private')