Class and method attribute support

Author: phpfui

src/PHPFUI/InstaDoc/Section/CodeCommon.php

@@ -119,6 +119,12 @@ protected function formatComments(?\phpDocumentor\Reflection\DocBlock $docBlock,
 				$ul->addItem(new \PHPFUI\ListItem($this->getColor('name', $name) . ' ' . $this->getColor('description', $body)));
 				}
 
+			$attributes = $this->getAttributes($reflectionMethod);
+			foreach ($attributes as $attribute)
+				{
+				$ul->addItem(new \PHPFUI\ListItem($this->getColor('name', 'attribute') . ' ' . $this->formatAttribute($attribute)));
+				}
+
 			$container->add($ul);
 			}
 
@@ -211,6 +217,11 @@ protected function getComments(?\phpDocumentor\Reflection\DocBlock $docBlock, ?\
 
 	protected function getDocBlock($method) : ?\phpDocumentor\Reflection\DocBlock
 		{
+		/**
+		 * @todo get attributes everywhere
+		 * $attributes = $this->getAttributes($method);
+		 */
+
 		$comments = $method->getDocComment();
 		$comments = \str_replace('{@inheritdoc}', '@inheritdoc', $comments);
 
@@ -342,6 +353,7 @@ protected function getParameters($method) : string
 		{
 		$info = '(';
 		$comma = '';
+
 		$docBlock = $this->getDocBlock($method);
 
 		$parameterComments = $this->getParameterComments($docBlock);
@@ -361,6 +373,11 @@ protected function getParameters($method) : string
 			$name = $parameter->getName();
 			$tip = '$' . $name;
 
+			/**
+			 * @todo add attributes for parameters
+			 * $attributes = $this->getAttributes($parameter);
+			 */
+
 			if (isset($parameterComments[$name]))
 				{
 				$tip = new \PHPFUI\ToolTip($tip, $parameterComments[$name]);
@@ -479,4 +496,91 @@ protected function section(string $name) : string
 
 		return $section;
 		}
+
+	protected function getAttributes($reflection) : array
+		{
+		if ($reflection && method_exists($reflection, 'getAttributes'))
+			{
+			return $reflection->getAttributes();
+			}
+
+		return [];
+		}
+
+	private function getAttributeName(string $name, bool $asValue = false) : string
+		{
+		$link = $this->getClassName($name);
+		if (strpos($link, 'href='))
+			{
+			$name = $link;
+			}
+		elseif ($asValue)
+			{
+			$name = $this->getValueString($name);
+			}
+
+		return $name;
+		}
+
+	protected function formatAttribute(\ReflectionAttribute $attribute) : string
+		{
+		$parameters = '';
+		$arguments = $attribute->getArguments();
+		if ($arguments)
+			{
+			$parameters = ' (';
+			$comma = '';
+			foreach ($arguments as $name => $argument)
+				{
+				$name = is_int($name) ? '' : $this->getAttributeName($name) . ': ';
+				if (is_string($argument))
+					{
+					$link = $this->getAttributeName($argument, true);
+					}
+				else
+					{
+					$link = $this->getValueString($argument);
+					}
+				$parameters .= "{$comma} {$name}{$link}";
+
+				$comma = ', ';
+				}
+			$parameters .= ')';
+			}
+
+		$targeting = '';
+		/*
+
+		Not sure how useful this is, so commenting out for now.
+
+		$target = $attribute->getTarget();
+		$targets = [];
+		$definedTargets = [
+			"CLASS" => \Attribute::TARGET_CLASS,
+			"FUNCTION" => \Attribute::TARGET_FUNCTION,
+			"METHOD" => \Attribute::TARGET_METHOD,
+			"PROPERTY" => \Attribute::TARGET_PROPERTY,
+			"CLASS_CONSTANT" => \Attribute::TARGET_CLASS_CONSTANT,
+			"PARAMETER" => \Attribute::TARGET_PARAMETER,
+			];
+		foreach ($definedTargets as $name => $value)
+			{
+			if ($target & $value)
+				{
+				$targets[] = '\\Attribute::TARGET_' . $name;
+				}
+			}
+		if ($attribute->isRepeated())
+			{
+			$targets[] = '\\Attribute::IS_REPEATABLE';
+			}
+		if ($targets)
+			{
+			$targeting = ' ' . implode(' | ', $targets);
+			}
+		*/
+
+		return $this->getClassName($attribute->getName()) . $parameters . $targeting;
+		}
+
 	}

src/PHPFUI/InstaDoc/Section/Doc.php

@@ -159,6 +159,25 @@ public function generate(\PHPFUI\Instadoc\PageInterface $page, string $fullClass
 				}
 			}
 
+		$reflectionAttributes = $this->getAttributes($this->reflection);
+
+		if ($reflectionAttributes)
+			{
+			$table = new \PHPFUI\Table();
+			$table->addClass('hover');
+			$table->addClass('unstriped');
+
+			foreach ($reflectionAttributes as $attribute)
+				{
+				$table->addRow([$this->formatAttribute($attribute)]);
+				}
+
+			if (\count($table))
+				{
+				$accordion->addTab('Attributes', $table);
+				}
+			}
+
 		if (\count($accordion))
 			{
 			$container->add($accordion);
@@ -245,6 +264,11 @@ protected function getAccess($constant) : string
 
 	protected function getConstant(\ReflectionClassConstant $constant, string $name, $value) : string
 		{
+		/**
+		 * @todo get attributes everywhere
+		 * $attributes = $this->getAttributes($constant);
+		 */
+
 		$docBlock = $this->getDocBlock($constant);
 		$info = $this->getAccess($constant) . ' ' . $this->getColor('constant', $this->getColor('constant', $this->getName($constant, $name, true))) . ' = ' . $this->getValueString($value);
 		$info .= $this->getComments($docBlock);
@@ -270,6 +294,11 @@ protected function getContent(string $accessType) : \PHPFUI\Table
 				{
 				$constant = new \ReflectionClassConstant($this->class, $name);
 
+				/**
+				 * @todo get attributes everywhere
+				 * $attributes = $this->getAttributes($constant);
+				 */
+
 				if ($constant->{$accessType}())
 					{
 					if ($section)

src/PHPFUI/InstaDoc/Section/Functions.php

@@ -83,6 +83,11 @@ private function documentFunction(string $function) : \PHPFUI\Container
 			'Variadic',
 		];
 
+		/**
+		 * @todo get attributes everywhere
+		 * $attributes = $this->getAttributes($this->reflection);
+		 */
+
 		$gridX = null;
 
 		foreach ($properties as $type)

src/PHPFUI/InstaDoc/Tests/Test80.php

@@ -90,4 +90,10 @@ private function UpperCaseMethodName() : mixed { return null; }
 	 * Testing method sorting
 	 */
 	private function upperTest() : void {}
+
+	#[\ReturnTypeWillChange]
+	public function count()
+		{
+		return 0;
+		}
 	}

src/PHPFUI/InstaDoc/Tests/Test80B.php

@@ -9,6 +9,14 @@
  *
  * @author bruce (1/3/2020)
  */
+#[Test80]
+#[\PHPFUI\InstaDoc\Tests\Test80]
+#[\PHPFUI\InstaDoc\Tests\Test80(1234), \PHPFUI\InstaDoc\Tests\Test80(value: 1234), \PHPFUI\InstaDoc\Tests\Test80(array("key" => "value"))]
+#[\PHPFUI\InstaDoc\Tests\Test80(\PHPFUI\InstaDoc\Tests\Test80::CONST_PUBLIC_STRING)]
+#[\PHPFUI\InstaDoc\Tests\Test80(100 + 200)]
+#[Property(type: 'function', name: 'Hello')]
+#[Listens(\PHPFUI\Page::class)]
+#[Route(\PHPFUI\InstaDoc\Controller::CLASS_NAME, '/products/create')]
 class Test80B extends Test80A
 	{
 	/**
@@ -20,4 +28,5 @@ protected function protected_function_no_return(?string $fred, $unknown = 3.14)
 	 * {@inheritDoc}
 	 */
 	private function private_function_no_return(string | Test80 | null $fred = 'Eythel') : void {}
+
 	}