HumHub Documentation (unofficial)

MultipartFormDataParser extends BaseObject
in package
implements RequestParserInterface

MultipartFormDataParser parses content encoded as 'multipart/form-data'.

This parser provides the fallback for the 'multipart/form-data' processing on non POST requests, for example: the one with 'PUT' request method.

In order to enable this parser you should configure [[Request::parsers]] in the following way:

return [
    'components' => [
        'request' => [
            'parsers' => [
                'multipart/form-data' => 'yii\web\MultipartFormDataParser'
            ],
        ],
        // ...
    ],
    // ...
];

Method [[parse()]] of this parser automatically populates $_FILES with the files parsed from raw body.

Note: since this is a request parser, it will initialize $_FILES values on [[Request::getBodyParams()]]. Until this method is invoked, $_FILES array will remain empty even if there are submitted files in the request body. Make sure you have requested body params before any attempt to get uploaded file in case you are using this parser.

Usage example:

use yii\web\UploadedFile;

$restRequestData = Yii::$app->request->getBodyParams();
$uploadedFile = UploadedFile::getInstancesByName('photo');

$model = new Item();
$model->populate($restRequestData);
copy($uploadedFile->tempName, '/path/to/file/storage/photo.jpg');

Note: although this parser fully emulates regular structure of the $_FILES, related temporary files, which are available via tmp_name key, will not be recognized by PHP as uploaded ones. Thus functions like is_uploaded_file() and move_uploaded_file() will fail on them.

Tags
author

Paul Klimov klimov.paul@gmail.com

since
2.0.10

Table of Contents

Interfaces

RequestParserInterface
Interface for classes that parse the raw request body into a parameters array.

Properties

$force  : bool
$uploadFileMaxCount  : int
$uploadFileMaxSize  : int
$_uploadFileMaxCount  : int
$_uploadFileMaxSize  : int

Methods

__call()  : mixed
Calls the named method which is not a class method.
__construct()  : mixed
Constructor.
__get()  : mixed
Returns the value of an object property.
__isset()  : bool
Checks if a property is set, i.e. defined and not null.
__set()  : mixed
Sets value of an object property.
__unset()  : mixed
Sets an object property to null.
canGetProperty()  : bool
Returns a value indicating whether a property can be read.
canSetProperty()  : bool
Returns a value indicating whether a property can be set.
className()  : string
Returns the fully qualified name of this class.
getUploadFileMaxCount()  : int
getUploadFileMaxSize()  : int
hasMethod()  : bool
Returns a value indicating whether a method is defined.
hasProperty()  : bool
Returns a value indicating whether a property is defined.
init()  : mixed
Initializes the object.
parse()  : array<string|int, mixed>
Parses a HTTP request body.
setUploadFileMaxCount()  : mixed
setUploadFileMaxSize()  : mixed
addFile()  : mixed
Adds file info to the uploaded files array by input name, e.g. `Item[file]`.
addValue()  : mixed
Adds value to the array by input name, e.g. `Item[name]`.
getByteSize()  : int
Gets the size in bytes from verbose size representation.
parseHeaders()  : array<string|int, mixed>
Parses content part headers.

Properties

$force

public bool $force = false

whether to parse raw body even for 'POST' request and $_FILES already populated. By default this option is disabled saving performance for 'POST' requests, which are already processed by PHP automatically.

Note: if this option is enabled, value of $_FILES will be reset on each parse.

Tags
since
2.0.13

Methods

__call()

Calls the named method which is not a class method.

public __call(string $name, array<string|int, mixed> $params) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

Parameters
$name : string

the method name

$params : array<string|int, mixed>

method parameters

Tags
throws
UnknownMethodException

when calling unknown method

Return values
mixed —

the method return value

__construct()

Constructor.

public __construct([array<string|int, mixed> $config = [] ]) : mixed

The default implementation does two things:

  • Initializes the object with the given configuration $config.
  • Call [[init()]].

If this method is overridden in a child class, it is recommended that

  • the last parameter of the constructor is a configuration array, like $config here.
  • call the parent implementation at the end of the constructor.
