API Documentation
Back to top  

Replace

This class is the responsible of replacing template variables

package

Docxpresso
subpackage

Templates

Methods

Construct

__construct(\Docxpresso\Templates\CreateDocument $doc, array $vars, array $options)
access

public

Arguments

$doc

\Docxpresso\Templates\CreateDocument

$vars

array

$options

array

parses image dimensions

_dimension(mixed $d) : integer
access

private

Arguments

$d

mixed

Response

integer

counts the maximun number of entries of each subarray

_maxCountVars(array $vars) : integer
access

private

Arguments

$vars

array

Response

integer

selects the adequate replacing method depending on options

_replace(array $vars, array $options) : void
access

private

Arguments

$vars

array

$options

array

replaces the data within a chart

_replaceChart(array $vars, array $options) : void
access

private

Arguments

$vars

array

$options

array

replaces the chart data in its corresponding content.xml

_replaceChartData(string $path, array $data) : void
access

private

Arguments

$path

string

$data

array

replace the image source

_replaceImageSrc(\Docxpresso\Templates\DOMNode $node, array $data) : void
access

private

Arguments

$node

\Docxpresso\Templates\DOMNode

$data

array

replaces paragraph type variables

_replaceParagraph(array $vars, array $options, string $tag) : void
access

private

Arguments

$vars

array

$options

array

$tag

string

replace a single variable

_replaceSingleVariable(array $var, mixed $value, array $options) : void
access

private

Arguments

$var

array

$value

mixed

$options

array

replaces table type variables

_replaceTable(array $vars, array $options) : void
access

private

Arguments

$vars

array

$options

array

replaces text type variables

_replaceText(array $vars, array $options) : void
access

private

Arguments

$vars

array

$options

array

replaces the value

_replaceValue(\Docxpresso\Templates\DOMNode $node, string $var, mixed $value, array $options) : void
access

private

Arguments

$node

\Docxpresso\Templates\DOMNode

$var

string

$value

mixed

$options

array

replaces the value by a document fragment

_replaceValueByDocFragment(\Docxpresso\Templates\DOMNode $node, string $var, \Docxpresso\Templates\DocumentFragment $value, array $options) : void
access

private

Arguments

$node

\Docxpresso\Templates\DOMNode

$var

string

$value

\Docxpresso\Templates\DocumentFragment

$options

array

replaces the value by a string

_replaceValueByString(\Docxpresso\Templates\DOMNode $node, string $var, string $value, array $options) : void
access

private

Arguments

$node

\Docxpresso\Templates\DOMNode

$var

string

$value

string

$options

array

Properties

The ODF element associated with the $_dom document element

_baseODF : \Docxpresso\Templates\ODFElement
var
access

private

Type(s)

\Docxpresso\Templates\ODFElement

The required CreateDocument object

_doc : \Docxpresso\Templates\CreateDocument
var
access

private

Type(s)

\Docxpresso\Templates\CreateDocument

The DOMDOcument we wish to manipulate

_dom : \Docxpresso\Templates\DOMDocument
var
access

private

Type(s)

\Docxpresso\Templates\DOMDocument

The required DOMXPath object

_docxpath : \Docxpresso\Templates\DOMXPath
var
access

private

Type(s)

\Docxpresso\Templates\DOMXPath

The manifest.xml DOMDocument

_manifest : \Docxpresso\Templates\DOMDocument
var
access

private

Type(s)

\Docxpresso\Templates\DOMDocument

List of nodes to be removed

_removeNodes : array
var
access

private

Type(s)

array

An instance of the ODFQuery required to build the queries

_ODFQuery : \Docxpresso\Templates\ODFQuery
var
access

private

Type(s)

\Docxpresso\Templates\ODFQuery