minor #25585 Add type string to docblock for Process::setInput() (ica…

…nhazstring) This PR was submitted for the 3.4 branch but it was squashed and merged into the 3.3 branch instead (closes #25585). Discussion ---------- Add type string to docblock for Process::setInput() | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | none | License | MIT | Doc PR | none Add `string` as valid `$input` for `Process::setInput()`. Since `getInput()` will also return as string and the internal method `ProcessUtils::validateInput()` will accept a string, this should be a viable input type. Commits ------- e3de68f Add type string to docblock for Process::setInput()
symfony · Jan 7, 2018 · 6108a21 · 6108a21
2 parents 840a3d8 + e3de68f
commit 6108a21
Show file tree

Hide file tree

Showing 10 changed files with 19 additions and 17 deletions.
diff --git a/src/Symfony/Component/Process/InputStream.php b/src/Symfony/Component/Process/InputStream.php
@@ -20,6 +20,7 @@
  */
 class InputStream implements \IteratorAggregate
 {
+    /** @var null|callable */
     private $onEmpty = null;
     private $input = array();
     private $open = true;
@@ -35,7 +36,8 @@ public function onEmpty(callable $onEmpty = null)
     /**
      * Appends an input to the write buffer.
      *
-     * @param resource|scalar|\Traversable|null The input to append as stream resource, scalar or \Traversable
+     * @param resource|string|int|float|bool|\Traversable|null The input to append as scalar,
+     *                                                         stream resource or \Traversable
      */
     public function write($input)
     {

diff --git a/src/Symfony/Component/Process/Pipes/AbstractPipes.php b/src/Symfony/Component/Process/Pipes/AbstractPipes.php
@@ -27,7 +27,7 @@ abstract class AbstractPipes implements PipesInterface
     private $blocked = true;
 
     /**
-     * @param resource|scalar|\Iterator|null $input
+     * @param resource|string|int|float|bool|\Iterator|null $input
      */
     public function __construct($input)
     {

diff --git a/src/Symfony/Component/Process/Process.php b/src/Symfony/Component/Process/Process.php
@@ -1158,7 +1158,7 @@ public function getInput()
      *
      * This content will be passed to the underlying process standard input.
      *
-     * @param resource|scalar|\Traversable|null $input The content
+     * @param string|int|float|bool|resource|\Traversable|null $input The content
      *
      * @return self The current Process instance
      *

diff --git a/src/Symfony/Component/Process/ProcessBuilder.php b/src/Symfony/Component/Process/ProcessBuilder.php
@@ -167,7 +167,7 @@ public function addEnvironmentVariables(array $variables)
     /**
      * Sets the input of the process.
      *
-     * @param resource|scalar|\Traversable|null $input The input content
+     * @param resource|string|int|float|bool|\Traversable|null $input The input content
      *
      * @return $this
      *

diff --git a/src/Symfony/Component/Serializer/Encoder/EncoderInterface.php b/src/Symfony/Component/Serializer/Encoder/EncoderInterface.php
@@ -27,7 +27,7 @@ interface EncoderInterface
      * @param string $format  Format name
      * @param array  $context Options that normalizers/encoders have access to
      *
-     * @return scalar
+     * @return string|int|float|bool
      *
      * @throws UnexpectedValueException
      */

diff --git a/src/Symfony/Component/Serializer/Normalizer/DenormalizableInterface.php b/src/Symfony/Component/Serializer/Normalizer/DenormalizableInterface.php
@@ -27,12 +27,12 @@ interface DenormalizableInterface
      * It is important to understand that the denormalize() call should denormalize
      * recursively all child objects of the implementor.
      *
-     * @param DenormalizerInterface $denormalizer The denormalizer is given so that you
-     *                                            can use it to denormalize objects contained within this object
-     * @param array|scalar          $data         The data from which to re-create the object
-     * @param string|null           $format       The format is optionally given to be able to denormalize differently
-     *                                            based on different input formats
-     * @param array                 $context      Options for denormalizing
+     * @param DenormalizerInterface       $denormalizer The denormalizer is given so that you
+     *                                                  can use it to denormalize objects contained within this object
+     * @param array|string|int|float|bool $data         The data from which to re-create the object
+     * @param string|null                 $format       The format is optionally given to be able to denormalize
+     *                                                  differently based on different input formats
+     * @param array                       $context      Options for denormalizing
      *
      * @return object
      */

diff --git a/src/Symfony/Component/Serializer/Normalizer/NormalizableInterface.php b/src/Symfony/Component/Serializer/Normalizer/NormalizableInterface.php
@@ -33,7 +33,7 @@ interface NormalizableInterface
      *                                        based on different output formats
      * @param array               $context    Options for normalizing this object
      *
-     * @return array|scalar
+     * @return array|string|int|float|bool
      */
     public function normalize(NormalizerInterface $normalizer, $format = null, array $context = array());
 }
diff --git a/src/Symfony/Component/Serializer/Normalizer/NormalizerInterface.php b/src/Symfony/Component/Serializer/Normalizer/NormalizerInterface.php
@@ -29,7 +29,7 @@ interface NormalizerInterface
      * @param string $format  Format the normalization result will be encoded as
      * @param array  $context Context options for the normalizer
      *
-     * @return array|scalar
+     * @return array|string|int|float|bool
      *
      * @throws InvalidArgumentException   Occurs when the object given is not an attempted type for the normalizer
      * @throws CircularReferenceException Occurs when the normalizer detects a circular reference when no circular

diff --git a/src/Symfony/Component/VarDumper/Cloner/Data.php b/src/Symfony/Component/VarDumper/Cloner/Data.php
@@ -63,7 +63,7 @@ public function getType()
     /**
      * @param bool $recursive Whether values should be resolved recursively or not
      *
-     * @return scalar|array|null|Data[] A native representation of the original value
+     * @return string|int|float|bool|array|null|Data[] A native representation of the original value
      */
     public function getValue($recursive = false)
     {

diff --git a/src/Symfony/Component/VarDumper/Cloner/DumperInterface.php b/src/Symfony/Component/VarDumper/Cloner/DumperInterface.php
@@ -21,9 +21,9 @@ interface DumperInterface
     /**
      * Dumps a scalar value.
      *
-     * @param Cursor $cursor The Cursor position in the dump
-     * @param string $type   The PHP type of the value being dumped
-     * @param scalar $value  The scalar value being dumped
+     * @param Cursor                $cursor The Cursor position in the dump
+     * @param string                $type   The PHP type of the value being dumped
+     * @param string|int|float|bool $value  The scalar value being dumped
      */
     public function dumpScalar(Cursor $cursor, $type, $value);