wiki.techinc.nl/includes/libs/Message/MessageParam.php
Brad Jorsch ce79d607c7 libs/Message: Improve documentation
Among other things, this removed mention of MediaWiki classes from the
library and adds a README.md that attempts to define constraints for
interoperability between libraries producing MessageValues and formatter
implementations that are expected to handle them.

This also renames "TextParam" to "ScalarParam", as that seems a more
accurate name for the class.

Change-Id: I264dd4de394d734a87929cf4740779e7b7d0e04a
2019-08-29 17:04:01 -04:00

38 lines
671 B
PHP

<?php
namespace Wikimedia\Message;
/**
* Value object representing a message parameter that consists of a list of values.
*
* Message parameter classes are pure value objects and are safely newable.
*/
abstract class MessageParam {
protected $type;
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();
}