\phpWTLDescriptorField

Representation of a single logging format field.

Summary

Methods
Properties
Constants
__construct()
$name
$caption
$prefix
$suffix
$formatter
$validator
$datatype_raw
$datatype_formatted
$default
$meta
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$name

$name : string

Type

string — Field id.

$caption

$caption : string

Type

string — Field title/appearance.

$prefix

$prefix : string

Type

string — Field delimiter, start.

$suffix

$suffix : string

Type

string — Field delimiter, end.

$formatter

$formatter : string

Type

string — Format (conversion) specifications (e.g. for a timestamp).

$validator

$validator : string

Type

string — Regular expression to validate field contents.

$datatype_raw

$datatype_raw : string

Type

string — type for raw data to use with a database log writer for mapping/abstraction layer purposes. Defaults to "string" if not set

$datatype_formatted

$datatype_formatted : string

Type

string — type for formatted data to use with a database log writer for mapping/abstraction layer purposes. Defaults to "datatype_raw" if not set

$default

$default : string

Type

string — If the field should be omitted by default, set to "false".

$meta

$meta : string

Type

string — If the field should be considered a format meta field, set to "true".

Methods

__construct()

__construct(array  $param) 

Parameters

array $param

Associative array to provide all attributes.