XPath Property

Provides a way to point to a specific element in the response.

Object Oriented Interface

public function getXPath();
public function setXPath($value);

Procedural Interface

ipworks_json_get($res, 53 );
ipworks_json_set($res, 53, $value );

Default Value

Remarks

This property allows you to point to specific elements in the JSON documents. This will be the path to a specified value within the document. Since arrays in JSON only contain values, and no associated object name, an empty name will be used for these values. Thus, to reach an array element at position 1, the path must be set to "[1]". In addition, a root element named "json" will be added to each JSON document in the parser.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

The following are possible values for an element accessor:


'name'	A particular element name.
[i]	The i-th subelement of the current element.
..	the parent of the current element.

When XPath is set to a valid path, XElement points to the name of the element, with XParent, XChildren, and XText providing other properties of the element.

BuildDOM must be set to True prior to parsing the document for the XPath functionality to be available.

Simple JSON document

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

Example (Setting JSON XPath)


Document root	JsonControl.XPath = "/"
Specific Element	JsonControl.XPath = "/json/firstlevel/one/"
i-th Child	JsonControl.XPath = "/json/firstlevel/two/[i]/"

Data Type

String