MediaWiki  master
Wikimedia\ParamValidator\TypeDef\UploadDef Class Reference

Type definition for upload types. More...

Inheritance diagram for Wikimedia\ParamValidator\TypeDef\UploadDef:
Collaboration diagram for Wikimedia\ParamValidator\TypeDef\UploadDef:

Public Member Functions

 checkSettings (string $name, $settings, array $options, array $ret)
 Validate a parameter settings array. More...
 
 getHelpInfo ( $name, array $settings, array $options)
 Describe parameter settings in human-readable format. More...
 
 getValue ( $name, array $settings, array $options)
 Get the value from the request Stable to override. More...
 
 stringifyValue ( $name, $value, array $settings, array $options)
 Convert a value to a string representation. More...
 
 validate ( $name, $value, array $settings, array $options)
 Validate the value. More...
 
- Public Member Functions inherited from Wikimedia\ParamValidator\TypeDef
 __construct (Callbacks $callbacks)
 Stable to call. More...
 
 getEnumValues ( $name, array $settings, array $options)
 Get the values for enum-like parameters. More...
 
 getParamInfo ( $name, array $settings, array $options)
 Describe parameter settings in a machine-readable format. More...
 
 normalizeSettings (array $settings)
 Normalize a settings array Stable to override. More...
 

Protected Member Functions

 getIniSize ()
 Fetch the value of PHP's upload_max_filesize ini setting. More...
 
- Protected Member Functions inherited from Wikimedia\ParamValidator\TypeDef
 failure ( $failure, $name, $value, array $settings, array $options, $fatal=true)
 Record a failure message. More...
 
 failureMessage ( $code, array $data=null, $suffix=null)
 Create a DataMessageValue representing a failure. More...
 

Additional Inherited Members

- Protected Attributes inherited from Wikimedia\ParamValidator\TypeDef
Callbacks $callbacks
 

Detailed Description

Type definition for upload types.

The result from validate() is an object implementing UploadedFileInterface.

Failure codes:

  • 'badupload': The upload is not valid. Data:
    • 'code': A value indicating why the upload was not valid:
      • 'inisize': The upload exceeded the maximum in php.ini.
      • 'formsize': The upload exceeded the maximum in the form post.
      • 'partial': The file was only partially uploaded.
      • 'nofile': There was no file.
      • 'notmpdir': PHP has no temporary directory to store the upload.
      • 'cantwrite': PHP could not store the upload.
      • 'phpext': A PHP extension rejected the upload.
      • 'notupload': The field was present in the submission but was not encoded as an upload.
    • 'size': The configured size (in bytes), if 'code' is 'inisize'.
Since
1.34 @unstable

Definition at line 34 of file UploadDef.php.

Member Function Documentation

◆ checkSettings()

Wikimedia\ParamValidator\TypeDef\UploadDef::checkSettings ( string  $name,
  $settings,
array  $options,
array  $ret 
)

Validate a parameter settings array.

This is intended for validation of parameter settings during unit or integration testing, and should implement strict checks.

The rest of the code should generally be more permissive.

See also
ParamValidator::checkSettings() Stable to override
Parameters
string$nameParameter name
array | mixed$settingsDefault value or an array of settings using PARAM_* constants.
array$optionsOptions array, passed through to the TypeDef and Callbacks.
array$ret
  • 'issues': (string[]) Errors detected in $settings, as English text. If the settings are valid, this will be the empty array. Keys on input are ParamValidator constants, allowing the typedef to easily override core validation; this need not be preserved when returned.
  • 'allowedKeys': (string[]) ParamValidator keys that are allowed in $settings.
  • 'messages': (MessageValue[]) Messages to be checked for existence.
Returns
array $ret, with any relevant changes.

Reimplemented from Wikimedia\ParamValidator\TypeDef.

Definition at line 125 of file UploadDef.php.

References Wikimedia\ParamValidator\ParamValidator\PARAM_DEFAULT, and Wikimedia\ParamValidator\ParamValidator\PARAM_ISMULTI.

◆ getHelpInfo()

Wikimedia\ParamValidator\TypeDef\UploadDef::getHelpInfo (   $name,
array  $settings,
array  $options 
)

