Overview

Packages

  • blesta
    • app
      • controllers
      • models
    • components
      • auth
        • ldap
        • motp
        • oath
      • delivery
        • interfax
        • postal
          • methods
      • download
      • email
      • events
      • exchange
        • rates
          • currency
            • layer
          • fixer
          • open
            • exchange
              • rates
          • x
            • rates
      • gateway
        • payments
      • gateways
      • invoice
        • delivery
        • templates
          • perforated
            • invoice
          • quickbooks
            • invoice
          • templates
            • default
      • modules
      • net
        • amazon
          • s3
        • http
        • net
          • geo
            • ip
      • plugins
      • reports
        • aging
          • invoices
        • client
          • data
            • portability
        • custom
          • report
        • invoice
          • creation
        • package
          • revenue
        • tax
          • liability
        • transactions
          • applied
          • received
      • security
      • session
        • cart
      • settingscollection
      • upgrades
        • tasks
      • upload
      • vcard
    • core
      • Automation
        • Tasks
          • Common
          • Task
        • Type
          • Common
          • Cron
      • Pricing
        • ItemComparator
        • MetaItem
        • Modifier
          • Type
            • Description
              • Type
                • Discount
                • Option
                • Service
                • Tax
            • Discount
            • Price
            • Proration
        • Presenter
          • Build
            • Invoice
            • InvoiceData
            • Options
            • Service
            • ServiceChange
            • ServiceData
          • Collection
          • Format
            • Fields
            • Type
              • Discount
              • Item
              • Option
              • Options
              • Package
              • Pricing
              • Service
              • Tax
          • Items
            • Invoice
            • Service
          • Type
      • ServiceProviders
      • Util
        • Captcha
          • Captchas
          • Common
        • Common
          • Traits
        • Events
          • Common
          • Handlers
          • Observers
        • Filters
          • Common
        • GeoIp
        • Input
          • Fields
            • Common
        • Tax
        • Widgets
    • helpers
      • currency
        • format
      • data
        • structure
          • array
          • string
      • text
        • parser
      • widget
        • client
  • minPHP
    • helpers
      • color
      • data
        • structure
  • None
  • PHP

Classes

  • AbstractField

Interfaces

  • FieldInterface
  • FieldsInterface
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated

Interface FieldsInterface

Fields Interface

Provides the structure for inputs to set which fields to appear when interacting with the input via Blesta in various places.

Direct known implementers

Blesta\Core\Util\Input\Fields\InputFields

Indirect known implementers

ModuleFields
Namespace: Blesta\Core\Util\Input\Fields\Common
Package: blesta\core\Util\Input\Fields\Common
Copyright: Copyright (c) 2020, Phillips Data, Inc.
License: The Blesta License Agreement
See: Blesta\Core\Util\Input\Fields\Common\FieldInterface
Link: Blesta
Located at core/Util/Input/Fields/Common/FieldsInterface.php
Methods summary
public Blesta\Core\Util\Input\Fields\Common\FieldInterface
# label( string $name, string $for = null, array $attributes = null, boolean $preserve_tags = false )

Creates a label with the given name and marks it for the given field

Creates a label with the given name and marks it for the given field

Parameters

$name
The name of this label
$for
The ID of the form element this label is part of
$attributes
Attributes for this label
$preserve_tags
True to preserve tags in the label name

Returns

Blesta\Core\Util\Input\Fields\Common\FieldInterface

A FieldInterface object to be passed into one of the various field methods to assign this label to that field

public Blesta\Core\Util\Input\Fields\Common\FieldInterface
# tooltip( string $message )

Creates a tooltip with the given message

Creates a tooltip with the given message

Parameters

$message
The tooltip message

Returns

Blesta\Core\Util\Input\Fields\Common\FieldInterface
A FieldInterface object that can be attached to a FieldInterface label
public Blesta\Core\Util\Input\Fields\Common\FieldInterface
# fieldText( string $name, string $value = null, array $attributes = [], Blesta\Core\Util\Input\Fields\Common\FieldInterface $label = null )

Creates a text input field

Creates a text input field

Parameters

$name
The name to set in the HTML name field
$value
The value to set in the HTML value field
$attributes
Attributes for this input field
$label

A FieldInterface object representing the label to attach to this field (see FieldsInterface::label)

Returns

Blesta\Core\Util\Input\Fields\Common\FieldInterface
A FieldInterface object that can be attached to a FieldInterface label

See

Blesta\Core\Util\Input\Fields\Common\FieldsInterface::label()
Blesta\Core\Util\Input\Fields\Common\FieldInterface::attach()
public Blesta\Core\Util\Input\Fields\Common\FieldInterface
# fieldHidden( string $name, string $value = null, array $attributes = [] )

Creates a hidden input field

Creates a hidden input field

