Index

A

$ BootstrapForm #ajaxClass — Property in class BootstrapForm
$ BootstrapForm #ajax — Property in class BootstrapForm
$ BootstrapForm #autoShowValidation — Property in class BootstrapForm
If true, valid inputs will be explicitly green on unsuccessful submit
BootstrapRenderer ::attachForm () — Method in class BootstrapRenderer
Sets the form for which to render. Used only if a specific function of the renderer must be executed outside of render(), such as during assisted manual rendering.
BootstrapCell ::addComponent () — Method in class BootstrapCell
Delegate to underlying component.
BootstrapRow ::addCell () — Method in class BootstrapRow
Adds a new cell to which a control can be added.
BootstrapRow ::addComponent () — Method in class BootstrapRow
Delegate to underlying container and remember it.
$ TextAreaInput #autocomplete — Property in class TextAreaInput
$ TextInput #autocomplete — Property in class TextInput
AddRowTrait — Class in namespace Czubehead\BootstrapForms\Traits
Trait AddRowTrait. Implements method to add a bootstrap row.
AddRowTrait ::addRow () — Method in class AddRowTrait
Adds a new Grid system row.
BootstrapButtonTrait ::addBtnClass () — Method in class BootstrapButtonTrait
BootstrapContainerTrait ::addButton () — Method in class BootstrapContainerTrait
BootstrapContainerTrait ::addCheckbox () — Method in class BootstrapContainerTrait
BootstrapContainerTrait ::addCheckboxList () — Method in class BootstrapContainerTrait
BootstrapContainerTrait ::addComponent () — Method in class BootstrapContainerTrait
BootstrapContainerTrait ::addContainer () — Method in class BootstrapContainerTrait
BootstrapContainerTrait ::addDateTime () — Method in class BootstrapContainerTrait
Adds a datetime input.
BootstrapContainerTrait ::addEmail () — Method in class BootstrapContainerTrait
BootstrapContainerTrait ::addInputError () — Method in class BootstrapContainerTrait
Adds error to a specific component
BootstrapContainerTrait ::addInteger () — Method in class BootstrapContainerTrait
BootstrapContainerTrait ::addMultiSelect () — Method in class BootstrapContainerTrait
BootstrapContainerTrait ::addMultiUpload () — Method in class BootstrapContainerTrait
BootstrapContainerTrait ::addPassword () — Method in class BootstrapContainerTrait
BootstrapContainerTrait ::addRadioList () — Method in class BootstrapContainerTrait
BootstrapContainerTrait ::addSelect () — Method in class BootstrapContainerTrait
BootstrapContainerTrait ::addSubmit () — Method in class BootstrapContainerTrait
BootstrapContainerTrait ::addText () — Method in class BootstrapContainerTrait
BootstrapContainerTrait ::addTextArea () — Method in class BootstrapContainerTrait
BootstrapContainerTrait ::addUpload () — Method in class BootstrapContainerTrait

B

BootstrapContainer — Class in namespace Czubehead\BootstrapForms
Class BootstrapContainer.
BootstrapForm — Class in namespace Czubehead\BootstrapForms
Class BootstrapForm Form rendered using Bootstrap 4
BootstrapRenderer — Class in namespace Czubehead\BootstrapForms
Converts a Form into Bootstrap 4 HTML output.
BootstrapUtils — Class in namespace Czubehead\BootstrapForms
Class BootstrapUtils. Utils for this library.
BootstrapCell — Class in namespace Czubehead\BootstrapForms\Grid
Class BootstrapCell.
BootstrapRow — Class in namespace Czubehead\BootstrapForms\Grid
Class BootstrapRow.
ButtonInput — Class in namespace Czubehead\BootstrapForms\Inputs
Class ButtonInput.
$ ButtonInput #btnClass — Property in class ButtonInput
$ UploadInput #buttonCaption — Property in class UploadInput
the text on the left part of the button, NOT label.
BootstrapButtonTrait — Class in namespace Czubehead\BootstrapForms\Traits
Trait BootstrapButtonTrait. Modifies an existing button class such that it returns a bootstrap button.
$ BootstrapButtonTrait #btnType — Property in class BootstrapButtonTrait
BootstrapContainerTrait — Class in namespace Czubehead\BootstrapForms\Traits
Trait BootstrapContainerTrait.

C

$ BootstrapRenderer #controlColumns — Property in class BootstrapRenderer
BootstrapRenderer ::configElem () — Method in class BootstrapRenderer
Turns configuration or and existing element and configures it appropriately
BootstrapCell ::createClass () — Method in class BootstrapCell
Creates column class based on numOfColumns
CheckboxInput — Class in namespace Czubehead\BootstrapForms\Inputs
Class CheckboxInput. Single checkbox.
CheckboxListInput — Class in namespace Czubehead\BootstrapForms\Inputs
Class CheckboxListInput.
DateTimeInput ::cleanErrors () — Method in class DateTimeInput
ChoiceInputTrait — Class in namespace Czubehead\BootstrapForms\Traits
Trait ChoiceInputTrait.

