API Documentation
Back to top  

Form

This class creates a ODF form and its corersponding control elements

package

Docxpresso
subpackage

Forms

Methods

Construct

__construct(\Docxpresso\Core\Forms\DOMDocument $doc, array $options)
access

public

Arguments

$doc

\Docxpresso\Core\Forms\DOMDocument

$options

array

the avalaible key and values are: 'name' => (string) a unique name that identifies the form (required) 'target' => (string) that can be '_blank (default), _self or _top or a frame name 'action' => (string) points to the URL (if any) where the data of the form should be sent 'method' => (string) may be get or post

generates a button

addFormButton(array $options) : void
access

public

Arguments

$options

array

generates a checkbox

addFormCheckbox(array $options) : string
access

public

Arguments

$options

array

Response

string

generates a input field

addFormInputField(array $options) : void
access

public

Arguments

$options

array

generates a radio button

addFormRadioButton(array $options) : void
access

public

Arguments

$options

array

generates a listbox or dropdown list

addFormSelect(array $options) : void
access

public

Arguments

$options

array

generates a input texarea

addFormTextarea(array $options) : void
access

public

Arguments

$options

array

gets the form node

getFormNode() : \Docxpresso\Core\Forms\DOMNode
access

public

Response

\Docxpresso\Core\Forms\DOMNode

gets the name of the form

getName() : string
access

public

Response

string

Properties

form DOM document

_dom : \Docxpresso\Core\Forms\DOMDocument
var
access

private

Type(s)

\Docxpresso\Core\Forms\DOMDocument

form DOM node

_form : \Docxpresso\Core\Forms\DOMNode
var
access

private

Type(s)

\Docxpresso\Core\Forms\DOMNode

form name

_name : string
var
access

private

Type(s)

string

form XPath

_xpath : \Docxpresso\Core\Forms\DOMXPath
var
access

private

Type(s)

\Docxpresso\Core\Forms\DOMXPath