MediaWiki  master
Wikimedia\ParamValidator\ParamValidator\TypeDef\TitleDef Class Reference

Type definition for page titles. More...

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

Public Member Functions

 __construct (Callbacks $callbacks, TitleFactory $titleFactory)
 
 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()
Stability: 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.
More...
 
 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.

Stability: stable
to override
Parameters
string$nameParameter name being described.
array$settingsParameter settings array.
array$optionsOptions array.
Returns
(MessageValue|null)[]
More...
 
 getParamInfo ( $name, array $settings, array $options)
 Describe parameter settings in a machine-readable format.Keys should be short strings using lowercase ASCII letters. Values should generally be values that could be encoded in JSON or the like.This is intended to handle PARAM constants specific to this class. It generally shouldn't handle constants defined on ParamValidator itself.

Stability: stable
to override
Parameters
string$nameParameter name.
array$settingsParameter settings array.
array$optionsOptions array.
Returns
array
More...
 
 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.
More...
 
 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
More...
 
- Public Member Functions inherited from Wikimedia\ParamValidator\TypeDef
 __construct (Callbacks $callbacks)
 
 getEnumValues ( $name, array $settings, array $options)
 Get the values for enum-like parameters. More...
 
 getValue ( $name, array $settings, array $options)
 Get the value from the request. More...
 
 normalizeSettings (array $settings)
 Normalize a settings array. More...
 

Public Attributes

const PARAM_MUST_EXIST = 'param-must-exist'
 (bool) Whether the page with the given title needs to exist. More...
 
const PARAM_RETURN_OBJECT = 'param-return-object'
 (bool) Whether to return a LinkTarget. More...
 

Private Attributes

TitleFactory $titleFactory
 

Additional Inherited Members

- 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...
 
- Protected Attributes inherited from Wikimedia\ParamValidator\TypeDef
Callbacks $callbacks
 

Detailed Description

Type definition for page titles.

Failure codes:

  • 'badtitle': invalid title (e.g. containing disallowed characters). No data.
  • 'missingtitle': the page with this title does not exist (when PARAM_MUST_EXIST was specified). No data.
Since
1.36

Definition at line 22 of file TitleDef.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\ParamValidator\ParamValidator\TypeDef\TitleDef::__construct ( Callbacks  $callbacks,
TitleFactory  $titleFactory 
)
Parameters
Callbacks$callbacks
TitleFactory$titleFactory

Definition at line 50 of file TitleDef.php.

References Wikimedia\ParamValidator\TypeDef\$callbacks, and Wikimedia\ParamValidator\ParamValidator\TypeDef\TitleDef\$titleFactory.

Member Function Documentation

◆ checkSettings()

Wikimedia\ParamValidator\ParamValidator\TypeDef\TitleDef::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()
Stability: 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 87 of file TitleDef.php.

References Wikimedia\ParamValidator\ParamValidator\PARAM_ISMULTI, Wikimedia\ParamValidator\ParamValidator\PARAM_ISMULTI_LIMIT1, Wikimedia\ParamValidator\ParamValidator\PARAM_ISMULTI_LIMIT2, Wikimedia\ParamValidator\ParamValidator\TypeDef\TitleDef\PARAM_MUST_EXIST, and Wikimedia\ParamValidator\ParamValidator\TypeDef\TitleDef\PARAM_RETURN_OBJECT.

◆ getHelpInfo()

Wikimedia\ParamValidator\ParamValidator\TypeDef\TitleDef::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.

Stability: 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 130 of file TitleDef.php.

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

◆ getParamInfo()

Wikimedia\ParamValidator\ParamValidator\TypeDef\TitleDef::getParamInfo (   $name,
array  $settings,
array  $options 
)

Describe parameter settings in a machine-readable format.Keys should be short strings using lowercase ASCII letters. Values should generally be values that could be encoded in JSON or the like.This is intended to handle PARAM constants specific to this class. It generally shouldn't handle constants defined on ParamValidator itself.

Stability: stable
to override
Parameters
string$nameParameter name.
array$settingsParameter settings array.
array$optionsOptions array.
Returns
array

Reimplemented from Wikimedia\ParamValidator\TypeDef.

Definition at line 121 of file TitleDef.php.

◆ stringifyValue()

Wikimedia\ParamValidator\ParamValidator\TypeDef\TitleDef::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 79 of file TitleDef.php.

◆ validate()

Wikimedia\ParamValidator\ParamValidator\TypeDef\TitleDef::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

Returns
string|LinkTarget Depending on the PARAM_RETURN_OBJECT setting.

Reimplemented from Wikimedia\ParamValidator\TypeDef.

Definition at line 59 of file TitleDef.php.

References $title, and Wikimedia\ParamValidator\TypeDef\failure().

Member Data Documentation

◆ $titleFactory

TitleFactory Wikimedia\ParamValidator\ParamValidator::TypeDef\TitleDef::$titleFactory
private

◆ PARAM_MUST_EXIST

const Wikimedia\ParamValidator\ParamValidator::TypeDef\TitleDef::PARAM_MUST_EXIST = 'param-must-exist'

(bool) Whether the page with the given title needs to exist.

Defaults to false.

Definition at line 29 of file TitleDef.php.

Referenced by Wikimedia\ParamValidator\ParamValidator\TypeDef\TitleDef\checkSettings(), and Wikimedia\ParamValidator\ParamValidator\TypeDef\TitleDef\getHelpInfo().

◆ PARAM_RETURN_OBJECT

const Wikimedia\ParamValidator\ParamValidator::TypeDef\TitleDef::PARAM_RETURN_OBJECT = 'param-return-object'

(bool) Whether to return a LinkTarget.

If false, the validated title is returned as a string (in getPrefixedText() format). Default is false.

Avoid setting true with PARAM_ISMULTI, as it may result in excessive DB lookups. If you do combine them, consider setting low values for PARAM_ISMULTI_LIMIT1 and PARAM_ISMULTI_LIMIT2 to mitigate it.

Definition at line 41 of file TitleDef.php.

Referenced by Wikimedia\ParamValidator\ParamValidator\TypeDef\TitleDef\checkSettings().


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