Add return types, round 1

Author: nicolas-grekas

Inline.php

@@ -54,11 +54,9 @@ public static function initialize(int $flags, int $parsedLineNumber = null, stri
      * @param int    $flags      A bit field of PARSE_* constants to customize the YAML parser behavior
      * @param array  $references Mapping of variable names to values
      *
-     * @return mixed A PHP value
-     *
      * @throws ParseException
      */
-    public static function parse(string $value = null, int $flags = 0, array &$references = [])
+    public static function parse(string $value = null, int $flags = 0, array &$references = []): mixed
     {
         self::initialize($flags);
 
@@ -112,8 +110,6 @@ public static function parse(string $value = null, int $flags = 0, array &$refer
      * @param mixed $value The PHP variable to convert
      * @param int   $flags A bit field of Yaml::DUMP_* constants to customize the dumped YAML string
      *
-     * @return string The YAML string representing the PHP value
-     *
      * @throws DumpException When trying to dump PHP resource
      */
     public static function dump(mixed $value, int $flags = 0): string
@@ -213,8 +209,6 @@ public static function isHash(array|\ArrayObject|\stdClass $value): bool
      *
      * @param array $value The PHP array to dump
      * @param int   $flags A bit field of Yaml::DUMP_* constants to customize the dumped YAML string
-     *
-     * @return string The YAML string representing the PHP array
      */
     private static function dumpArray(array $value, int $flags): string
     {
@@ -249,11 +243,9 @@ private static function dumpNull(int $flags): string
     /**
      * Parses a YAML scalar.
      *
-     * @return mixed
-     *
      * @throws ParseException When malformed inline YAML string is parsed
      */
-    public static function parseScalar(string $scalar, int $flags = 0, array $delimiters = null, int &$i = 0, bool $evaluate = true, array &$references = [])
+    public static function parseScalar(string $scalar, int $flags = 0, array $delimiters = null, int &$i = 0, bool $evaluate = true, array &$references = []): mixed
     {
         if (\in_array($scalar[$i], ['"', "'"], true)) {
             // quoted scalar
@@ -540,11 +532,9 @@ private static function parseMapping(string $mapping, int $flags, int &$i = 0, a
     /**
      * Evaluates scalars and replaces magic values.
      *
-     * @return mixed The evaluated YAML string
-     *
      * @throws ParseException when object parsing support was disabled and the parser detected a PHP object or when a reference could not be resolved
      */
-    private static function evaluateScalar(string $scalar, int $flags, array &$references = [])
+    private static function evaluateScalar(string $scalar, int $flags, array &$references = []): mixed
     {
         $scalar = trim($scalar);
 
@@ -744,8 +734,6 @@ private static function isBinaryString(string $value): bool
     /**
      * Gets a regex that matches a YAML date.
      *
-     * @return string The regular expression
-     *
      * @see http://www.yaml.org/spec/1.2/spec.html#id2761573
      */
     private static function getTimestampRegex(): string

Parser.php

@@ -45,11 +45,9 @@ class Parser
      * @param string $filename The path to the YAML file to be parsed
      * @param int    $flags    A bit field of PARSE_* constants to customize the YAML parser behavior
      *
-     * @return mixed The YAML converted to a PHP value
-     *
      * @throws ParseException If the file could not be read or the YAML is not valid
      */
-    public function parseFile(string $filename, int $flags = 0)
+    public function parseFile(string $filename, int $flags = 0): mixed
     {
         if (!is_file($filename)) {
             throw new ParseException(sprintf('File "%s" does not exist.', $filename));
@@ -74,11 +72,9 @@ public function parseFile(string $filename, int $flags = 0)
      * @param string $value A YAML string
      * @param int    $flags A bit field of PARSE_* constants to customize the YAML parser behavior
      *
-     * @return mixed A PHP value
-     *
      * @throws ParseException If the YAML is not valid
      */
-    public function parse(string $value, int $flags = 0)
+    public function parse(string $value, int $flags = 0): mixed
     {
         if (false === preg_match('//u', $value)) {
             throw new ParseException('The YAML value does not appear to be valid UTF-8.', -1, null, $this->filename);
@@ -539,8 +535,6 @@ private function parseBlock(int $offset, string $yaml, int $flags)
      * Returns the current line number (takes the offset into account).
      *
      * @internal
-     *
-     * @return int The current line number
      */
     public function getRealCurrentLineNb(): int
     {
@@ -557,11 +551,6 @@ public function getRealCurrentLineNb(): int
         return $realCurrentLineNumber;
     }
 
-    /**
-     * Returns the current line indentation.
-     *
-     * @return int The current line indentation
-     */
     private function getCurrentLineIndentation(): int
     {
         if (' ' !== ($this->currentLine[0] ?? '')) {
@@ -577,8 +566,6 @@ private function getCurrentLineIndentation(): int
      * @param int|null $indentation The indent level at which the block is to be read, or null for default
      * @param bool     $inSequence  True if the enclosing data structure is a sequence
      *
-     * @return string A YAML string
-     *
      * @throws ParseException When indentation problem are detected
      */
     private function getNextEmbedBlock(int $indentation = null, bool $inSequence = false): string
@@ -718,11 +705,9 @@ private function moveToPreviousLine(): bool
      * @param int    $flags   A bit field of PARSE_* constants to customize the YAML parser behavior
      * @param string $context The parser context (either sequence or mapping)
      *
-     * @return mixed A PHP value
-     *
      * @throws ParseException When reference does not exist
      */
-    private function parseValue(string $value, int $flags, string $context)
+    private function parseValue(string $value, int $flags, string $context): mixed
     {
         if ('*' === ($value[0] ?? '')) {
             if (false !== $pos = strpos($value, '#')) {
@@ -938,8 +923,6 @@ private function parseBlockScalar(string $style, string $chomping = '', int $ind
 
     /**
      * Returns true if the next line is indented.
-     *
-     * @return bool Returns true if the next line is indented, false otherwise
      */
     private function isNextLineIndented(): bool
     {
@@ -967,31 +950,16 @@ private function isNextLineIndented(): bool
         return $ret;
     }
 
-    /**
-     * Returns true if the current line is blank or if it is a comment line.
-     *
-     * @return bool Returns true if the current line is empty or if it is a comment line, false otherwise
-     */
     private function isCurrentLineEmpty(): bool
     {
         return $this->isCurrentLineBlank() || $this->isCurrentLineComment();
     }
 
-    /**
-     * Returns true if the current line is blank.
-     *
-     * @return bool Returns true if the current line is blank, false otherwise
-     */
     private function isCurrentLineBlank(): bool
     {
         return '' === $this->currentLine || '' === trim($this->currentLine, ' ');
     }
 
-    /**
-     * Returns true if the current line is a comment line.
-     *
-     * @return bool Returns true if the current line is a comment line, false otherwise
-     */
     private function isCurrentLineComment(): bool
     {
         //checking explicitly the first char of the trim is faster than loops or strpos
@@ -1005,13 +973,6 @@ private function isCurrentLineLastLineInDocument(): bool
         return ($this->offset + $this->currentLineNb) >= ($this->totalNumberOfLines - 1);
     }
 
-    /**
-     * Cleanups a YAML string to be parsed.
-     *
-     * @param string $value The input YAML string
-     *
-     * @return string A cleaned up YAML string
-     */
     private function cleanup(string $value): string
     {
         $value = str_replace(["\r\n", "\r"], "\n", $value);
@@ -1043,11 +1004,6 @@ private function cleanup(string $value): string
         return $value;
     }
 
-    /**
-     * Returns true if the next line starts unindented collection.
-     *
-     * @return bool Returns true if the next line starts unindented collection, false otherwise
-     */
     private function isNextLineUnIndentedCollection(): bool
     {
         $currentIndentation = $this->getCurrentLineIndentation();
@@ -1074,11 +1030,6 @@ private function isNextLineUnIndentedCollection(): bool
         return $ret;
     }
 
-    /**
-     * Returns true if the string is un-indented collection item.
-     *
-     * @return bool Returns true if the string is un-indented collection item, false otherwise
-     */
     private function isStringUnIndentedCollectionItem(): bool
     {
         return 0 === strncmp($this->currentLine, '- ', 2) || '-' === rtrim($this->currentLine);

Yaml.php

@@ -46,11 +46,9 @@ class Yaml
      * @param string $filename The path to the YAML file to be parsed
      * @param int    $flags    A bit field of PARSE_* constants to customize the YAML parser behavior
      *
-     * @return mixed The YAML converted to a PHP value
-     *
      * @throws ParseException If the file could not be read or the YAML is not valid
      */
-    public static function parseFile(string $filename, int $flags = 0)
+    public static function parseFile(string $filename, int $flags = 0): mixed
     {
         $yaml = new Parser();
 
@@ -69,11 +67,9 @@ public static function parseFile(string $filename, int $flags = 0)
      * @param string $input A string containing YAML
      * @param int    $flags A bit field of PARSE_* constants to customize the YAML parser behavior
      *
-     * @return mixed The YAML converted to a PHP value
-     *
      * @throws ParseException If the YAML is not valid
      */
-    public static function parse(string $input, int $flags = 0)
+    public static function parse(string $input, int $flags = 0): mixed
     {
         $yaml = new Parser();
 
@@ -90,8 +86,6 @@ public static function parse(string $input, int $flags = 0)
      * @param int   $inline The level where you switch to inline YAML
      * @param int   $indent The amount of spaces to use for indentation of nested nodes
      * @param int   $flags  A bit field of DUMP_* constants to customize the dumped YAML string
-     *
-     * @return string A YAML string representing the original PHP value
      */
     public static function dump(mixed $input, int $inline = 2, int $indent = 4, int $flags = 0): string
     {