Describe parameter settings in human-readable format.

Keys in the returned array should generally correspond to PARAM constants.

If relevant, a MessageValue describing the type itself should be returned with key ParamValidator::PARAM_TYPE.

The default messages for other ParamValidator-defined PARAM constants may be suppressed by returning null as the value for those constants, or replaced by returning a replacement MessageValue. Normally, however, the default messages should not be changed.

MessageValues describing any other constraints applied via PARAM constants specific to this class should also be returned. Stable to override

Parameters
string$nameParameter name being described.
array$settingsParameter settings array.
array$optionsOptions array.
Returns
(MessageValue|null)[]

Reimplemented from Wikimedia\ParamValidator\TypeDef.

Definition at line 148 of file UploadDef.php.

References Wikimedia\Message\MessageValue\new(), and Wikimedia\ParamValidator\ParamValidator\PARAM_TYPE.

◆ getIniSize()

Wikimedia\ParamValidator\TypeDef\UploadDef::getIniSize ( )
protected

Fetch the value of PHP's upload_max_filesize ini setting.

This method exists so it can be mocked by unit tests that can't affect ini_get() directly.

Returns
string|false

Definition at line 69 of file UploadDef.php.

Referenced by Wikimedia\ParamValidator\TypeDef\UploadDef\validate().

◆ getValue()

Wikimedia\ParamValidator\TypeDef\UploadDef::getValue (   $name,
array  $settings,
array  $options 
)

Get the value from the request Stable to override.

Note
Only override this if you need to use something other than $this->callbacks->getValue() to fetch the value. Reformatting from a string should typically be done by self::validate().
Handling of ParamValidator::PARAM_DEFAULT should be left to ParamValidator, as should PARAM_REQUIRED and the like.
Parameters
string$nameParameter name being fetched.
array$settingsParameter settings array.
array$optionsOptions array.
Returns
null|mixed Return null if the value wasn't present, otherwise a value to be passed to self::validate().

Reimplemented from Wikimedia\ParamValidator\TypeDef.

Definition at line 36 of file UploadDef.php.

◆ stringifyValue()

Wikimedia\ParamValidator\TypeDef\UploadDef::stringifyValue (   $name,
  $value,
array  $settings,
array  $options 
)

Convert a value to a string representation.

This is intended as the inverse of getValue() and validate(): this should accept anything returned by those methods or expected to be used as PARAM_DEFAULT, and if the string from this method is passed in as client input or PARAM_DEFAULT it should give equivalent output from validate().

Parameters
string$nameParameter name being converted.
mixed$valueParameter value being converted. Do not pass null.
array$settingsParameter settings array.
array$optionsOptions array.
Returns
string|null Return null if there is no representation of $value reasonably satisfying the description given.

Reimplemented from Wikimedia\ParamValidator\TypeDef.

Definition at line 143 of file UploadDef.php.

◆ validate()

Wikimedia\ParamValidator\TypeDef\UploadDef::validate (   $name,
  $value,
array  $settings,
array  $options 
)

Validate the value.

When ParamValidator is processing a multi-valued parameter, this will be called once for each of the supplied values. Which may mean zero calls.

When getValue() returned null, this will not be called.

Parameters
string$nameParameter name being validated.
mixed$valueValue to validate, from getValue().
array$settingsParameter settings array.
array$optionsOptions array. Note the following values that may be set by ParamValidator:
  • is-default: (bool) If present and true, the value was taken from PARAM_DEFAULT rather that being supplied by the client.
  • values-list: (string[]) If defined, values of a multi-valued parameter are being processed (and this array holds the full set of values).
Returns
mixed Validated value
Exceptions
ValidationExceptionif the value is invalid

Reimplemented from Wikimedia\ParamValidator\TypeDef.

Definition at line 73 of file UploadDef.php.

References $type, Wikimedia\ParamValidator\TypeDef\failure(), Wikimedia\ParamValidator\TypeDef\failureMessage(), and Wikimedia\ParamValidator\TypeDef\UploadDef\getIniSize().


The documentation for this class was generated from the following file: