phpBB API Documentation
Class

phpbb\files\types\form

class form extends base

Methods

filespec check_upload_size(filespec $file)

Check if upload exceeds maximum file size

from base
type_interface set_upload(upload $upload)

Set upload instance Needs to be executed before every upload.

from base
__construct(factory $factory, language $language, IniGetWrapper $php_ini, plupload $plupload, request_interface $request)

Construct a form upload type

filespec|bool upload()

Handle upload for upload types.

Details

in base at line 34
public filespec check_upload_size(filespec $file)

Check if upload exceeds maximum file size

Parameters

filespec $file Filespec object

Return Value

filespec Returns same filespec instance

in base at line 59
public type_interface set_upload(upload $upload)

Set upload instance Needs to be executed before every upload.

Parameters

upload $upload Upload instance

Return Value

type_interface Returns itself

at line 52
public __construct(factory $factory, language $language, IniGetWrapper $php_ini, plupload $plupload, request_interface $request)

Construct a form upload type

Parameters

factory $factory Files factory
language $language Language class
IniGetWrapper $php_ini ini_get() wrapper
plupload $plupload Plupload
request_interface $request Request object

at line 64
public filespec|bool upload()

Handle upload for upload types.

Arguments passed to this method will be handled by the upload type classes themselves.

Return Value

filespec|bool Filespec instance if upload is successful or false if not