API Documentation
Back to top  

Cloner

This class is the responsible of cloning template content

package

Docxpresso
subpackage

Templates

Methods

Construct

__construct(array $options)
access

public

Arguments

$options

array

selects the adequate cloning method depending on options

_clone(array $options) : void
access

private

Arguments

$options

array

clones a generic document element

_cloneElement(array $options) : void
access

private

Arguments

$options

array

clones a document chapter

_cloneGroup(string $type, array $options) : void
access

private

Arguments

$type

string

$options

array

removes an object/image node

_cloneObject(array $options, integer $iteration = 1) : void
access

private

Arguments

$options

array

$iteration

integer

clones an element

_cloneSingleNode(\Docxpresso\Templates\DOMNode $node, string $position = 'after', integer $repeat = 1) : void
access

private

Arguments

$node

\Docxpresso\Templates\DOMNode

$position

string

$repeat

integer

clones a textbox node

_cloneTextbox(array $options, integer $iteration = 1) : void
access

private

Arguments

$options

array

$iteration

integer

copy and rename an image file

_copyImg(string $src, string $newSrc) : void
access

private

Arguments

$src

string

$newSrc

string

copy and rename all the files associated with an object

_copyObj(string $src, string $newSrc) : void
access

private

Arguments

$src

string

$newSrc

string

replicates content

_replicateNodeContent(\Docxpresso\Templates\DOMNode $node, \Docxpresso\Templates\DOMNode $cloned, \Docxpresso\Templates\DOMNodeList $images, \Docxpresso\Templates\DOMNodeList $objects) : void
access

private

Arguments

$node

\Docxpresso\Templates\DOMNode

$cloned

\Docxpresso\Templates\DOMNode

$images

\Docxpresso\Templates\DOMNodeList

$objects

\Docxpresso\Templates\DOMNodeList

Properties

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

An instance of the ODFQuery required to build the queries

_ODFQuery : \Docxpresso\Templates\ODFQuery
var
access

private

Type(s)

\Docxpresso\Templates\ODFQuery

The template data

_template : array
var
access

private

Type(s)

array