form

Documentation

Overview

Package form provides types for some common forms.

Index

• Variables
• func DecodeAddress(s string) *place.Address
• func PostFormString(r *http.Request, name string) string
• type AddressFieldNames
• type AddressForm
  • func NewAddressForm() *AddressForm
  • func ReadAddressForm(r *http.Request) *AddressForm
  • func (f *AddressForm) Validate(useYour bool) validation.List
• type LanguagePreferenceForm
  • func ReadLanguagePreferenceForm(r *http.Request, errorLabel string) *LanguagePreferenceForm
  • func (f *LanguagePreferenceForm) Validate() validation.List
• type SelectForm
  • func NewEmptySelectForm[T enumType, TOptions any, TP unmarshallable[T]](values TOptions, errorLabel string) *SelectForm[T, TOptions, TP]
  • func NewSelectForm[T enumType, TOptions any, TP unmarshallable[T]](selected T, values TOptions, errorLabel string) *SelectForm[T, TOptions, TP]
  • func (f *SelectForm[T, TOptions, TP]) Read(r *http.Request)
  • func (f *SelectForm[T, TOptions, TP]) Validate() validation.List
• type SharedFieldNames
• type YesNo
  • func ParseYesNo(s string) (YesNo, error)
  • func (i YesNo) IsNo() bool
  • func (i YesNo) IsUnknown() bool
  • func (i YesNo) IsYes() bool
  • func (i YesNo) MarshalText() ([]byte, error)
  • func (i YesNo) String() string
  • func (i *YesNo) UnmarshalText(text []byte) error
• type YesNoForm
  • func NewYesNoForm(yesNo YesNo) *YesNoForm
  • func ReadYesNoForm(r *http.Request, errorLabel string) *YesNoForm
  • func (f *YesNoForm) Validate() validation.List
• type YesNoOptions

Variables

var FieldNames = SharedFieldNames{
	LanguagePreference: "language-preference",
	Address: AddressFieldNames{
		Line1:      "address-line-1",
		Line2:      "address-line-2",
		Line3:      "address-line-3",
		TownOrCity: "address-town",
		Postcode:   "address-postcode",
		Action:     "action",
	},
	Select: "selected",
	YesNo:  "yes-no",
}

var YesNoValues = YesNoOptions{
	Unknown: YesNoUnknown,
	Yes:     Yes,
	No:      No,
}

Functions

func DecodeAddress

func DecodeAddress(s string) *place.Address

func PostFormString

func PostFormString(r *http.Request, name string) string

Types

type AddressFieldNames

type AddressFieldNames struct {
	Line1      string
	Line2      string
	Line3      string
	TownOrCity string
	Postcode   string
	Action     string
}

type AddressForm

type AddressForm struct {
	Action         string
	LookupPostcode string
	Address        *place.Address
	FieldNames     AddressFieldNames
}

func NewAddressForm

func NewAddressForm() *AddressForm

func ReadAddressForm

func ReadAddressForm(r *http.Request) *AddressForm

func (*AddressForm) Validate

func (f *AddressForm) Validate(useYour bool) validation.List

type LanguagePreferenceForm

type LanguagePreferenceForm struct {
	Preference localize.Lang
	ErrorLabel string
}

func ReadLanguagePreferenceForm

func ReadLanguagePreferenceForm(r *http.Request, errorLabel string) *LanguagePreferenceForm

func (*LanguagePreferenceForm) Validate

func (f *LanguagePreferenceForm) Validate() validation.List

type SelectForm

type SelectForm[T enumType, TOptions any, TP unmarshallable[T]] struct {
	Selected   T
	FieldName  string
	Options    TOptions
	ErrorLabel string
}

func NewEmptySelectForm

func NewEmptySelectForm[T enumType, TOptions any, TP unmarshallable[T]](
	values TOptions,
	errorLabel string,
) *SelectForm[T, TOptions, TP]

func NewSelectForm

func NewSelectForm[T enumType, TOptions any, TP unmarshallable[T]](
	selected T,
	values TOptions,
	errorLabel string,
) *SelectForm[T, TOptions, TP]

func (*SelectForm[T, TOptions, TP]) Read

func (f *SelectForm[T, TOptions, TP]) Read(r *http.Request)

func (*SelectForm[T, TOptions, TP]) Validate

func (f *SelectForm[T, TOptions, TP]) Validate() validation.List

type SharedFieldNames

type SharedFieldNames struct {
	Address            AddressFieldNames
	LanguagePreference string
	Select             string
	YesNo              string
}

type YesNo

type YesNo uint8

const (
	YesNoUnknown YesNo = iota
	Yes                // yes
	No                 // no
)

func ParseYesNo

func ParseYesNo(s string) (YesNo, error)

func (YesNo) IsNo

func (i YesNo) IsNo() bool

func (YesNo) IsUnknown

func (i YesNo) IsUnknown() bool

func (YesNo) IsYes

func (i YesNo) IsYes() bool

func (YesNo) MarshalText

func (i YesNo) MarshalText() ([]byte, error)

func (YesNo) String

func (i YesNo) String() string

func (*YesNo) UnmarshalText

func (i *YesNo) UnmarshalText(text []byte) error

type YesNoForm

type YesNoForm struct {
	YesNo      YesNo
	Error      error
	ErrorLabel string
	Options    YesNoOptions
	FieldName  string
}

func NewYesNoForm

func NewYesNoForm(yesNo YesNo) *YesNoForm

func ReadYesNoForm

func ReadYesNoForm(r *http.Request, errorLabel string) *YesNoForm

func (*YesNoForm) Validate

func (f *YesNoForm) Validate() validation.List

type YesNoOptions

type YesNoOptions struct {
	Unknown YesNo
	Yes     YesNo
	No      YesNo
}