Parameters

$name
The name to set in the HTML name field
$value
The value to set in the HTML value field
$attributes
Attributes for this input field

Returns

Blesta\Core\Util\Input\Fields\Common\FieldInterface
A FieldInterface object that can be attached to a FieldInterface label

See

Blesta\Core\Util\Input\Fields\Common\FieldsInterface::label()
Blesta\Core\Util\Input\Fields\Common\FieldInterface::attach()
public Blesta\Core\Util\Input\Fields\Common\FieldInterface
# fieldImage( string $name, string $value = null, array $attributes = [], Blesta\Core\Util\Input\Fields\Common\FieldInterface $label = null )

Creates an image input field

Creates an image input field

Parameters

$name
The name to set in the HTML name field
$value
The value to set in the HTML value field
$attributes
Attributes for this input field
$label

A FieldInterface object representing the label to attach to this field (see FieldsInterface::label)

Returns

Blesta\Core\Util\Input\Fields\Common\FieldInterface
A FieldInterface object that can be attached to a FieldInterface label

See

Blesta\Core\Util\Input\Fields\Common\FieldsInterface::label()
Blesta\Core\Util\Input\Fields\Common\FieldInterface::attach()
public Blesta\Core\Util\Input\Fields\Common\FieldInterface
# fieldReset( string $name, string $value = null, array $attributes = [], Blesta\Core\Util\Input\Fields\Common\FieldInterface $label = null )

Creates a reset input field

Creates a reset input field

Parameters

$name
The name to set in the HTML name field
$value
The value to set in the HTML value field
$attributes
Attributes for this input field
$label

A FieldInterface object representing the label to attach to this field (see FieldsInterface::label)

Returns

Blesta\Core\Util\Input\Fields\Common\FieldInterface
A FieldInterface object that can be attached to a FieldInterface label

See

Blesta\Core\Util\Input\Fields\Common\FieldsInterface::label()
Blesta\Core\Util\Input\Fields\Common\FieldInterface::attach()
public Blesta\Core\Util\Input\Fields\Common\FieldInterface
# fieldCheckbox( string $name, string $value = null, boolean $checked = false, array $attributes = [], Blesta\Core\Util\Input\Fields\Common\FieldInterface $label = null )

Creates a checkbox

Creates a checkbox

Parameters

$name
The name to set in the HTML name field
$value
The value to set in the HTML value field
$checked
True to set this field as checked
$attributes
Attributes for this input field
$label

A FieldInterface object representing the label to attach to this field (see FieldsInterface::label)

Returns

Blesta\Core\Util\Input\Fields\Common\FieldInterface
A FieldInterface object that can be attached to a FieldInterface label

See

Blesta\Core\Util\Input\Fields\Common\FieldsInterface::label()
Blesta\Core\Util\Input\Fields\Common\FieldInterface::attach()
public Blesta\Core\Util\Input\Fields\Common\FieldInterface
# fieldRadio( string $name, string $value = null, boolean $checked = false, array $attributes = [], Blesta\Core\Util\Input\Fields\Common\FieldInterface $label = null )

Creates a radio box

Creates a radio box

Parameters

$name
The name to set in the HTML name field
$value
The value to set in the HTML value field
$checked
True to set this field as checked
$attributes
Attributes for this input field
$label

A FieldInterface object representing the label to attach to this field (see FieldsInterface::label)

Returns

Blesta\Core\Util\Input\Fields\Common\FieldInterface
A FieldInterface object that can be attached to a FieldInterface label

See

Blesta\Core\Util\Input\Fields\Common\FieldsInterface::label()
Blesta\Core\Util\Input\Fields\Common\FieldInterface::attach()
public Blesta\Core\Util\Input\Fields\Common\FieldInterface
# fieldTextarea( string $name, string $value = null, array $attributes = [], Blesta\Core\Util\Input\Fields\Common\FieldInterface $label = null )

Creates a textarea field

Creates a textarea field

Parameters

$name
The name to set in the HTML name field
$value
The value to set in this textarea
$attributes
Attributes for this input field
$label

A FieldInterface object representing the label to attach to this field (see FieldsInterface::label)

Returns

Blesta\Core\Util\Input\Fields\Common\FieldInterface
A FieldInterface object that can be attached to a FieldInterface label

See

Blesta\Core\Util\Input\Fields\Common\FieldsInterface::label()
Blesta\Core\Util\Input\Fields\Common\FieldInterface::attach()
public Blesta\Core\Util\Input\Fields\Common\FieldInterface
# fieldPassword( string $name, array $attributes = [], Blesta\Core\Util\Input\Fields\Common\FieldInterface $label = null )

Creates a password input field

Creates a password input field

Parameters

$name
The name to set in the HTML name field
$attributes
Attributes for this input field
$label

