class UserFormFileExtension extends Extension (View source)

Constants

USER_FORM_UPLOAD_UNKNOWN

USER_FORM_UPLOAD_FALSE

USER_FORM_UPLOAD_TRUE

Properties

protected T $owner

The object this extension is applied to.

from  Extension
string $UserFormUpload

Methods

public
__construct()

No description

public static 
add_to_class(string $class, string $extensionClass, mixed $args = null)

Called when this extension is added to a particular class

public
setOwner(object $owner)

Set the owner of this extension.

public
mixed
withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

public
clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

public
T
getOwner()

Returns the owner of this extension.

public static 
string
get_classname_without_arguments(string $extensionStr)

Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().

public
mixed
invokeExtension(object $owner, string $method, array ...$arguments)

Invoke extension point. This will prefer explicit extend prefixed methods.

protected
void
updateTrackedFormUpload(bool $value)

Check if the file is associated with a userform submission Save the result in the database as a tri-state for two reasons: a) performance - prevent the need for an extra DB query b) if in the future the UserForm submission is deleted and the uploaded file is not (file is orphaned), then it is still recorded that the file was originally uploaded from a userform submission

Details

__construct()

No description

static add_to_class(string $class, string $extensionClass, mixed $args = null)

Called when this extension is added to a particular class

Parameters

string $class
string $extensionClass
mixed $args

setOwner(object $owner)

Set the owner of this extension.

Parameters

object $owner

The owner object

mixed withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

Parameters

mixed $owner

Owner to set

callable $callback

Callback to invoke

array $args

Args to pass to callback

Return Value

mixed

clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

T getOwner()

Returns the owner of this extension.

Return Value

T

static string get_classname_without_arguments(string $extensionStr)

Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().

Parameters

string $extensionStr

E.g. "Versioned('Stage','Live')"

Return Value

string

Extension classname, e.g. "Versioned"

mixed invokeExtension(object $owner, string $method, array ...$arguments)

Invoke extension point. This will prefer explicit extend prefixed methods.

Parameters

object $owner
string $method
array ...$arguments

Return Value

mixed

protected void updateTrackedFormUpload(bool $value)

Check if the file is associated with a userform submission Save the result in the database as a tri-state for two reasons: a) performance - prevent the need for an extra DB query b) if in the future the UserForm submission is deleted and the uploaded file is not (file is orphaned), then it is still recorded that the file was originally uploaded from a userform submission

Parameters

bool $value

Return Value

void

See also

File::isTrackedFormUpload
UserDefinedFormController::process

SubmittedFileField SubmittedFileField()

No description

Return Value

SubmittedFileField