tasks/ext/pdo/PDOSQLExecFormatterElement.php
inherited
Classes
\PDOSQLExecFormatterElement
A class to represent the nested <formatter> element for PDO SQL results.
This class is inspired by the similarly-named class in the PHPUnit tasks.
- Author
- Hans Lellelid
- Since
- 2.3.0
Properties
boolean
$append= 'false'
Append to an existing file or overwrite it?
falseDetails- Type
- boolean
string
$coldelimiter= '","'
Column delimiter.
Defaults to ','
","Details- Type
- string
string
$encoding= ''
Encoding for XML output.
- Type
- string
boolean
$formatoutput= 'true'
Whether to format XML output.
trueDetails- Type
- boolean
array
$formatterParams= 'array()'
Parameters for a custom formatter.
Parameter[]array()Details- Type
- array
string
$rowdelimiter= 'PHP_EOL'
Row delimiter.
Defaults to PHP_EOL.
PHP_EOLDetails- Type
- string
boolean
$showheaders= 'true'
Print header columns.
trueDetails- Type
- boolean
string
$type= '""'
The type of the formatter (used for built-in formatter classes).
""Details- Type
- string
boolean
$useFile= 'true'
Whether to use file (or write output to phing log).
trueDetails- Type
- boolean
Methods
__construct(
\PDOSQLExecTask $parentTask
)
:
voidConstruct a new PDOSQLExecFormatterElement with parent task.
| Name | Type | Description |
|---|---|---|
| $parentTask | \PDOSQLExecTask |
createParam(
)
:
\ParameterSupports nested element (for custom formatter classes).
| Type | Description |
|---|---|
| \Parameter |
getAppend(
)
:
booleanWhether output should be appended to file.
| Type | Description |
|---|---|
| boolean |
getDefaultOutput(
)
:
\WriterGets a default output writer for this task.
| Type | Description |
|---|---|
| \Writer |
getFormatter(
)
:
\PDOResultFormatterGets the formatter that has been configured based on this element.
| Type | Description |
|---|---|
| \PDOResultFormatter |
getUseFile(
)
:
booleanReturn whether to write formatter results to file.
| Type | Description |
|---|---|
| boolean |
prepare(
)
:
voidConfigures wrapped formatter class with any attributes on this element.
setAppend(
boolean $append
)
:
voidwhether output should be appended to or overwrite an existing file. Defaults to false.
| Name | Type | Description |
|---|---|---|
| $append | boolean |
setClassName(
string $className
)
:
voidSet classname for a custom formatter (must extend PDOResultFormatter).
| Name | Type | Description |
|---|---|---|
| $className | string |
setColdelim(
string $v
)
:
voidSets the column delimiter.
| Name | Type | Description |
|---|---|---|
| $v | string |
setEncoding(
string $v
)
:
voidSet the DOM document encoding.
| Name | Type | Description |
|---|---|---|
| $v | string |
setFormatOutput(
boolean $v
)
:
void| Name | Type | Description |
|---|---|---|
| $v | boolean |
setOutfile(
$outfile
)
:
voidSets the output file for the formatter results.
| Name | Type | Description |
|---|---|---|
| $outfile |
setRowdelim(
string $v
)
:
voidSets the row delimiter.
| Name | Type | Description |
|---|---|---|
| $v | string |
setShowheaders(
boolean $showheaders
)
:
voidPrint headers for result sets from the statements; optional, default true.
| Name | Type | Description |
|---|---|---|
| $showheaders | boolean |
setType(
string $type
)
:
voidSets the formatter type.
| Name | Type | Description |
|---|---|---|
| $type | string |
setUseFile(
boolean $useFile
)
:
voidSet whether to write formatter results to file.
| Name | Type | Description |
|---|---|---|
| $useFile | boolean |