class Files extends BaseFormField (View source)

Traits

Properties

bool $renderForBlocks from  RenderForBlocks
protected bool $translated from  IsTranslatable
protected int|null $max from  HasMax
protected string|null $fieldNote from  HasFieldNote
protected bool $buttonOnTop from  CanHaveButtonOnTop
protected string|null $itemLabel
protected int|null $filesizeMax

Methods

renderForBlocks(bool $renderForBlocks = true)

No description

bool
forBlocks()

No description

__construct(string $component, string|null $name = null, string|null $label = null, string|null $note = null, bool|null $required = false, bool|null $disabled = false, mixed $default = null, mixed $connectedTo = null, array $mandatoryProperties = [])

No description

static BaseFormField
make()

No description

name(string $name)

Set the name of the field, if no label is set yet, this method will also update that.

default(mixed $default)

No description

label(string $label)

Set the label of the field, you can use twillTrans('') Laravel translatable strings here.

note(string $note)

Add a note to the field to display on the form.

required(bool $required = true)

Marks the field as mandatory, however you still need to add validation rules.

disabled(bool $disabled = true)

Marks the field as disabled.

connectedTo(string $fieldName, mixed $fieldValues, array $options = [])

No description

View
render()

No description

array
getAdditionalConstructorArguments()

In render we dynamically build the constructor arguments.

translatable(bool $translatable = true)

Makes the field translatable.

max(int $max)

Sets the max amount of items.

from  HasMax
fieldNote(string $fieldNote)

Adds a note.

buttonOnTop(bool $buttonOnTop = true)

Shows the browse button above instead of below the list of items.

filesizeMax(int $filesizeMax)

Default is 0 which is unlimited (depending on server config).

itemLabel(string $itemLabel)

The label to display for items, defaults to the field label.

string
getNote()

No description

Details

RenderForBlocks renderForBlocks(bool $renderForBlocks = true)

No description

Parameters

bool $renderForBlocks

Return Value

RenderForBlocks

bool forBlocks()

No description

Return Value

bool

protected __construct(string $component, string|null $name = null, string|null $label = null, string|null $note = null, bool|null $required = false, bool|null $disabled = false, mixed $default = null, mixed $connectedTo = null, array $mandatoryProperties = [])

No description

Parameters

string $component
string|null $name
string|null $label
string|null $note
bool|null $required
bool|null $disabled
mixed $default
mixed $connectedTo
array $mandatoryProperties

static BaseFormField make()

No description

Return Value

BaseFormField

BaseFormField name(string $name)

Set the name of the field, if no label is set yet, this method will also update that.

Parameters

string $name

Return Value

BaseFormField

BaseFormField default(mixed $default)

No description

Parameters

mixed $default

Return Value

BaseFormField

BaseFormField label(string $label)

Set the label of the field, you can use twillTrans('') Laravel translatable strings here.

Parameters

string $label

Return Value

BaseFormField

BaseFormField note(string $note)

Add a note to the field to display on the form.

Parameters

string $note

Return Value

BaseFormField

BaseFormField required(bool $required = true)

Marks the field as mandatory, however you still need to add validation rules.

Parameters

bool $required

Return Value

BaseFormField

BaseFormField disabled(bool $disabled = true)

Marks the field as disabled.

There might be some fields not supporting this.

Parameters

bool $disabled

Return Value

BaseFormField

connectedTo(string $fieldName, mixed $fieldValues, array $options = [])

No description

Parameters

string $fieldName
mixed $fieldValues
array $options

View render()

No description

Return Value

View

protected array getAdditionalConstructorArguments()

In render we dynamically build the constructor arguments.

In exceptional cases such as browser we have more conditionals and we can use this method to set those.

Return Value

array

IsTranslatable translatable(bool $translatable = true)

Makes the field translatable.

Parameters

bool $translatable

Return Value

IsTranslatable

HasMax max(int $max)

Sets the max amount of items.

Parameters

int $max

Return Value

HasMax

HasFieldNote fieldNote(string $fieldNote)

Adds a note.

Parameters

string $fieldNote

Return Value

HasFieldNote

CanHaveButtonOnTop buttonOnTop(bool $buttonOnTop = true)

Shows the browse button above instead of below the list of items.

Parameters

bool $buttonOnTop

Return Value

CanHaveButtonOnTop

Files filesizeMax(int $filesizeMax)

Default is 0 which is unlimited (depending on server config).

Parameters

int $filesizeMax

Return Value

Files

Files itemLabel(string $itemLabel)

The label to display for items, defaults to the field label.

Parameters

string $itemLabel

Return Value

Files

string getNote()

No description

Return Value

string