D

DateTimeFormat — Class in namespace Czubehead\BootstrapForms\Enums
An easy-to-use list of date/time formats

How to understand the constants

  1. D_ prefix -> date format
  2. T_ prefix -> time format
  3. DMY , YMD and MDY specify the order of day, month and year
  4. _NO_LEAD suffix means no leading zeros
  5. T_12 LOWER / UPPER point to AM/am, PM/pm
DateTimeInput — Class in namespace Czubehead\BootstrapForms\Inputs
Class DateTimeInput. Textual datetime input.

E

$ BootstrapForm #elementPrototype — Property in class BootstrapForm

F

$ BootstrapRenderer #form — Property in class BootstrapRenderer
BootstrapRenderer ::fetchConfig () — Method in class BootstrapRenderer
Fetch config tailored for current render mode
$ DateTimeInput #format — Property in class DateTimeInput
expected PHP format for datetime
ChoiceInputTrait ::flatAssocArray () — Method in class ChoiceInputTrait
Processes an associative array in a way that it has no nesting. Keys for nested arrays are lost, but nested arrays are merged.
FakeControlTrait — Class in namespace Czubehead\BootstrapForms\Traits
Trait FakeControlTrait.

G

BootstrapForm ::getElementPrototype () — Method in class BootstrapForm
BootstrapForm ::getRenderer () — Method in class BootstrapForm
BootstrapForm ::getRenderMode () — Method in class BootstrapForm
$ BootstrapRenderer #gridBreakPoint — Property in class BootstrapRenderer
Bootstrap grid breakpoint for side-by-side view. Default is 'sm'. NULL means not to use a breakpoint
$ BootstrapRenderer #groupHidden — Property in class BootstrapRenderer
if true, hidden fields will be grouped at the end. If false, hidden fields are placed where they were added. Default is true.
BootstrapRenderer ::getConfig () — Method in class BootstrapRenderer
BootstrapRenderer ::getConfigOverride () — Method in class BootstrapRenderer
BootstrapRenderer ::getGridBreakPoint () — Method in class BootstrapRenderer
BootstrapRenderer ::getMode () — Method in class BootstrapRenderer
Returns render mode
BootstrapRenderer ::getElem () — Method in class BootstrapRenderer
Get element based on its first-level key
BootstrapCell ::getElementPrototype () — Method in class BootstrapCell
Gets the prototype of this cell so you can define additional attributes. Col-* class is added during rendering and is not present, so don't add it.
BootstrapCell ::getNumOfColumns () — Method in class BootstrapCell
$ BootstrapRow #gridBreakPoint — Property in class BootstrapRow
Bootstrap breakpoint - usually xs, sm, md, lg. sm by default. Use NULL for no breakpoint.
BootstrapRow ::getCells () — Method in class BootstrapRow
BootstrapRow ::getElementPrototype () — Method in class BootstrapRow
The container without content
BootstrapRow ::getGridBreakPoint () — Method in class BootstrapRow
BootstrapRow ::getName () — Method in class BootstrapRow
Component name
BootstrapRow ::getParent () — Method in class BootstrapRow
Returns the container
BootstrapRow ::getOption () — Method in class BootstrapRow
Gets previously set option
ButtonInput ::getControl () — Method in class ButtonInput
Control HTML
CheckboxInput ::getControl () — Method in class CheckboxInput
Generates a checkbox
CheckboxListInput ::getControl () — Method in class CheckboxListInput
DateTimeInput ::getValue () — Method in class DateTimeInput
DateTimeInput ::getFormat () — Method in class DateTimeInput
IAutocompleteInput ::getAutocomplete () — Method in class IAutocompleteInput
Gets the state of autocomplete: true=on,false=off,null=omit attribute
MultiselectInput ::getControl () — Method in class MultiselectInput
RadioInput ::getControl () — Method in class RadioInput
Generates control's HTML element.
SelectInput ::getControl () — Method in class SelectInput
TextAreaInput ::getAutocomplete () — Method in class TextAreaInput
Gets the state of autocomplete: true=on,false=off,null=omit attribute
TextAreaInput ::getControl () — Method in class TextAreaInput
TextInput ::getAutocomplete () — Method in class TextInput
Gets the state of autocomplete: true=on,false=off,null=omit attribute
TextInput ::getControl () — Method in class TextInput
TextInput ::getPlaceholder () — Method in class TextInput
UploadInput ::getButtonCaption () — Method in class UploadInput
UploadInput ::getControl () — Method in class UploadInput
BootstrapButtonTrait ::getBtnClass () — Method in class BootstrapButtonTrait
Gets additional button class. Default is btn-primary.
BootstrapButtonTrait ::getControl () — Method in class BootstrapButtonTrait
FakeControlTrait ::getErrors () — Method in class FakeControlTrait
Always returns an empty array
FakeControlTrait ::getValue () — Method in class FakeControlTrait
Not supported
InputPromptTrait ::getPrompt () — Method in class InputPromptTrait

