getDocxPathQueryInfo
- addBibliography
- addBookmark
- addBreak
- addChart
- addCitation
- addComment
- addCrossReference
- addDateAndHour
- addEndnote
- addExternalFile
- addFootnote
- addFormElement
- addHeading
- addImage
- addLink
- addList
- addMathEquation
- addMergeField
- addOLE
- addOnlineVideo
- addPageNumber
- addShape
- addSimpleField
- addSource
- addStructuredDocumentTag
- addSVG
- addTab
- addTable
- addTableContents
- addTableFigures
- addText
- addTextBox
- addWordFragment
- addWordML
- embedHTML
- addBackgroundImage
- addFooter
- addFooterSection
- addHeader
- addHeaderSection
- addLineNumbering
- addMacroFromDoc
- addPageBorders
- addProperties
- addSection
- createDocx
- createDocxAndDownload
- createCharacterStyle
- createListStyle
- createParagraphStyle
- createTableStyle
- docxSettings
- embedFont
- importChartStyle
- importHeadersAndFooters
- importListStyle
- importStyles
- importStylesWordDefault
- modifyPageLayout
- parseStyles
- removeFooters
- removeHeaders
- setBackgroundColor
- setDecimalSymbol
- setDefaultFont
- setDocumentDefaultStyles
- setEncodeUTF8
- setLanguage
- setMarkAsFinal
- setRTL
- clearBlocks
- cloneBlock
- deleteBlock
- getTemplateVariables
- getTemplateVariablesType
- modifyInputFields
- modifyMergeFields
- processTemplate
- removeTemplateVariable
- removeTemplateVariableImage
- replaceBlock
- replaceListVariable
- replacePlaceholderImage
- replaceTableVariable
- replaceVariableByExternalFile
- replaceVariableByHtml
- replaceVariableByText
- replaceVariableByWordFragment
- replaceVariableByWordML
- setTemplateSymbol
- setTemplateBlockSymbol
- tickCheckboxes
getDocxPathQueryInfo
ADVANCED / PREMIUM
TRIAL
Gets information from a performed DOCXPath query.
Description
public getDocxPathQueryInfo (array $referenceNode)
Parameters
referenceNode
An array to get the refence node.
The possible keys and values of this array are:
key | Type | Description |
---|---|---|
type | string | * (all, default value), bookmark, break, chart, endnote (content reference), footnote (content reference), image, list, math, paragraph (also for lists and links), section, shape, table, table-row, table-cell, table-cell-paragraph, tracking-insert, tracking-delete, tracking-run-style, tracking-paragraph-style, tracking-table-style, tracking-table-grid, tracking-table-row. |
contains | string | Contains a text string. |
occurrence | int | Number of occurrence from 1. |
attributes | array | Contains a specific attribute key and value. |
parent | string | Main document body as default, allows to set any parent or a specific one. w:body (default), '/' (any parent) or any other specific parent (/w:tbl/, /w:tc/, /w:r/...). |
target | string | Target content: document (default), header, footer. |
reference | array | To be used with header and footer targets: positions (array) 1, 2... based on the sectPr contents order, sections (array) 1, 2..., types (array) first, even, default |
customQuery | string | Custom xpath query, overwrites any other reference. |
Return values
array
Exceptions
Method not available.
Code samples
Example #1
Example #2
Release notes
- phpdocx 15.5:
- math type.
- phpdocx 15.0:
- table-row, table-cell and table-cell-paragraph types.
- phpdocx 12.0:
- improved working with multiple sections that contain multiple headers and footers.
- phpdocx 9.5:
- header and footer targets.
- phpdocx 7.5:
- return the elements of the query.
- phpdocx 7.0:
- range of elements, iterate all elements not only the first one, siblings.
- phpdocx 6.0:
- new method.