Skip to main content

GravityKit\GravityView\Form\Form

The Form class.

Houses all base Form functionality and provides a uniform API to various form backends via Form implementations.

Since:

  • 2.0
  • 3.0.0 (Migrated to GravityKit\GravityView\Form namespace.)

Source: src/Form/Form.php:23

Details

  • Kind: class
  • Namespace: GravityKit\GravityView\Form
  • Extends: GV\Source

Properties

PropertyTypeDescription
$IDintThe ID for this form.

Methods

MethodDescription
by_id()Construct a \GV\Form instance by ID.
get_entries()Get all entries for this form.
__get()Magic shortcuts.

Method Reference

by_id()

public static function by_id( $form_id )

Construct a \GV\Form instance by ID.

Parameters

NameTypeDefaultDescription
$form_idint | stringThe internal form ID.

Returns

  • \GV\Form | null — An instance of this form or null if not found.

Since: 2.0

Source: src/Form/Form.php:46

get_entries()

abstract public function get_entries()

Get all entries for this form.

Returns

  • \GV\Entry_Collection — The \GV\Entry_Collection

Since: 2.0

Source: src/Form/Form.php:58

__get()

public function __get( $key )

Magic shortcuts.

  • entries -> $this->get_entries()

Parameters

NameTypeDefaultDescription
$key

Source: src/Form/Form.php:65