MLPHP

Frames No frames
Summary: Field | Method | Constr Detail: Field | Method | Constr
MLPHP\Extracts
MarkLogic/MLPHP/Extracts.php at line 25

Class Extracts

Extracts

public class Extracts

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

Author:
Mike Wooldridge
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.

Constructor Detail

MarkLogic/MLPHP/Extracts.php at line 35

__construct

public void __construct()

Create an Extracts object.

See Also:
http://docs.marklogic.com/search:search#opt-extract-metadata

Method Detail

MarkLogic/MLPHP/Extracts.php at line 45

addConstraints

public void addConstraints(array|string constraints)

Add constraint metadata.

Parameters:
constraints - An array of constraint names or a constraint name.
MarkLogic/MLPHP/Extracts.php at line 61

addQName

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

Add QName metadata.

Parameters:
element - An element name.
ns - An element namespace.
attribute - An attribute name.
attributeNs - An attribute namespace.
MarkLogic/MLPHP/Extracts.php at line 71

getExtractsAsElem

public void getExtractsAsElem(DOMDocument dom)

Get the metadata extracts as a DOMElement object.

Parameters:
dom - The DOMDocument object in which to create the element.

MLPHP

Frames No frames
Summary: Field | Method | Constr Detail: Field | Method | Constr