Overview

Namespaces

  • Charcoal
    • Ui
      • Dashboard
      • Form
      • FormGroup
      • FormInput
      • Layout
      • Menu
      • MenuItem
      • ServiceProvider

Classes

  • AbstractForm
  • FormBuilder
  • FormConfig
  • GenericForm

Interfaces

  • FormInterface

Traits

  • FormTrait
  • Overview
  • Namespace
  • Class

Interface FormInterface

Defines a form.

Direct known implementers

Charcoal\Ui\Form\AbstractForm

Indirect known implementers

Charcoal\Ui\Form\GenericForm
Namespace: Charcoal\Ui\Form
Located at Charcoal/Ui/Form/FormInterface.php
Methods summary
public Charcoal\Ui\Form\FormInterface
# setAction( string $action )

Parameters

$action
The form action, typically a URL.

Returns

Charcoal\Ui\Form\FormInterface
Chainable
public string
# action( )

Returns

string
public Charcoal\Ui\Form\FormInterface
# setMethod( string $method )

Parameters

$method
Either "post" or "get".

Returns

Charcoal\Ui\Form\FormInterface
Chainable
public string
# method( )

Returns

string
Either "post" or "get"
public FormGroupInterface
# setL10nMode( string $mode )

Parameters

$mode
The l10n mode.

Returns

FormGroupInterface
Chainable
public string
# l10nMode( )

Returns

string
public Charcoal\Ui\Form\FormInterface
# setFormData( array $data )

Parameters

$data
The (pre-populated) form data.

Returns

Charcoal\Ui\Form\FormInterface
Chainable
public Charcoal\Ui\Form\FormInterface
# addFormData( string $key, mixed $val )

Parameters

$key
The form data key, or property identifier.
$val
The form data value, for a given key.

Returns

Charcoal\Ui\Form\FormInterface
Chainable
public array
# formData( )

Returns

array
API documentation generated by ApiGen