Class Extracts

Extracts

public class Extracts

Represents a set of metadata extracts in a search options node.

Author:: Mike Wooldridge
Todo:: Replace deprecated extract-metadata functionality with extract-document-data
See Also:: http://docs.marklogic.com/guide/rest-dev/appendixb#id_94425

Constructor Summary
void	__construct() Create an Extracts object.

Method Summary
void	addConstraints(array\|string constraints) Add constraint metadata.
void	addQName(string element, string ns, string attribute, string attributeNs) Add QName metadata.
void	getExtractsAsElem(DOMDocument dom) Get the metadata extracts as a DOMElement object.

Method Summary

void

addConstraints(array|string constraints)

Add constraint metadata.

void

addQName(string element, string ns, string attribute, string attributeNs)

Add QName metadata.

void

Get the metadata extracts as a DOMElement object.

Constructor Detail

public void __construct()

Create an Extracts object.

public void addConstraints(array|string constraints)

Add constraint metadata.

Parameters:: constraints - An array of constraint names or a constraint name.

public void addQName(string element, string ns, string attribute, string attributeNs)

Add QName metadata.

Todo:: Defining extract as QName not working
See Also:: https://github.com/marklogic/mlphp/issues/6
Parameters:: element - An element name.; ns - An element namespace.; attribute - An attribute name.; attributeNs - An attribute namespace.

public void getExtractsAsElem(DOMDocument dom)

Get the metadata extracts as a DOMElement object.