1
0
mirror of https://github.com/guzzle/guzzle.git synced 2025-02-25 10:33:18 +01:00

Fixing docblock for XmlVisitor

This commit is contained in:
Michael Dowling 2013-06-30 17:40:34 -07:00
parent 1a926cca69
commit 19c72f2761

View File

@ -111,9 +111,9 @@ class XmlVisitor extends AbstractRequestVisitor
/**
* Recursively build the XML body
*
* @param \XMLWriter $xml XML to modify
* @param Parameter $param API Parameter
* @param mixed $value Value to add
* @param \XMLWriter $xmlWriter XML to modify
* @param Parameter $param API Parameter
* @param mixed $value Value to add
*/
protected function addXml(\XMLWriter $xmlWriter, Parameter $param, $value)
{
@ -153,14 +153,14 @@ class XmlVisitor extends AbstractRequestVisitor
/**
* Write an attribute with namespace if used
*
* @param \XMLWriter $xmlWriter [description]
* @param string $prefix Namespace prefix if any
* @param string $name Attribute name
* @param string $namespace The uri of the namespace
* @param string $value The attribute content
*
* @param \XMLWriter $xmlWriter XMLWriter instance
* @param string $prefix Namespace prefix if any
* @param string $name Attribute name
* @param string $namespace The uri of the namespace
* @param string $value The attribute content
*/
protected function writeAttribute($xmlWriter, $prefix, $name, $namespace, $value)
protected function writeAttribute($xmlWriter, $prefix, $name, $namespace, $value)
{
if (empty($namespace)) {
$xmlWriter->writeAttribute($name, $value);
@ -171,12 +171,12 @@ class XmlVisitor extends AbstractRequestVisitor
/**
* Write an element with namespace if used
*
* @param \XMLWriter $xmlWriter XML writer respource
* @param string $prefix Namespace prefix if any
* @param string $name Element name
* @param string $namespace The uri of the namespace
* @param string $value The element content
*
* @param \XMLWriter $xmlWriter XML writer resource
* @param string $prefix Namespace prefix if any
* @param string $name Element name
* @param string $namespace The uri of the namespace
* @param string $value The element content
*/
protected function writeElement(\XMLWriter $xmlWriter, $prefix, $name, $namespace, $value)
{
@ -191,9 +191,9 @@ class XmlVisitor extends AbstractRequestVisitor
/**
* Create a new xml writier and start a document
*
*
* @param string $encoding document encoding
*
*
* @return \XMLWriter the writer resource
*/
protected function startDocument($encoding)
@ -201,17 +201,21 @@ class XmlVisitor extends AbstractRequestVisitor
$this->writer = new \XMLWriter();
$this->writer->openMemory();
$this->writer->startDocument('1.0', $encoding);
return $this->writer;
}
/**
* End the document and return the output
*
*
* @param \XMLWriter $xmlWriter
*
* @return \string the writer resource
*/
protected function finishDocument($xmlWriter)
{
$xmlWriter->endDocument();
return $xmlWriter->outputMemory();
}