Merge pull request #152 from ashnazg/strict

Strict Updates

src/DocBlock.php

@@ -133,7 +133,7 @@ final class DocBlock
      *
      * @return Tag[]
      */
-    public function getTags()
+    public function getTags(): array
     {
         return $this->tags;
     }
@@ -146,7 +146,7 @@ final class DocBlock
      *
      * @return Tag[]
      */
-    public function getTagsByName(string $name)
+    public function getTagsByName(string $name): array
     {
         $result = [];
 

src/DocBlock/Description.php

@@ -72,7 +72,7 @@ class Description
      *
      * @return Tag[]
      */
-    public function getTags()
+    public function getTags(): array
     {
         return $this->tags;
     }

src/DocBlock/DescriptionFactory.php

@@ -61,7 +61,7 @@ class DescriptionFactory
      *
      * @return string[] A series of tokens of which the description text is composed.
      */
-    private function lex(string $contents)
+    private function lex(string $contents): array
     {
         $contents = $this->removeSuperfluousStartingWhitespace($contents);
 

src/DocBlock/StandardTagFactory.php

@@ -163,7 +163,7 @@ final class StandardTagFactory implements TagFactory
      *
      * @return string[]
      */
-    private function extractTagParts(string $tagLine)
+    private function extractTagParts(string $tagLine): array
     {
         $matches = [];
         if (! preg_match('/^@(' . self::REGEX_TAGNAME . ')(?:\s*([^\s].*)|$)/us', $tagLine, $matches)) {
@@ -222,7 +222,7 @@ final class StandardTagFactory implements TagFactory
      * @return mixed[] A series of values that can be passed to the Factory Method of the tag whose parameters
      *     is provided with this method.
      */
-    private function getArgumentsForParametersFromWiring($parameters, $locator)
+    private function getArgumentsForParametersFromWiring($parameters, $locator): array
     {
         $arguments = [];
         foreach ($parameters as $index => $parameter) {
@@ -251,7 +251,7 @@ final class StandardTagFactory implements TagFactory
      *
      * @return \ReflectionParameter[]
      */
-    private function fetchParametersForHandlerFactoryMethod(string $handlerClassName)
+    private function fetchParametersForHandlerFactoryMethod(string $handlerClassName): array
     {
         if (! isset($this->tagHandlerParameterCache[$handlerClassName])) {
             $methodReflection = new \ReflectionMethod($handlerClassName, 'create');
@@ -271,7 +271,7 @@ final class StandardTagFactory implements TagFactory
      *
      * @return mixed[]
      */
-    private function getServiceLocatorWithDynamicParameters(TypeContext $context, string $tagName, string $tagBody)
+    private function getServiceLocatorWithDynamicParameters(TypeContext $context, string $tagName, string $tagBody): array
     {
         $locator = array_merge(
             $this->serviceLocator,

src/DocBlock/Tags/Covers.php

@@ -47,7 +47,7 @@ final class Covers extends BaseTag implements Factory\StaticMethod
         ?DescriptionFactory $descriptionFactory = null,
         ?FqsenResolver $resolver = null,
         ?TypeContext $context = null
-    ) {
+    ): self {
         Assert::notEmpty($body);
 
         $parts = preg_split('/\s+/Su', $body, 2);

src/DocBlock/Tags/Deprecated.php

@@ -59,7 +59,7 @@ final class Deprecated extends BaseTag implements Factory\StaticMethod
         ?string $body,
         ?DescriptionFactory $descriptionFactory = null,
         ?TypeContext $context = null
-    ) {
+    ): self {
         if (empty($body)) {
             return new static();
         }

src/DocBlock/Tags/Example.php

@@ -13,7 +13,6 @@
 
 namespace phpDocumentor\Reflection\DocBlock\Tags;
 
-use phpDocumentor\Reflection\DocBlock\Description;
 use phpDocumentor\Reflection\DocBlock\Tag;
 use Webmozart\Assert\Assert;
 
@@ -81,7 +80,7 @@ final class Example extends BaseTag
     /**
      * {@inheritdoc}
      */
-    public static function create(string $body)
+    public static function create(string $body): ?Tag
     {
         // File component: File path in quotes or File URI / Source information
         if (! preg_match('/^(?:\"([^\"]+)\"|(\S+))(?:\s+(.*))?$/sux', $body, $matches)) {

src/DocBlock/Tags/Generic.php

@@ -49,7 +49,7 @@ class Generic extends BaseTag implements Factory\StaticMethod
         string $name = '',
         ?DescriptionFactory $descriptionFactory = null,
         ?TypeContext $context = null
-    ) {
+    ): self {
         Assert::stringNotEmpty($name);
         Assert::notNull($descriptionFactory);
 

src/DocBlock/Tags/Method.php

@@ -92,12 +92,12 @@ final class Method extends BaseTag implements Factory\StaticMethod
                 )?
                 # Return type
                 (?:
-                    (   
+                    (
                         (?:[\w\|_\\\\]*\$this[\w\|_\\\\]*)
                         |
                         (?:
                             (?:[\w\|_\\\\]+)
-                            # array notation           
+                            # array notation
                             (?:\[\])*
                         )*
                     )
@@ -170,7 +170,7 @@ final class Method extends BaseTag implements Factory\StaticMethod
     /**
      * @return string[]
      */
-    public function getArguments()
+    public function getArguments(): array
     {
         return $this->arguments;
     }
@@ -204,7 +204,7 @@ final class Method extends BaseTag implements Factory\StaticMethod
             . ($this->description ? ' ' . $this->description->render() : ''));
     }
 
-    private function filterArguments($arguments)
+    private function filterArguments(array $arguments = []): array
     {
         foreach ($arguments as &$argument) {
             if (is_string($argument)) {
@@ -227,7 +227,7 @@ final class Method extends BaseTag implements Factory\StaticMethod
         return $arguments;
     }
 
-    private static function stripRestArg($argument)
+    private static function stripRestArg(string $argument): string
     {
         if (strpos($argument, '...') === 0) {
             $argument = trim(substr($argument, 3));

src/DocBlock/Tags/Param.php

@@ -53,7 +53,7 @@ final class Param extends BaseTag implements Factory\StaticMethod
         ?TypeResolver $typeResolver = null,
         ?DescriptionFactory $descriptionFactory = null,
         ?TypeContext $context = null
-    ) {
+    ): self {
         Assert::stringNotEmpty($body);
         Assert::allNotNull([$typeResolver, $descriptionFactory]);
 

src/DocBlock/Tags/Property.php

@@ -49,7 +49,7 @@ class Property extends BaseTag implements Factory\StaticMethod
         ?TypeResolver $typeResolver = null,
         ?DescriptionFactory $descriptionFactory = null,
         ?TypeContext $context = null
-    ) {
+    ): self {
         Assert::stringNotEmpty($body);
         Assert::allNotNull([$typeResolver, $descriptionFactory]);
 

src/DocBlock/Tags/PropertyRead.php

@@ -49,7 +49,7 @@ class PropertyRead extends BaseTag implements Factory\StaticMethod
         ?TypeResolver $typeResolver = null,
         ?DescriptionFactory $descriptionFactory = null,
         ?TypeContext $context = null
-    ) {
+    ): self {
         Assert::stringNotEmpty($body);
         Assert::allNotNull([$typeResolver, $descriptionFactory]);
 

src/DocBlock/Tags/PropertyWrite.php

@@ -49,7 +49,7 @@ class PropertyWrite extends BaseTag implements Factory\StaticMethod
         ?TypeResolver $typeResolver = null,
         ?DescriptionFactory $descriptionFactory = null,
         ?TypeContext $context = null
-    ) {
+    ): self {
         Assert::stringNotEmpty($body);
         Assert::allNotNull([$typeResolver, $descriptionFactory]);
 

src/DocBlock/Tags/Reference/Url.php

@@ -28,7 +28,7 @@ final class Url implements Reference
     /**
      * Url constructor.
      */
-    public function __construct($uri)
+    public function __construct(string $uri)
     {
         Assert::stringNotEmpty($uri);
         $this->uri = $uri;

src/DocBlock/Tags/Return_.php

@@ -44,7 +44,7 @@ final class Return_ extends BaseTag implements Factory\StaticMethod
         ?TypeResolver $typeResolver = null,
         ?DescriptionFactory $descriptionFactory = null,
         ?TypeContext $context = null
-    ) {
+    ): self {
         Assert::allNotNull([$typeResolver, $descriptionFactory]);
 
         $parts = preg_split('/\s+/Su', $body, 2);

src/DocBlock/Tags/See.php

@@ -49,7 +49,7 @@ class See extends BaseTag implements Factory\StaticMethod
         ?FqsenResolver $resolver = null,
         ?DescriptionFactory $descriptionFactory = null,
         ?TypeContext $context = null
-    ) {
+    ): self {
         Assert::allNotNull([$resolver, $descriptionFactory]);
 
         $parts = preg_split('/\s+/Su', $body, 2);

src/DocBlock/Tags/Since.php

@@ -15,7 +15,6 @@ namespace phpDocumentor\Reflection\DocBlock\Tags;
 
 use phpDocumentor\Reflection\DocBlock\Description;
 use phpDocumentor\Reflection\DocBlock\DescriptionFactory;
-use phpDocumentor\Reflection\DocBlock\Tag;
 use phpDocumentor\Reflection\Types\Context as TypeContext;
 use Webmozart\Assert\Assert;
 

src/DocBlock/Tags/Source.php

@@ -49,7 +49,7 @@ final class Source extends BaseTag implements Factory\StaticMethod
         string $body,
         ?DescriptionFactory $descriptionFactory = null,
         ?TypeContext $context = null
-    ) {
+    ): self {
         Assert::stringNotEmpty($body);
         Assert::notNull($descriptionFactory);
 

src/DocBlock/Tags/Throws.php

@@ -44,7 +44,7 @@ final class Throws extends BaseTag implements Factory\StaticMethod
         ?TypeResolver $typeResolver = null,
         ?DescriptionFactory $descriptionFactory = null,
         ?TypeContext $context = null
-    ) {
+    ): self {
         Assert::allNotNull([$typeResolver, $descriptionFactory]);
 
         $parts = preg_split('/\s+/Su', $body, 2);

src/DocBlock/Tags/Uses.php

@@ -47,7 +47,7 @@ final class Uses extends BaseTag implements Factory\StaticMethod
         ?FqsenResolver $resolver = null,
         ?DescriptionFactory $descriptionFactory = null,
         ?TypeContext $context = null
-    ) {
+    ): self {
         Assert::allNotNull([$resolver, $descriptionFactory]);
 
         $parts = preg_split('/\s+/Su', $body, 2);

src/DocBlock/Tags/Var_.php

@@ -49,7 +49,7 @@ class Var_ extends BaseTag implements Factory\StaticMethod
         ?TypeResolver $typeResolver = null,
         ?DescriptionFactory $descriptionFactory = null,
         ?TypeContext $context = null
-    ) {
+    ): self {
         Assert::stringNotEmpty($body);
         Assert::allNotNull([$typeResolver, $descriptionFactory]);
 

src/DocBlockFactory.php

@@ -127,7 +127,7 @@ final class DocBlockFactory implements DocBlockFactoryInterface
      *
      * @return string[] containing the template marker (if any), summary, description and a string containing the tags.
      */
-    private function splitDocBlock(string $comment)
+    private function splitDocBlock(string $comment): array
     {
         // Performance improvement cheat: if the first character is an @ then only tags are in this DocBlock. This
         // method does not split tags so we return this verbatim as the fourth result (tags). This saves us the
@@ -227,7 +227,7 @@ final class DocBlockFactory implements DocBlockFactoryInterface
     /**
      * @return string[]
      */
-    private function splitTagBlockIntoTagLines(string $tags)
+    private function splitTagBlockIntoTagLines(string $tags): array
     {
         $result = [];
         foreach (explode("\n", $tags) as $tag_line) {