Fix phpdoc and coding standards

This removes the unused use statements which were not catched by
PHP-CS-Fixer because of string occurences. It also fixes some invalid
phpdoc (scalar is not recognized as a valid type for instance).

Author: stof

Encoder/DecoderInterface.php

@@ -21,7 +21,7 @@ interface DecoderInterface
     /**
      * Decodes a string into PHP data.
      *
-     * @param scalar $data    Data to decode
+     * @param string $data    Data to decode
      * @param string $format  Format name
      * @param array  $context options that decoders have access to.
      *

Encoder/EncoderInterface.php

@@ -25,7 +25,7 @@ interface EncoderInterface
      * @param string $format  Format name
      * @param array  $context options that normalizers/encoders have access to.
      *
-     * @return scalar
+     * @return string|bool|int|float|null
      */
     public function encode($data, $format, array $context = array());
 

Encoder/XmlEncoder.php

@@ -22,6 +22,9 @@
  */
 class XmlEncoder extends SerializerAwareEncoder implements EncoderInterface, DecoderInterface, NormalizationAwareInterface
 {
+    /**
+     * @var \DOMDocument
+     */
     private $dom;
     private $format;
     private $rootNodeName = 'response';
@@ -164,7 +167,7 @@ public function getRootNodeName()
      *
      * @return bool
      */
-    final protected function appendXMLString($node, $val)
+    final protected function appendXMLString(\DOMNode $node, $val)
     {
         if (strlen($val) > 0) {
             $frag = $this->dom->createDocumentFragment();
@@ -178,12 +181,12 @@ final protected function appendXMLString($node, $val)
     }
 
     /**
-     * @param DOMNode $node
-     * @param string  $val
+     * @param \DOMNode $node
+     * @param string   $val
      *
      * @return bool
      */
-    final protected function appendText($node, $val)
+    final protected function appendText(\DOMNode $node, $val)
     {
         $nodeText = $this->dom->createTextNode($val);
         $node->appendChild($nodeText);
@@ -192,12 +195,12 @@ final protected function appendText($node, $val)
     }
 
     /**
-     * @param DOMNode $node
-     * @param string  $val
+     * @param \DOMNode $node
+     * @param string   $val
      *
      * @return bool
      */
-    final protected function appendCData($node, $val)
+    final protected function appendCData(\DOMNode $node, $val)
     {
         $nodeText = $this->dom->createCDATASection($val);
         $node->appendChild($nodeText);
@@ -206,12 +209,12 @@ final protected function appendCData($node, $val)
     }
 
     /**
-     * @param DOMNode             $node
-     * @param DOMDocumentFragment $fragment
+     * @param \DOMNode             $node
+     * @param \DOMDocumentFragment $fragment
      *
      * @return bool
      */
-    final protected function appendDocumentFragment($node, $fragment)
+    final protected function appendDocumentFragment(\DOMNode $node, $fragment)
     {
         if ($fragment instanceof \DOMDocumentFragment) {
             $node->appendChild($fragment);
@@ -239,11 +242,11 @@ final protected function isElementNameValid($name)
     /**
      * Parse the input SimpleXmlElement into an array.
      *
-     * @param SimpleXmlElement $node xml to parse
+     * @param \SimpleXmlElement $node xml to parse
      *
      * @return array
      */
-    private function parseXml($node)
+    private function parseXml(\SimpleXMLElement $node)
     {
         $data = array();
         if ($node->attributes()) {
@@ -290,15 +293,15 @@ private function parseXml($node)
     /**
      * Parse the data and convert it to DOMElements.
      *
-     * @param DOMNode      $parentNode
+     * @param \DOMElement  $parentNode
      * @param array|object $data            data
      * @param string       $xmlRootNodeName
      *
      * @return bool
      *
      * @throws UnexpectedValueException
      */
-    private function buildXml($parentNode, $data, $xmlRootNodeName = null)
+    private function buildXml(\DOMElement $parentNode, $data, $xmlRootNodeName = null)
     {
         $append = true;
 
@@ -358,14 +361,14 @@ private function buildXml($parentNode, $data, $xmlRootNodeName = null)
     /**
      * Selects the type of node to create and appends it to the parent.
      *
-     * @param DOMNode      $parentNode
+     * @param \DOMNode     $parentNode
      * @param array|object $data
      * @param string       $nodeName
      * @param string       $key
      *
      * @return bool
      */
-    private function appendNode($parentNode, $data, $nodeName, $key = null)
+    private function appendNode(\DOMNode $parentNode, $data, $nodeName, $key = null)
     {
         $node = $this->dom->createElement($nodeName);
         if (null !== $key) {
@@ -395,12 +398,12 @@ private function needsCdataWrapping($val)
     /**
      * Tests the value being passed and decide what sort of element to create.
      *
-     * @param DOMNode $node
-     * @param mixed   $val
+     * @param \DOMNode $node
+     * @param mixed    $val
      *
      * @return bool
      */
-    private function selectNodeType($node, $val)
+    private function selectNodeType(\DOMNode $node, $val)
     {
         if (is_array($val)) {
             return $this->buildXml($node, $val);

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|bool|int|float|null $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
      */
     public function denormalize(DenormalizerInterface $denormalizer, $data, $format = null, array $context = array());
 }

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|bool|int|float|null
      */
     public function normalize(NormalizerInterface $normalizer, $format = null, array $context = array());
 }

Normalizer/NormalizerInterface.php

@@ -25,7 +25,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|bool|int|float|null
      */
     public function normalize($object, $format = null, array $context = array());
 

Serializer.php

@@ -218,7 +218,7 @@ final public function decode($data, $format, array $context = array())
      * @param string $format  format name, present to give the option to normalizers to act differently based on formats
      * @param array  $context The context data for this particular normalization
      *
-     * @return array|scalar
+     * @return array|string|bool|int|float|null
      *
      * @throws LogicException
      * @throws UnexpectedValueException