I

BootstrapForm ::isAjax () — Method in class BootstrapForm
BootstrapForm ::isAutoShowValidation () — Method in class BootstrapForm
BootstrapForm ::isShowValidation () — Method in class BootstrapForm
If valid fields should explicitly be green
BootstrapRenderer ::isGroupHidden () — Method in class BootstrapRenderer
$ DateTimeInput #invalidFormatMessage — Property in class DateTimeInput
This errorMessage is added for invalid format
IAutocompleteInput — Class in namespace Czubehead\BootstrapForms\Inputs
Interface IAutocompleteInput.
IValidationInput — Class in namespace Czubehead\BootstrapForms\Inputs
Classes implementing this interface can explicitly show their validation status.
ChoiceInputTrait ::isControlDisabled () — Method in class ChoiceInputTrait
Check if whole control is disabled.
ChoiceInputTrait ::isValueDisabled () — Method in class ChoiceInputTrait
Check if a specific value is disabled. If whole control is disabled, returns false.
ChoiceInputTrait ::isValueSelected () — Method in class ChoiceInputTrait
Self-explanatory
FakeControlTrait ::isDisabled () — Method in class FakeControlTrait
FakeControlTrait ::isOmitted () — Method in class FakeControlTrait
Is control value excluded from $form->getValues() result?
InputPromptTrait — Class in namespace Czubehead\BootstrapForms\Traits
Trait InputPromptTrait.

L

$ BootstrapRenderer #labelColumns — Property in class BootstrapRenderer

M

$ BootstrapRenderer #mode — Property in class BootstrapRenderer
CheckboxInput ::makeCheckbox () — Method in class CheckboxInput
Makes a Bootstrap checkbox HTML
DateTimeInput ::makeFormatPlaceholder () — Method in class DateTimeInput
Turns datetime format into a placeholder, e.g. 'd.m.Y' => 'dd.mm.yyyy'.
MultiselectInput — Class in namespace Czubehead\BootstrapForms\Inputs
Class MultiselectInput.
ChoiceInputTrait ::makeOptionList () — Method in class ChoiceInputTrait
Makes array of <option>. Can handle associative arrays just fine. Checks for duplicate values.

N

$ BootstrapRow #numOfColumns — Property in class BootstrapRow
Number of columns in Bootstrap grid. Default is 12, but it can be customized.

P

$ TextInput #placeholder — Property in class TextInput
HTML placeholder
$ InputPromptTrait #prompt — Property in class InputPromptTrait

R

$ BootstrapForm #renderMode — Property in class BootstrapForm
BootstrapRenderer ::render () — Method in class BootstrapRenderer
Provides complete form rendering.
BootstrapRenderer ::renderBegin () — Method in class BootstrapRenderer
Renders form begin.
BootstrapRenderer ::renderBody () — Method in class BootstrapRenderer
Renders form body.
BootstrapRenderer ::renderControl () — Method in class BootstrapRenderer
Renders 'control' part of visual row of controls.
BootstrapRenderer ::renderControls () — Method in class BootstrapRenderer
Renders group of controls.
BootstrapRenderer ::renderEnd () — Method in class BootstrapRenderer
Renders form end.
BootstrapRenderer ::renderLabel () — Method in class BootstrapRenderer
Renders 'label' part of visual row of controls.
BootstrapRenderer ::renderPair () — Method in class BootstrapRenderer
Renders single visual row.
BootstrapRenderer ::renderDescription () — Method in class BootstrapRenderer
Renders control description (help text)
BootstrapRenderer ::renderFeedback () — Method in class BootstrapRenderer
Renders valid or invalid feedback of form or control
RenderMode — Class in namespace Czubehead\BootstrapForms\Enums
Class RenderMode Defines the mode BootstrapRenderer works in.
RendererConfig — Class in namespace Czubehead\BootstrapForms\Enums
Class RendererConfig.
RendererOptions — Class in namespace Czubehead\BootstrapForms\Enums
Class RendererOptions.
BootstrapCell ::render () — Method in class BootstrapCell
Renders the cell into Html object
BootstrapRow ::render () — Method in class BootstrapRow
Renders the row into a Html object
RadioInput — Class in namespace Czubehead\BootstrapForms\Inputs
Class RadioInput. Lets user choose one out of multiple options.
$ ChoiceInputTrait #rawItems — Property in class ChoiceInputTrait

S

