1. class
  2. Symfony
  3. \
  4. Component
  5. \
  6. DomCrawler
  7. \
  8. Field
  9. \
  10. FileFormField

FileFormField

class FileFormField extends FormField

FileFormField represents a file form field (an HTML file input tag).

Properties

protected DOMElement $node from FormField
protected string $name from FormField
protected string $value from FormField
protected DOMDocument $document from FormField
protected DOMXPath $xpath from FormField
protected bool $disabled from FormField

Methods

__construct(DOMElement $node)

No description

from FormField
DOMElement|null
getLabel()

Returns the label tag associated to the field or null if none.

from FormField
string
getName()

Returns the name of the field.

from FormField
string|array
getValue()

Gets the value of the field.

from FormField
setValue(string $value)

Sets the value of the field.

bool
hasValue()

Returns true if the field should be included in the submitted values.

from FormField
bool
isDisabled()

Check if the current field is disabled.

from FormField
initialize()

Initializes the form field.

setErrorCode(int $error)

Sets the PHP error code associated with the field.

upload(string $value)

Sets the value of the field.

setFilePath(string $path)

Sets path to the file as string for simulating HTTP request.

Details

__construct(DOMElement $node)

Parameters

DOMElement $node The node associated with this field

DOMElement|null getLabel()

Returns the label tag associated to the field or null if none.

Return Value

DOMElement|null

string getName()

Returns the name of the field.

Return Value

string The name of the field

string|array getValue()

Gets the value of the field.

Return Value

string|array The value of the field

setValue(string $value)

Sets the value of the field.

Parameters

string $value The value of the field

bool hasValue()

Returns true if the field should be included in the submitted values.

Return Value

bool true if the field should be included in the submitted values, false otherwise

bool isDisabled()

Check if the current field is disabled.

Return Value

bool

protected initialize()

Initializes the form field.

Exceptions

LogicException When node type is incorrect

setErrorCode(int $error)

Sets the PHP error code associated with the field.

Parameters

int $error The error code (one of UPLOAD_ERR_INI_SIZE, UPLOAD_ERR_FORM_SIZE, UPLOAD_ERR_PARTIAL, UPLOAD_ERR_NO_FILE, UPLOAD_ERR_NO_TMP_DIR, UPLOAD_ERR_CANT_WRITE, or UPLOAD_ERR_EXTENSION)

Exceptions

InvalidArgumentException When error code doesn't exist

upload(string $value)

Sets the value of the field.

Parameters

string $value The value of the field

setFilePath(string $path)

Sets path to the file as string for simulating HTTP request.

Parameters

string $path The path to the file