CiviCRM Community Forums (archive)

At the moment we have a problem in the REST.php for XML, because it only caters for 2 levels in result arrays. The formatting of the XML in the REST is now done with the function CRM_Utils_Array::xml. This formats text in a string like this:
    static function &xml( &$list, $depth = 1, $seperator = "\n" ) {
        $xml = '';
        foreach( $list as $name => $value ) {
            $xml .= str_repeat( ' ', $depth * 4 );
            if ( is_array( $value ) ) {
                $xml .= "<{$name}>{$seperator}";
                $xml .= self::xml( $value, $depth + 1, $seperator );
                $xml .= str_repeat( ' ', $depth * 4 );
                $xml .= "</{$name}>{$seperator}";
            } else {
                // make sure we escape value
                $value = self::escapeXML( $value );
                $xml .= "<{$name}>$value</{$name}>{$seperator}";
            }
        }
        return $xml;
    }

In the REST I want to change this and use the PHP XMLWriter to do the XML formatting, so it will become something like:
        $xml = new XMLWriter();
        $xml->openURI('php://output');
        $xml->startDocument('1.0');
        $xml->setIndent(2);
        $xml->startElement("Resultset");
        $xml->writeAttribute("is_error", 0);
        $xml->writeAttribute("count", 1);
        $xml->startElement("Values");
        $xml->writeElement("id", 1);
        $xml->writeElement("last_name", "Hommel");
        $xml->writeElement("first_name", "Erik");
        $xml->endElement();
        $xml->endElement();
        $xml->endDocument();
        $xml->flush();
        return $xml;
The result of this will be:
− <Resultset is_error="0" count="1">
− <Values>
<id>1</id>
<last_name>Hommel</last_name>
<first_name>Erik</first_name>
</Values>
</Resultset>

I have no in depth knowledge of XML or the REST, but it seems to make sense to use the XMLWriter functionality so we have proper formatted XML? Any other opinions or suggestions? Should we use the same formatting for the CRM_Utils_Array::xml function?

Erik

I think it still will, I was just putting down the general concept. I will come back with an actual example once I have got a working version
Erik

I am not sure I get that.....and positive I do not get it 

Just did a check, but the function CRM_Utils_Array::xml is only used in the REST.php. That being the case, I suggest we remove the function from the CRM_Util_Array and create a new function in the api/v3/utils. Agree or object anyone?
Erik

The only reason I had in mind is because it is not used anywhere else. Do not have a problem with the function being in the CRM/*. Do you agree we should then change the function to use XMLWriter?

I think that nested should remain the default for php calls & for REST sequential should be set as the default.

But if they have their API verson set to v2 then the default should be unchanged for REST

civicrm_create_success is better- this is the same topic as Xavier's other post - but I haven't looked at the code to see how easily it would fit

Beware that some apis already provide a flattened array (eg. civicrm_tag_get)

X+