da63db52af
Add doc-typehints to class properties found by the PropertyDocumentation sniff to improve the documentation. Once the sniff is enabled it avoids that new code is missing type declarations. This is focused on documentation and does not change code. Change-Id: I46f46f1855ca32c89a276b06f4e2051ff541886e
45 lines
869 B
PHP
45 lines
869 B
PHP
<?php
|
|
|
|
namespace Wikimedia\Message;
|
|
|
|
use MediaWiki\Json\JsonDeserializable;
|
|
use MediaWiki\Json\JsonDeserializableTrait;
|
|
|
|
/**
|
|
* Value object representing a message parameter that consists of a list of values.
|
|
*
|
|
* Message parameter classes are pure value objects and are newable and (de)serializable.
|
|
*/
|
|
abstract class MessageParam implements JsonDeserializable {
|
|
use JsonDeserializableTrait;
|
|
|
|
/** @var string */
|
|
protected $type;
|
|
/** @var mixed */
|
|
protected $value;
|
|
|
|
/**
|
|
* Get the type of the parameter.
|
|
*
|
|
* @return string One of the ParamType constants
|
|
*/
|
|
public function getType() {
|
|
return $this->type;
|
|
}
|
|
|
|
/**
|
|
* Get the input value of the parameter
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function getValue() {
|
|
return $this->value;
|
|
}
|
|
|
|
/**
|
|
* Dump the object for testing/debugging
|
|
*
|
|
* @return string
|
|
*/
|
|
abstract public function dump();
|
|
}
|