Schema (class)
Class Schema
Contains the schema information for Form instances.
Properties summary
-
$_fieldDefaults
protectedThe default values for fields.array
-
$_fields
protectedThe fields in this schema.array
Method Summary
- __debugInfo() publicGet the printable version of this object
- addField() publicAdds a field to the schema.
- addFields() publicAdd multiple fields to the schema.
- field() publicGet the attributes for a given field.
- fieldType() publicGet the type of the named field.
- fields() publicGet the list of fields in the schema.
- removeField() publicRemoves a field to the schema.
Method Detail
addField()source 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()source public
addFields( array $fields )
Add multiple fields to the schema.
Parameters
- array
$fields
- The fields to add.
Returns
$this
field()source public
field( string $name )
Get the attributes for a given field.
Parameters
- string
$name
- The field name.
Returns
null|arrayThe attributes for a field, or null.
fieldType()source public
fieldType( string $name )
Get the type of the named field.
Parameters
- string
$name
- The name of the field.
Returns
string|nullEither the field type or null if the field does not exist.
fields()source public
fields( )
Get the list of fields in the schema.
Returns
arrayThe list of field names.
removeField()source public
removeField( string $name )
Removes a field to the schema.
Parameters
- string
$name
- The field to remove.
Returns
$this
Properties detail
$_fieldDefaultssource
protected array
The default values for fields.
[ 'type' => null, 'length' => null, 'precision' => null, ]
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/3.2/class-Cake.Form.Schema.html