used generics in phpDoc [WIP]

Author: dg

src/ComponentModel/ArrayAccess.php

@@ -14,13 +14,14 @@
 
 /**
  * Implementation of \ArrayAccess for IContainer.
+ * @template T of IComponent
  */
 trait ArrayAccess
 {
 	/**
 	 * Adds the component to the container.
 	 * @param  string|int  $name
-	 * @param  IComponent  $component
+	 * @param  T  $component
 	 */
 	public function offsetSet($name, $component): void
 	{
@@ -32,6 +33,7 @@ public function offsetSet($name, $component): void
 	/**
 	 * Returns component specified by name. Throws exception if component doesn't exist.
 	 * @param  string|int  $name
+	 * @return T
 	 * @throws Nette\InvalidArgumentException
 	 */
 	public function offsetGet($name): IComponent

src/ComponentModel/Component.php

@@ -15,8 +15,10 @@
 /**
  * Base class for all components. Components have a parent, name, and can be monitored by ancestors.
  *
+ * @template T of IContainer
+ * @implements IComponent<T>
  * @property-read string $name
- * @property-read IContainer|null $parent
+ * @property-read T|null $parent
  */
 abstract class Component implements IComponent
 {
@@ -149,6 +151,7 @@ final public function getName(): ?string
 
 	/**
 	 * Returns the parent container if any.
+	 * @return T
 	 */
 	final public function getParent(): ?IContainer
 	{
@@ -159,6 +162,7 @@ final public function getParent(): ?IContainer
 	/**
 	 * Sets or removes the parent of this component. This method is managed by containers and should
 	 * not be called by applications
+	 * @param  T  $parent
 	 * @throws Nette\InvalidStateException
 	 * @internal
 	 */
@@ -200,6 +204,7 @@ public function setParent(?IContainer $parent, ?string $name = null): static
 	/**
 	 * Validates the new parent before it's set.
 	 * Descendant classes can override this to implement custom validation logic.
+	 * @param  T  $parent
 	 * @throws Nette\InvalidStateException
 	 */
 	protected function validateParent(IContainer $parent): void

src/ComponentModel/Container.php

@@ -15,7 +15,9 @@
 /**
  * Manages a collection of child components.
  *
- * @property-read IComponent[] $components
+ * @template T of IComponent
+ * @implements IContainer<T>
+ * @property-read T[] $components
  */
 class Container extends Component implements IContainer
 {

src/ComponentModel/IComponent.php

@@ -12,6 +12,7 @@
 
 /**
  * Defines core functionality required by all components.
+ * @template T of IContainer
  */
 interface IComponent
 {
@@ -25,11 +26,13 @@ function getName(): ?string;
 
 	/**
 	 * Returns the parent container if any.
+	 * @return ?T
 	 */
 	function getParent(): ?IContainer;
 
 	/**
 	 * Sets the parent container and optionally renames the component.
+	 * @param  ?T  $parent
 	 */
 	function setParent(?IContainer $parent, ?string $name = null): static;
 }

src/ComponentModel/IContainer.php

@@ -14,29 +14,33 @@
 
 /**
  * Defines functionality for objects that can contain other components.
+ * @template T of IComponent
  */
 interface IContainer extends IComponent
 {
 	/**
 	 * Adds the component to the container.
+	 * @param  T  $component
 	 * @return static
 	 */
 	function addComponent(IComponent $component, ?string $name);
 
 	/**
 	 * Removes the component from the container.
+	 * @param  T  $component
 	 */
 	function removeComponent(IComponent $component): void;
 
 	/**
 	 * Returns component specified by name or path.
+	 * @return T
 	 * @throws Nette\InvalidArgumentException  if component doesn't exist
 	 */
 	function getComponent(string $name): ?IComponent;
 
 	/**
 	 * Returns immediate child components.
-	 * @return array<int|string,IComponent>
+	 * @return array<int|string,T>
 	 */
 	function getComponents(): iterable;
 }