Merge pull request #152 from ashnazg/strict

ashnazg · web-flow · commit 6946f85e19ea · 2018-01-31T14:23:19.000-06:00
Strict Updates
diff --git a/src/DocBlock.php b/src/DocBlock.php
@@ -133,7 +133,7 @@ public function isTemplateEnd(): bool
      *
      * @return Tag[]
      */
-    public function getTags()
+    public function getTags(): array
     {
         return $this->tags;
     }
@@ -146,7 +146,7 @@ public function getTags()
      *
      * @return Tag[]
      */
-    public function getTagsByName(string $name)
+    public function getTagsByName(string $name): array
     {
         $result = [];
 
diff --git a/src/DocBlock/Description.php b/src/DocBlock/Description.php
@@ -72,7 +72,7 @@ public function __construct(string $bodyTemplate, array $tags = [])
      *
      * @return Tag[]
      */
-    public function getTags()
+    public function getTags(): array
     {
         return $this->tags;
     }
diff --git a/src/DocBlock/DescriptionFactory.php b/src/DocBlock/DescriptionFactory.php
@@ -61,7 +61,7 @@ public function create(string $contents, ?TypeContext $context = null): Descript
      *
      * @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);
 
diff --git a/src/DocBlock/StandardTagFactory.php b/src/DocBlock/StandardTagFactory.php
@@ -163,7 +163,7 @@ public function registerTagHandler(string $tagName, string $handler): void
      *
      * @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 @@ private function findHandlerClassName(string $tagName, TypeContext $context): st
      * @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 @@ private function getArgumentsForParametersFromWiring($parameters, $locator)
      *
      * @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 @@ private function fetchParametersForHandlerFactoryMethod(string $handlerClassName
      *
      * @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,
diff --git a/src/DocBlock/Tags/Covers.php b/src/DocBlock/Tags/Covers.php
@@ -47,7 +47,7 @@ public static function create(
         ?DescriptionFactory $descriptionFactory = null,
         ?FqsenResolver $resolver = null,
         ?TypeContext $context = null
-    ) {
+    ): self {
         Assert::notEmpty($body);
 
         $parts = preg_split('/\s+/Su', $body, 2);
diff --git a/src/DocBlock/Tags/Deprecated.php b/src/DocBlock/Tags/Deprecated.php
@@ -59,7 +59,7 @@ public static function create(
         ?string $body,
         ?DescriptionFactory $descriptionFactory = null,
         ?TypeContext $context = null
-    ) {
+    ): self {
         if (empty($body)) {
             return new static();
         }
diff --git a/src/DocBlock/Tags/Example.php b/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 @@ public function getContent()
     /**
      * {@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)) {
diff --git a/src/DocBlock/Tags/Generic.php b/src/DocBlock/Tags/Generic.php
@@ -49,7 +49,7 @@ public static function create(
         string $name = '',
         ?DescriptionFactory $descriptionFactory = null,
         ?TypeContext $context = null
-    ) {
+    ): self {
         Assert::stringNotEmpty($name);
         Assert::notNull($descriptionFactory);
 
diff --git a/src/DocBlock/Tags/Method.php b/src/DocBlock/Tags/Method.php
@@ -92,12 +92,12 @@ public static function create(
                 )?
                 # Return type
                 (?:
-                    (   
+                    (
                         (?:[\w\|_\\\\]*\$this[\w\|_\\\\]*)
                         |
                         (?:
                             (?:[\w\|_\\\\]+)
-                            # array notation           
+                            # array notation
                             (?:\[\])*
                         )*
                     )
@@ -170,7 +170,7 @@ public function getMethodName(): string
     /**
      * @return string[]
      */
-    public function getArguments()
+    public function getArguments(): array
     {
         return $this->arguments;
     }
@@ -204,7 +204,7 @@ public function __toString(): string
             . ($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 @@ private function filterArguments($arguments)
         return $arguments;
     }
 
-    private static function stripRestArg($argument)
+    private static function stripRestArg(string $argument): string
     {
         if (strpos($argument, '...') === 0) {
             $argument = trim(substr($argument, 3));
diff --git a/src/DocBlock/Tags/Param.php b/src/DocBlock/Tags/Param.php
@@ -53,7 +53,7 @@ public static function create(
         ?TypeResolver $typeResolver = null,
         ?DescriptionFactory $descriptionFactory = null,
         ?TypeContext $context = null
-    ) {
+    ): self {
         Assert::stringNotEmpty($body);
         Assert::allNotNull([$typeResolver, $descriptionFactory]);
 
diff --git a/src/DocBlock/Tags/Property.php b/src/DocBlock/Tags/Property.php
@@ -49,7 +49,7 @@ public static function create(
         ?TypeResolver $typeResolver = null,
         ?DescriptionFactory $descriptionFactory = null,
         ?TypeContext $context = null
-    ) {
+    ): self {
         Assert::stringNotEmpty($body);
         Assert::allNotNull([$typeResolver, $descriptionFactory]);
 
diff --git a/src/DocBlock/Tags/PropertyRead.php b/src/DocBlock/Tags/PropertyRead.php
@@ -49,7 +49,7 @@ public static function create(
         ?TypeResolver $typeResolver = null,
         ?DescriptionFactory $descriptionFactory = null,
         ?TypeContext $context = null
-    ) {
+    ): self {
         Assert::stringNotEmpty($body);
         Assert::allNotNull([$typeResolver, $descriptionFactory]);
 
diff --git a/src/DocBlock/Tags/PropertyWrite.php b/src/DocBlock/Tags/PropertyWrite.php
@@ -49,7 +49,7 @@ public static function create(
         ?TypeResolver $typeResolver = null,
         ?DescriptionFactory $descriptionFactory = null,
         ?TypeContext $context = null
-    ) {
+    ): self {
         Assert::stringNotEmpty($body);
         Assert::allNotNull([$typeResolver, $descriptionFactory]);
 
diff --git a/src/DocBlock/Tags/Reference/Url.php b/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;
diff --git a/src/DocBlock/Tags/Return_.php b/src/DocBlock/Tags/Return_.php
@@ -44,7 +44,7 @@ public static function create(
         ?TypeResolver $typeResolver = null,
         ?DescriptionFactory $descriptionFactory = null,
         ?TypeContext $context = null
-    ) {
+    ): self {
         Assert::allNotNull([$typeResolver, $descriptionFactory]);
 
         $parts = preg_split('/\s+/Su', $body, 2);
diff --git a/src/DocBlock/Tags/See.php b/src/DocBlock/Tags/See.php
@@ -49,7 +49,7 @@ public static function create(
         ?FqsenResolver $resolver = null,
         ?DescriptionFactory $descriptionFactory = null,
         ?TypeContext $context = null
-    ) {
+    ): self {
         Assert::allNotNull([$resolver, $descriptionFactory]);
 
         $parts = preg_split('/\s+/Su', $body, 2);
diff --git a/src/DocBlock/Tags/Since.php b/src/DocBlock/Tags/Since.php
@@ -15,7 +15,6 @@
 
 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;
 
diff --git a/src/DocBlock/Tags/Source.php b/src/DocBlock/Tags/Source.php
@@ -49,7 +49,7 @@ public static function create(
         string $body,
         ?DescriptionFactory $descriptionFactory = null,
         ?TypeContext $context = null
-    ) {
+    ): self {
         Assert::stringNotEmpty($body);
         Assert::notNull($descriptionFactory);
 
diff --git a/src/DocBlock/Tags/Throws.php b/src/DocBlock/Tags/Throws.php
@@ -44,7 +44,7 @@ public static function create(
         ?TypeResolver $typeResolver = null,
         ?DescriptionFactory $descriptionFactory = null,
         ?TypeContext $context = null
-    ) {
+    ): self {
         Assert::allNotNull([$typeResolver, $descriptionFactory]);
 
         $parts = preg_split('/\s+/Su', $body, 2);
diff --git a/src/DocBlock/Tags/Uses.php b/src/DocBlock/Tags/Uses.php
@@ -47,7 +47,7 @@ public static function create(
         ?FqsenResolver $resolver = null,
         ?DescriptionFactory $descriptionFactory = null,
         ?TypeContext $context = null
-    ) {
+    ): self {
         Assert::allNotNull([$resolver, $descriptionFactory]);
 
         $parts = preg_split('/\s+/Su', $body, 2);
diff --git a/src/DocBlock/Tags/Var_.php b/src/DocBlock/Tags/Var_.php
@@ -49,7 +49,7 @@ public static function create(
         ?TypeResolver $typeResolver = null,
         ?DescriptionFactory $descriptionFactory = null,
         ?TypeContext $context = null
-    ) {
+    ): self {
         Assert::stringNotEmpty($body);
         Assert::allNotNull([$typeResolver, $descriptionFactory]);
 
diff --git a/src/DocBlockFactory.php b/src/DocBlockFactory.php
@@ -127,7 +127,7 @@ private function stripDocComment(string $comment): string
      *
      * @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 @@ private function parseTagBlock(string $tags, Types\Context $context): array
     /**
      * @return string[]
      */
-    private function splitTagBlockIntoTagLines(string $tags)
+    private function splitTagBlockIntoTagLines(string $tags): array
     {
         $result = [];
         foreach (explode("\n", $tags) as $tag_line) {

Original file line number	Diff line number	Diff line change
`@@ -133,7 +133,7 @@ public function isTemplateEnd(): bool`
`133`	`133`	`*`
`134`	`134`	`* @return Tag[]`
`135`	`135`	`*/`
`136`		`- public function getTags()`
	`136`	`+ public function getTags(): array`
`137`	`137`	`{`
`138`	`138`	`return $this->tags;`
`139`	`139`	`}`
`@@ -146,7 +146,7 @@ public function getTags()`
`146`	`146`	`*`
`147`	`147`	`* @return Tag[]`
`148`	`148`	`*/`
`149`		`- public function getTagsByName(string $name)`
	`149`	`+ public function getTagsByName(string $name): array`
`150`	`150`	`{`
`151`	`151`	`$result = [];`
`152`	`152`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ public function __construct(string $bodyTemplate, array $tags = [])`
`72`	`72`	`*`
`73`	`73`	`* @return Tag[]`
`74`	`74`	`*/`
`75`		`- public function getTags()`
	`75`	`+ public function getTags(): array`
`76`	`76`	`{`
`77`	`77`	`return $this->tags;`
`78`	`78`	`}`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ public function create(string $contents, ?TypeContext $context = null): Descript`
`61`	`61`	`*`
`62`	`62`	`* @return string[] A series of tokens of which the description text is composed.`
`63`	`63`	`*/`
`64`		`- private function lex(string $contents)`
	`64`	`+ private function lex(string $contents): array`
`65`	`65`	`{`
`66`	`66`	`$contents = $this->removeSuperfluousStartingWhitespace($contents);`
`67`	`67`
Original file line number	Diff line number	Diff line change
`@@ -163,7 +163,7 @@ public function registerTagHandler(string $tagName, string $handler): void`
`163`	`163`	`*`
`164`	`164`	`* @return string[]`
`165`	`165`	`*/`
`166`		`- private function extractTagParts(string $tagLine)`
	`166`	`+ private function extractTagParts(string $tagLine): array`
`167`	`167`	`{`
`168`	`168`	`$matches = [];`
`169`	`169`	`if (! preg_match('/^@(' . self::REGEX_TAGNAME . ')(?:\s([^\s].)\|$)/us', $tagLine, $matches)) {`
`@@ -222,7 +222,7 @@ private function findHandlerClassName(string $tagName, TypeContext $context): st`
`222`	`222`	`* @return mixed[] A series of values that can be passed to the Factory Method of the tag whose parameters`
`223`	`223`	`* is provided with this method.`
`224`	`224`	`*/`
`225`		`- private function getArgumentsForParametersFromWiring($parameters, $locator)`
	`225`	`+ private function getArgumentsForParametersFromWiring($parameters, $locator): array`
`226`	`226`	`{`
`227`	`227`	`$arguments = [];`
`228`	`228`	`foreach ($parameters as $index => $parameter) {`
`@@ -251,7 +251,7 @@ private function getArgumentsForParametersFromWiring($parameters, $locator)`
`251`	`251`	`*`
`252`	`252`	`* @return \ReflectionParameter[]`
`253`	`253`	`*/`
`254`		`- private function fetchParametersForHandlerFactoryMethod(string $handlerClassName)`
	`254`	`+ private function fetchParametersForHandlerFactoryMethod(string $handlerClassName): array`
`255`	`255`	`{`
`256`	`256`	`if (! isset($this->tagHandlerParameterCache[$handlerClassName])) {`
`257`	`257`	`$methodReflection = new \ReflectionMethod($handlerClassName, 'create');`
`@@ -271,7 +271,7 @@ private function fetchParametersForHandlerFactoryMethod(string $handlerClassName`
`271`	`271`	`*`
`272`	`272`	`* @return mixed[]`
`273`	`273`	`*/`
`274`		`- private function getServiceLocatorWithDynamicParameters(TypeContext $context, string $tagName, string $tagBody)`
	`274`	`+ private function getServiceLocatorWithDynamicParameters(TypeContext $context, string $tagName, string $tagBody): array`
`275`	`275`	`{`
`276`	`276`	`$locator = array_merge(`
`277`	`277`	`$this->serviceLocator,`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ public static function create(`
`59`	`59`	`?string $body,`
`60`	`60`	`?DescriptionFactory $descriptionFactory = null,`
`61`	`61`	`?TypeContext $context = null`
`62`		`- ) {`
	`62`	`+ ): self {`
`63`	`63`	`if (empty($body)) {`
`64`	`64`	`return new static();`
`65`	`65`	`}`
Original file line number	Diff line number	Diff line change
`@@ -92,12 +92,12 @@ public static function create(`
`92`	`92`	`)?`
`93`	`93`	`# Return type`
`94`	`94`	`(?:`
`95`		`- (`
	`95`	`+ (`
`96`	`96`	`(?:[\w\\|_\\\\]\$this[\w\\|_\\\\])`
`97`	`97`	`\|`
`98`	`98`	`(?:`
`99`	`99`	`(?:[\w\\|_\\\\]+)`
`100`		`- # array notation`
	`100`	`+ # array notation`
`101`	`101`	`(?:\[\])*`
`102`	`102`	`)*`
`103`	`103`	`)`
`@@ -170,7 +170,7 @@ public function getMethodName(): string`
`170`	`170`	`/**`
`171`	`171`	`* @return string[]`
`172`	`172`	`*/`
`173`		`- public function getArguments()`
	`173`	`+ public function getArguments(): array`
`174`	`174`	`{`
`175`	`175`	`return $this->arguments;`
`176`	`176`	`}`
`@@ -204,7 +204,7 @@ public function __toString(): string`
`204`	`204`	`. ($this->description ? ' ' . $this->description->render() : ''));`
`205`	`205`	`}`
`206`	`206`
`207`		`- private function filterArguments($arguments)`
	`207`	`+ private function filterArguments(array $arguments = []): array`
`208`	`208`	`{`
`209`	`209`	`foreach ($arguments as &$argument) {`
`210`	`210`	`if (is_string($argument)) {`
`@@ -227,7 +227,7 @@ private function filterArguments($arguments)`
`227`	`227`	`return $arguments;`
`228`	`228`	`}`
`229`	`229`
`230`		`- private static function stripRestArg($argument)`
	`230`	`+ private static function stripRestArg(string $argument): string`
`231`	`231`	`{`
`232`	`232`	`if (strpos($argument, '...') === 0) {`
`233`	`233`	`$argument = trim(substr($argument, 3));`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ final class Url implements Reference`
`28`	`28`	`/**`
`29`	`29`	`* Url constructor.`
`30`	`30`	`*/`
`31`		`- public function __construct($uri)`
	`31`	`+ public function __construct(string $uri)`
`32`	`32`	`{`
`33`	`33`	`Assert::stringNotEmpty($uri);`
`34`	`34`	`$this->uri = $uri;`
Original file line number	Diff line number	Diff line change
`@@ -127,7 +127,7 @@ private function stripDocComment(string $comment): string`
`127`	`127`	`*`
`128`	`128`	`* @return string[] containing the template marker (if any), summary, description and a string containing the tags.`
`129`	`129`	`*/`
`130`		`- private function splitDocBlock(string $comment)`
	`130`	`+ private function splitDocBlock(string $comment): array`
`131`	`131`	`{`
`132`	`132`	`// Performance improvement cheat: if the first character is an @ then only tags are in this DocBlock. This`
`133`	`133`	`// method does not split tags so we return this verbatim as the fourth result (tags). This saves us the`
`@@ -227,7 +227,7 @@ private function parseTagBlock(string $tags, Types\Context $context): array`
`227`	`227`	`/**`
`228`	`228`	`* @return string[]`
`229`	`229`	`*/`
`230`		`- private function splitTagBlockIntoTagLines(string $tags)`
	`230`	`+ private function splitTagBlockIntoTagLines(string $tags): array`
`231`	`231`	`{`
`232`	`232`	`$result = [];`
`233`	`233`	`foreach (explode("\n", $tags) as $tag_line) {`