API Documentation
Back to top  

ODFQuery

This class centralizes the generation of XPath queries for templates

package

Docxpresso
subpackage

Templates

Methods

Construct

__construct()
access

public

creates the query to select all the content that falls within a given bookmark.

bookmarkQuery(array $options)

Warning: only elements at the same document depth are selected

access

public

Arguments

$options

array

return string

creates the query to find a generic element

elementQuery(array $options)
access

public

Arguments

$options

array

return string

creates the query to select the first parent with the requested tag

getParent(array $tags)
access

public

Arguments

$tags

array

return string

creates the query to select all the content that fall within a heading that contains the needle text at a specific heading level

headingQuery(array $options)
access

public

Arguments

$options

array

return string

creates a query to find an object/image node

objQuery(array $options, string $type = 'remove') : string
access

public

Arguments

$options

array

$type

string

it can be remove (default) or clone

Response

string

creates the query to find a paragraph that includes a set of variables

paragraphQuery(array $options, string $tag)
access

public

Arguments

$options

array

$tag

string

return string

creates the query to find all rows within a table that contain a set of variables

rowQuery(array $options)
access

public

Arguments

$options

array

return string

creates the query to find a table containing a set of variables

tableQuery(array $options)
access

public

Arguments

$options

array

return string

creates the query to find a textbox node

tboxQuery(array $options, string $type = 'remove') : string
access

public

Arguments

$options

array

$type

string

it can be remove (default) or clone

Response

string

creates the query to find a text node

textQuery(array $options) : string
access

public

Arguments

$options

array

Response

string