Class Schema
Contains the schema information for Form instances.
Properties summary
-
$_fieldDefaultsprotectedarrayThe default values for fields. -
$_fieldsprotectedarrayThe fields in this schema.
Method Summary
-
__debugInfo() public
Get the printable version of this object -
addField() public
Adds a field to the schema. -
addFields() public
Add multiple fields to the schema. -
field() public
Get the attributes for a given field. -
fieldType() public
Get the type of the named field. -
fields() public
Get the list of fields in the schema. -
removeField() public
Removes a field to the schema.
Method Detail
addField() public ¶
addField( string $name , string|array $attrs )
Adds a field to the schema.
Parameters
- string $name
- The field name.
- string|array $attrs
The attributes for the field, or the type as a string.
Returns
$this
addFields() public ¶
addFields( array $fields )
Add multiple fields to the schema.
Parameters
- array $fields
- The fields to add.
Returns
$this
field() public ¶
field( string $name )
Get the attributes for a given field.
Parameters
- string $name
- The field name.
Returns
array|null
The attributes for a field, or null.
The attributes for a field, or null.
fieldType() public ¶
fieldType( string $name )
Get the type of the named field.
Parameters
- string $name
- The name of the field.
Returns
string|null
Either the field type or null if the field does not exist.
fields() public ¶
fields( )
Get the list of fields in the schema.
Returns
string[]
The list of field names.
The list of field names.
removeField() public ¶
removeField( string $name )
Removes a field to the schema.
Parameters
- string $name
- The field to remove.
Returns
$this
Properties detail
$_fieldDefaults ¶
protected
array
The default values for fields.
[
'type' => null,
'length' => null,
'precision' => null,
'default' => null,
]