$ BootstrapForm #showValidation — Property in class BootstrapForm
If valid fields should explicitly be green if valid
BootstrapForm ::setRenderer () — Method in class BootstrapForm
BootstrapForm ::setAutoShowValidation () — Method in class BootstrapForm
BootstrapForm ::setShowValidation () — Method in class BootstrapForm
If valid fields should explicitly be green
BootstrapForm ::setAjax () — Method in class BootstrapForm
BootstrapForm ::setRenderMode () — Method in class BootstrapForm
BootstrapRenderer ::setGridBreakPoint () — Method in class BootstrapRenderer
BootstrapRenderer ::setGroupHidden () — Method in class BootstrapRenderer
BootstrapRenderer ::setColumns () — Method in class BootstrapRenderer
Set how many of Bootstrap rows shall the label and control occupy
BootstrapRenderer ::setMode () — Method in class BootstrapRenderer
Sets render mode
BootstrapUtils ::standardizeClass () — Method in class BootstrapUtils
Converts element classes to an array if needed
BootstrapRow ::setGridBreakPoint () — Method in class BootstrapRow
Sets the xs, sm, md, lg part.
BootstrapRow ::setParent () — Method in class BootstrapRow
Sets the container
BootstrapRow ::setOption () — Method in class BootstrapRow
Sets option
CheckboxInput ::showValidation () — Method in class CheckboxInput
Modify control in such a way that it explicitly shows its validation state.
CheckboxListInput ::showValidation () — Method in class CheckboxListInput
Modify control in such a way that it explicitly shows its validation state.
DateTimeInput ::setValue () — Method in class DateTimeInput
DateTimeInput ::setFormat () — Method in class DateTimeInput
Input accepted format.
IAutocompleteInput ::setAutocomplete () — Method in class IAutocompleteInput
Turns autocomplete on or off.
IValidationInput ::showValidation () — Method in class IValidationInput
Modify control in such a way that it explicitly shows its validation state.
RadioInput ::showValidation () — Method in class RadioInput
Modify control in such a way that it explicitly shows its validation state.
SelectInput — Class in namespace Czubehead\BootstrapForms\Inputs
Class SelectInput.
SubmitButtonInput — Class in namespace Czubehead\BootstrapForms\Inputs
Class SubmitButtonInput. Form can be submitted with this.
TextAreaInput ::setAutocomplete () — Method in class TextAreaInput
Turns autocomplete on or off.
TextInput ::setAutocomplete () — Method in class TextInput
Turns autocomplete on or off.
TextInput ::setPlaceholder () — Method in class TextInput
UploadInput ::setButtonCaption () — Method in class UploadInput
the text on the left part of the button
UploadInput ::showValidation () — Method in class UploadInput
Modify control in such a way that it explicitly shows its validation state.
BootstrapButtonTrait ::setBtnClass () — Method in class BootstrapButtonTrait
Sets additional button class. Default is btn-primary
ChoiceInputTrait ::setItems () — Method in class ChoiceInputTrait
FakeControlTrait ::setValue () — Method in class FakeControlTrait
Not supported
InputPromptTrait ::setPrompt () — Method in class InputPromptTrait
Sets the first unselectable item on list. Its value is null.
StandardValidationTrait — Class in namespace Czubehead\BootstrapForms\Traits
Trait StandardValidationTrait.
StandardValidationTrait ::showValidation () — Method in class StandardValidationTrait
Modify control in such a way that it explicitly shows its validation state.

T

TextAreaInput — Class in namespace Czubehead\BootstrapForms\Inputs
Class TextAreaInput
TextInput — Class in namespace Czubehead\BootstrapForms\Inputs
Class TextInput

U

UploadInput — Class in namespace Czubehead\BootstrapForms\Inputs
Class UploadInput. Single or multi upload of files.

V

DateTimeFormat ::validate () — Method in class DateTimeFormat
Checks if give time string is indeed in the format specified.
DateTimeInput ::validate () — Method in class DateTimeInput
FakeControlTrait ::validate () — Method in class FakeControlTrait
Do nothing

_

BootstrapForm ::__construct () — Method in class BootstrapForm
BootstrapForm constructor.
BootstrapRenderer ::__construct () — Method in class BootstrapRenderer
BootstrapRenderer constructor.
BootstrapCell ::__construct () — Method in class BootstrapCell
BootstrapRow constructor.
BootstrapRow ::__construct () — Method in class BootstrapRow
BootstrapRow constructor.
ButtonInput ::__construct () — Method in class ButtonInput
ButtonInput constructor.
DateTimeInput ::__construct () — Method in class DateTimeInput
MultiselectInput ::__construct () — Method in class MultiselectInput
RadioInput ::__construct () — Method in class RadioInput
SelectInput ::__construct () — Method in class SelectInput
SelectInput constructor.
TextAreaInput ::__construct () — Method in class TextAreaInput
TextInput ::__construct () — Method in class TextInput