diogo/symfony
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix phpdoc and add typehints to private methods

Browse Source
This commit is contained in:
Tobias Schultze 2013-06-05 02:05:55 +02:00 committed by Fabien Potencier
parent 49c4a79a1d
commit 869fd2c6e5
1 changed files with 27 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
src/Symfony/Component/Serializer/Encoder/XmlEncoder.php
View File

@ -107,24 +107,16 @@ class XmlEncoder extends SerializerAwareEncoder implements EncoderInterface, Dec
}
/**
* Checks whether the serializer can encode to given format
*
* @param string $format format name
*
* @return Boolean
*/
* {@inheritdoc}
*/
public function supportsEncoding($format)
{
return 'xml' === $format;
}
/**
* Checks whether the serializer can decode from given format
*
* @param string $format format name
*
* @return Boolean
*/
* {@inheritdoc}
*/
public function supportsDecoding($format)
{
return 'xml' === $format;
@ -150,12 +142,12 @@ class XmlEncoder extends SerializerAwareEncoder implements EncoderInterface, Dec
}
/**
* @param DOMNode $node
* @param string $val
* @param \DOMNode $node
* @param string $val
*
* @return Boolean
*/
final protected function appendXMLString($node, $val)
final protected function appendXMLString(\DOMNode $node, $val)
{
if (strlen($val) > 0) {
$frag = $this->dom->createDocumentFragment();
@ -169,12 +161,12 @@ class XmlEncoder extends SerializerAwareEncoder implements EncoderInterface, Dec
}
/**
* @param DOMNode $node
* @param string $val
* @param \DOMNode $node
* @param string $val
*
* @return Boolean
*/
final protected function appendText($node, $val)
final protected function appendText(\DOMNode $node, $val)
{
$nodeText = $this->dom->createTextNode($val);
$node->appendChild($nodeText);
@ -183,12 +175,12 @@ class XmlEncoder extends SerializerAwareEncoder implements EncoderInterface, Dec
}
/**
* @param DOMNode $node
* @param string $val
* @param \DOMNode $node
* @param string $val
*
* @return Boolean
*/
final protected function appendCData($node, $val)
final protected function appendCData(\DOMNode $node, $val)
{
$nodeText = $this->dom->createCDATASection($val);
$node->appendChild($nodeText);
@ -197,12 +189,12 @@ class XmlEncoder extends SerializerAwareEncoder implements EncoderInterface, Dec
}
/**
* @param DOMNode $node
* @param DOMDocumentFragment $fragment
* @param \DOMNode $node
* @param \DOMDocumentFragment $fragment
*
* @return Boolean
*/
final protected function appendDocumentFragment($node, $fragment)
final protected function appendDocumentFragment(\DOMNode $node, $fragment)
{
if ($fragment instanceof \DOMDocumentFragment) {
$node->appendChild($fragment);
@ -230,11 +222,11 @@ class XmlEncoder extends SerializerAwareEncoder implements EncoderInterface, Dec
/**
* 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()) {
@ -281,15 +273,15 @@ class XmlEncoder extends SerializerAwareEncoder implements EncoderInterface, Dec
/**
* Parse the data and convert it to DOMElements
*
* @param DOMNode $parentNode
* @param array|object $data data
* @param string $xmlRootNodeName
* @param \DOMNode $parentNode
* @param array|object $data
* @param string|null $xmlRootNodeName
*
* @return Boolean
*
* @throws UnexpectedValueException
*/
private function buildXml($parentNode, $data, $xmlRootNodeName = null)
private function buildXml(\DOMNode $parentNode, $data, $xmlRootNodeName = null)
{
$append = true;
@ -349,14 +341,14 @@ class XmlEncoder extends SerializerAwareEncoder implements EncoderInterface, Dec
/**
* 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 Boolean
*/
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) {
@ -386,12 +378,12 @@ class XmlEncoder extends SerializerAwareEncoder implements EncoderInterface, Dec
/**
* 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 Boolean
*/
private function selectNodeType($node, $val)
private function selectNodeType(\DOMNode $node, $val)
{
if (is_array($val)) {
return $this->buildXml($node, $val);