Parameters
$config : array<string|int, mixed> = []

name-value pairs that will be used to initialize the object properties

__get()

Returns the value of an object property.

public __get(string $name) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $object->property;.

Parameters
$name : string

the property name

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is write-only

see
__set()
Return values
mixed —

the property value

__isset()

Checks if a property is set, i.e. defined and not null.

public __isset(string $name) : bool

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($object->property).

Note that if the property is not defined, false will be returned.

Parameters
$name : string

the property name or the event name

Tags
see
https://www.php.net/manual/en/function.isset.php
Return values
bool —

whether the named property is set (not null).

__set()

Sets value of an object property.

public __set(string $name, mixed $value) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $object->property = $value;.

Parameters
$name : string

the property name or the event name

$value : mixed

the property value

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is read-only

see
__get()

__unset()

Sets an object property to null.

public __unset(string $name) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($object->property).

Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.

Parameters
$name : string

the property name

Tags
throws
InvalidCallException

if the property is read only.

see
https://www.php.net/manual/en/function.unset.php

canGetProperty()

Returns a value indicating whether a property can be read.

public canGetProperty(string $name[, bool $checkVars = true ]) : bool

A property is readable if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canSetProperty()
Return values
bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.

public canSetProperty(string $name[, bool $checkVars = true ]) : bool

A property is writable if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canGetProperty()
Return values
bool —

whether the property can be written

className()

Returns the fully qualified name of this class.

public static className() : string
Tags
deprecated

since 2.0.14. On PHP >=5.5, use ::class instead.

Return values
string —

the fully qualified name of this class.

getUploadFileMaxCount()

public getUploadFileMaxCount() : int
Return values
int —

maximum upload files count.

getUploadFileMaxSize()

public getUploadFileMaxSize() : int
Return values
int —

upload file max size in bytes.

hasMethod()

Returns a value indicating whether a method is defined.

public hasMethod(string $name) : bool

The default implementation is a call to php function method_exists(). You may override this method when you implemented the php magic method __call().

Parameters
$name : string

the method name

Return values
bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined.

public hasProperty(string $name[, bool $checkVars = true ]) : bool

A property is defined if:

  • the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canGetProperty()
see
canSetProperty()
Return values
bool —

whether the property is defined

init()

Initializes the object.

public init() : mixed

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

parse()

Parses a HTTP request body.

public parse(mixed $rawBody, mixed $contentType) : array<string|int, mixed>
Parameters
$rawBody : mixed

the raw HTTP request body.

$contentType : mixed

the content type specified for the request body.

Return values
array<string|int, mixed> —

parameters parsed from the request body

setUploadFileMaxCount()

public setUploadFileMaxCount(int $uploadFileMaxCount) : mixed
Parameters
$uploadFileMaxCount : int

maximum upload files count.

setUploadFileMaxSize()

public setUploadFileMaxSize(int $uploadFileMaxSize) : mixed
Parameters
$uploadFileMaxSize : int

upload file max size in bytes.

addFile()

Adds file info to the uploaded files array by input name, e.g. `Item[file]`.

private addFile(array<string|int, mixed> &$files, string $name, array<string|int, mixed> $info) : mixed
Parameters
$files : array<string|int, mixed>

array containing uploaded files

$name : string

input name specification.

$info : array<string|int, mixed>

file info.

addValue()

Adds value to the array by input name, e.g. `Item[name]`.

private addValue(array<string|int, mixed> &$array, string $name, mixed $value) : mixed
Parameters
$array : array<string|int, mixed>

array which should store value.

$name : string

input name specification.

$value : mixed

value to be added.

getByteSize()

Gets the size in bytes from verbose size representation.

private getByteSize(string $verboseSize) : int

For example: '5K' => 5*1024.

Parameters
$verboseSize : string

verbose size representation.

Return values
int —

actual size in bytes.

parseHeaders()

Parses content part headers.

private parseHeaders(string $headerContent) : array<string|int, mixed>
Parameters
$headerContent : string

headers source content

Return values
array<string|int, mixed> —

parsed headers.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results