Docs4dev
Docs
cakephp / 3.8 / class-cake.form.schema.html

Class Schema

Contains the schema information for Form instances.

Namespace: Cake\Form
Location: Form/Schema.php

Properties summary

  • $_fieldDefaults protected
    array
    The default values for fields.
  • $_fields protected
    array
    The fields in this schema.

Method Summary

  • 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.
  • Removes a field to the schema.

Method Detail

__debugInfo()source public

__debugInfo( )

Get the printable version of this object

Returns

array

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|array
The 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|null

Either the field type or null if the field does not exist.


fields()source public

fields( )

Get the list of fields in the schema.

Returns

string[]
The 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,
    'default' => null,
]

$_fieldssource

protected array

The fields in this schema.

[]

© 2005–present 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.
https://api.cakephp.org/3.8/class-Cake.Form.Schema.html