MediaWiki  master
Wikimedia\ParamValidator\SimpleCallbacks Class Reference

Simple Callbacks implementation for $_GET/$_POST/$_FILES data. More...

Inheritance diagram for Wikimedia\ParamValidator\SimpleCallbacks:
Collaboration diagram for Wikimedia\ParamValidator\SimpleCallbacks:

Public Member Functions

 __construct (array $params, array $files=[])
 
 clearRecordedConditions ()
 Clear any recorded conditions. More...
 
 getRecordedConditions ()
 Fetch any recorded conditions. More...
 
 getUploadedFile ( $name, array $options)
 Fetch data for a file upload. More...
 
 getValue ( $name, $default, array $options)
 Fetch a value from the request. More...
 
 hasParam ( $name, array $options)
 Test if a parameter exists in the request. More...
 
 hasUpload ( $name, array $options)
 Test if a parameter exists as an upload in the request. More...
 
 recordCondition (DataMessageValue $message, $name, $value, array $settings, array $options)
 Record non-fatal conditions. More...
 
 useHighLimits (array $options)
 Indicate whether "high limits" should be used. More...
 

Private Attributes

array[] $conditions = []
 Any recorded conditions. More...
 
array UploadedFile[] $files
 $_FILES data or UploadedFile instances More...
 
string string[][] $params
 $_GET/$_POST data More...
 

Detailed Description

Simple Callbacks implementation for $_GET/$_POST/$_FILES data.

Options array keys used by this class:

Since
1.34
Stability: unstable

Definition at line 17 of file SimpleCallbacks.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\ParamValidator\SimpleCallbacks::__construct ( array  $params,
array  $files = [] 
)
Parameters
(string|string[])[]$params Data from $_POST + $_GET
array[]$filesData from $_FILES

Definition at line 32 of file SimpleCallbacks.php.

References Wikimedia\ParamValidator\SimpleCallbacks\$files, and Wikimedia\ParamValidator\SimpleCallbacks\$params.

Member Function Documentation

◆ clearRecordedConditions()

Wikimedia\ParamValidator\SimpleCallbacks::clearRecordedConditions ( )

Clear any recorded conditions.

Definition at line 80 of file SimpleCallbacks.php.

◆ getRecordedConditions()

Wikimedia\ParamValidator\SimpleCallbacks::getRecordedConditions ( )

Fetch any recorded conditions.

Returns
array[]

Definition at line 73 of file SimpleCallbacks.php.

References Wikimedia\ParamValidator\SimpleCallbacks\$conditions.

◆ getUploadedFile()

Wikimedia\ParamValidator\SimpleCallbacks::getUploadedFile (   $name,
array  $options 
)

Fetch data for a file upload.

Parameters
string$nameParameter name of the upload
array$optionsOptions array
Returns
UploadedFileInterface|null Uploaded file, or null if there is no file for $name.

Implements Wikimedia\ParamValidator\Callbacks.

Definition at line 49 of file SimpleCallbacks.php.

References $file.

◆ getValue()

Wikimedia\ParamValidator\SimpleCallbacks::getValue (   $name,
  $default,
array  $options 
)

Fetch a value from the request.

Return $default for file-upload parameters.

Parameters
string$nameParameter name to fetch
mixed$defaultDefault value to return if the parameter is unset.
array$optionsOptions array
Returns
string|string[]|mixed A string or string[] if the parameter was found, or $default if it was not.

Implements Wikimedia\ParamValidator\Callbacks.

Definition at line 41 of file SimpleCallbacks.php.

◆ hasParam()

Wikimedia\ParamValidator\SimpleCallbacks::hasParam (   $name,
array  $options 
)

Test if a parameter exists in the request.

Parameters
string$nameParameter name
array$optionsOptions array
Returns
bool True if present, false if absent. Return false for file upload parameters.

Implements Wikimedia\ParamValidator\Callbacks.

Definition at line 37 of file SimpleCallbacks.php.

◆ hasUpload()

Wikimedia\ParamValidator\SimpleCallbacks::hasUpload (   $name,
array  $options 
)

Test if a parameter exists as an upload in the request.

Parameters
string$nameParameter name
array$optionsOptions array
Returns
bool True if present, false if absent.

Implements Wikimedia\ParamValidator\Callbacks.

Definition at line 45 of file SimpleCallbacks.php.

◆ recordCondition()

Wikimedia\ParamValidator\SimpleCallbacks::recordCondition ( DataMessageValue  $message,
  $name,
  $value,
array  $settings,
array  $options 
)

Record non-fatal conditions.

Parameters
DataMessageValue$messageFailure message
string$nameParameter name
mixed$valueParameter value
array$settingsParameter settings array
array$optionsOptions array

Implements Wikimedia\ParamValidator\Callbacks.

Definition at line 58 of file SimpleCallbacks.php.

◆ useHighLimits()

Wikimedia\ParamValidator\SimpleCallbacks::useHighLimits ( array  $options)

Indicate whether "high limits" should be used.

Some settings have multiple limits, one for "normal" users and a higher one for "privileged" users. This is used to determine which class the current user is in when necessary.

Parameters
array$optionsOptions array
Returns
bool Whether the current user is privileged to use high limits

Implements Wikimedia\ParamValidator\Callbacks.

Definition at line 84 of file SimpleCallbacks.php.

Member Data Documentation

◆ $conditions

array [] Wikimedia\ParamValidator\SimpleCallbacks::$conditions = []
private

Any recorded conditions.

Definition at line 26 of file SimpleCallbacks.php.

Referenced by Wikimedia\ParamValidator\SimpleCallbacks\getRecordedConditions().

◆ $files

array UploadedFile [] Wikimedia\ParamValidator\SimpleCallbacks::$files
private

$_FILES data or UploadedFile instances

Definition at line 23 of file SimpleCallbacks.php.

Referenced by Wikimedia\ParamValidator\SimpleCallbacks\__construct().

◆ $params

string string [][] Wikimedia\ParamValidator\SimpleCallbacks::$params
private

$_GET/$_POST data

Definition at line 20 of file SimpleCallbacks.php.

Referenced by Wikimedia\ParamValidator\SimpleCallbacks\__construct().


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