class ServicesParserXML in Services 7.3

Hierarchy

• class \ServicesParserXML implements ServicesParserInterface

2 string references to 'ServicesParserXML'

rest_server_request_parsers in servers/rest_server/rest_server.module

Builds a list of request parsers that are available to the RESTServer.

ServicesRESTServerTests::testParseRequestBody in servers/rest_server/tests/ServicesRESTServerTests.test

Test for parseRequestBody() method.

File

servers/rest_server/includes/ServicesParser.inc, line 20

class ServicesParserXML implements ServicesParserInterface {
  public function parse(ServicesContextInterface $context) {

    // get/hold the old error state
    $old_error_state = libxml_use_internal_errors(1);

    // clear all libxml errors
    libxml_clear_errors();

    // get a now SimpleXmlElement object from the XML string
    $xml_data = simplexml_load_string($context
      ->getRequestBody());

    // if $xml_data is Null then we expect errors
    if (!$xml_data) {

      // build an error message string
      $message = '';
      $errors = libxml_get_errors();
      foreach ($errors as $error) {
        $message .= t('Line @line, Col @column: @message', array(
          '@line' => $error->line,
          '@column' => $error->column,
          '@message' => $error->message,
        )) . "\n\n";
      }

      // clear all libxml errors and restore the old error state
      libxml_clear_errors();
      libxml_use_internal_errors($old_error_state);

      // throw an error
      services_error($message, 406);
    }

    // whew, no errors, restore the old error state
    libxml_use_internal_errors($old_error_state);

    // unmarshal the SimpleXmlElement, and return the resulting array
    $php_array = $this
      ->unmarshalXML($xml_data, NULL);
    return (array) $php_array;
  }

  /**
   * A recusive function that unmarshals an XML string, into a php array.
   */
  protected function unmarshalXML($node, $array) {

    // For all child XML elements
    foreach ($node
      ->children() as $child) {
      if (count($child
        ->children()) > 0) {

        // if the child has children
        $att = 'is_array';
        if ($child
          ->attributes()->{$att}) {
          $new_array = array();

          // recursive through <item>
          foreach ($child
            ->children() as $item) {

            // Make sure that elements with no children gets a value assigned.
            $item_keys = array_keys((array) $item);
            if (count($item_keys) == 1 && current($item_keys) === 0) {
              $new_array[] = (string) $item[0];
            }
            elseif (is_object($item) && $item
              ->count() == 0) {
              $new_array[] = (string) $item;
            }
            else {
              $new_array[] = self::unmarshalXML($item, $array[$item
                ->getName()]);
            }
          }
        }
        else {

          // else, simply create an array where the key is name of the element
          $array[$child
            ->getName()] = array();
          $new_array = $this
            ->unmarshalXML($child, $array[$child
            ->getName()]);
        }

        // add $new_array to $array
        $array[$child
          ->getName()] = $new_array;
      }
      else {

        // Use the is_raw attribute on value elements for select type fields to
        // pass form validation. Example:
        // <field_terms_select>
        //    <und is_array="true">
        //      <item>
        //        <tid is_raw="true">10513</tid>
        //      </item>
        //      <item>
        //        <tid is_raw="true">10523</tid>
        //      </item>
        //    </und>
        //  </field_terms_select>
        if ($child
          ->attributes()->is_raw) {
          return (string) $child;
        }
        $array[$child
          ->getName()] = (string) $child;
      }
    }

    // return the resulting array
    return $array;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ServicesParserXML::parse	public	function	Overrides ServicesParserInterface::parse
ServicesParserXML::unmarshalXML	protected	function	A recusive function that unmarshals an XML string, into a php array.