A FieldInterface object representing the label to attach to this field (see FieldsInterface::label)

Returns

Blesta\Core\Util\Input\Fields\Common\FieldInterface
A FieldInterface object that can be attached to a FieldInterface label

See

Blesta\Core\Util\Input\Fields\Common\FieldsInterface::label()
Blesta\Core\Util\Input\Fields\Common\FieldInterface::attach()
public Blesta\Core\Util\Input\Fields\Common\FieldInterface
# fieldFile( string $name, array $attributes = [], Blesta\Core\Util\Input\Fields\Common\FieldInterface $label = null )

Creates a file input field

Creates a file input field

Parameters

$name
The name to set in the HTML name field
$attributes
Attributes for this input field
$label

A FieldInterface object representing the label to attach to this field (see FieldsInterface::label)

Returns

Blesta\Core\Util\Input\Fields\Common\FieldInterface
A FieldInterface object that can be attached to a FieldInterface label

See

Blesta\Core\Util\Input\Fields\Common\FieldsInterface::label()
Blesta\Core\Util\Input\Fields\Common\FieldInterface::attach()
public Blesta\Core\Util\Input\Fields\Common\FieldInterface
# fieldSelect( string $name, array $options = [], mixed $selected_value = null, array $attributes = [], array $option_attributes = [], Blesta\Core\Util\Input\Fields\Common\FieldInterface $label = null )

Creates a select list

Creates a select list

Parameters

$name
The name to set in the HTML name field
$options
The options to place in this select list
$selected_value
The option(s) to set as selected
$attributes
Attributes for this input field
$option_attributes

Attributes for each option to set. If single dimension will set the attributes for every option, if multi-dimensional will set option for each element key that matches in $options

$label

A FieldInterface object representing the label to attach to this field (see FieldsInterface::label)

Returns

Blesta\Core\Util\Input\Fields\Common\FieldInterface
A FieldInterface object that can be attached to a FieldInterface label

See

Blesta\Core\Util\Input\Fields\Common\FieldsInterface::label()
Blesta\Core\Util\Input\Fields\Common\FieldInterface::attach()
public Blesta\Core\Util\Input\Fields\Common\FieldInterface
# fieldMultiSelect( string $name, array $options = [], string $selected_values = [], array $attributes = [], array $option_attributes = [], Blesta\Core\Util\Input\Fields\Common\FieldInterface $label = null )

Creates a select list with multiple selectable options

Creates a select list with multiple selectable options

Parameters

$name
The name to set in the HTML name field
$options
The options to place in this select list
$selected_values
The options to set as selected
$attributes
Attributes for this input field
$option_attributes

Attributes for each option to set. If single dimension will set the attributes for every option, if multi-dimensional will set option for each element key that matches in $options

$label

A FieldInterface object representing the label to attach to this field (see FieldsInterface::label)

Returns

Blesta\Core\Util\Input\Fields\Common\FieldInterface
A FieldInterface object that can be attached to a FieldInterface label

See

Blesta\Core\Util\Input\Fields\Common\FieldsInterface::label()
Blesta\Core\Util\Input\Fields\Common\FieldInterface::attach()
public Blesta\Core\Util\Input\Fields\Common\FieldInterface
# fieldButton( string $name, string $value = null, array $attributes = [], Blesta\Core\Util\Input\Fields\Common\FieldInterface $label = null )

Creates a button with default type=button, can be overriden by attirbutes

Creates a button with default type=button, can be overriden by attirbutes

Parameters

$name
The name to set in the HTML name field
$value
The value to set in the HTML value field
$attributes
Attributes for this input field
$label

A FieldInterface object representing the label to attach to this field (see FieldsInterface::label)

Returns

Blesta\Core\Util\Input\Fields\Common\FieldInterface
A FieldInterface object that can be attached to a FieldInterface label

See

Blesta\Core\Util\Input\Fields\Common\FieldsInterface::label()
Blesta\Core\Util\Input\Fields\Common\FieldInterface::attach()
public Blesta\Core\Util\Input\Fields\Common\FieldInterface
# fieldSubmit( string $name, string $value = null, array $attributes = [], Blesta\Core\Util\Input\Fields\Common\FieldInterface $label = null )

Creates a button of type submit

Creates a button of type submit

Parameters

$name
The name to set in the HTML name field
$value
The value to set in the HTML value field
$attributes
Attributes for this input field
$label

A FieldInterface object representing the label to attach to this field (see FieldsInterface::label)

Returns

Blesta\Core\Util\Input\Fields\Common\FieldInterface
A FieldInterface object that can be attached to a FieldInterface label

See

Blesta\Core\Util\Input\Fields\Common\FieldsInterface::label()
Blesta\Core\Util\Input\Fields\Common\FieldInterface::attach()
Blesta API documentation generated by ApiGen