diff options
| author | daniel <dkinzler@wikimedia.org> | 2020-06-26 14:56:03 +0200 |
|---|---|---|
| committer | daniel <dkinzler@wikimedia.org> | 2020-07-07 15:38:57 +0200 |
| commit | bd5c3d06a276e5f227cafa094a821079086ab297 (patch) | |
| tree | 0664c4090a8a59dc02b0b543b9dbfdfc26bc5b2c /includes/libs/Message | |
| parent | 804abf07f36bf7397fd56dbc5a9ba5837ce48dfc (diff) | |
| download | mediawikicore-bd5c3d06a276e5f227cafa094a821079086ab297.tar.gz mediawikicore-bd5c3d06a276e5f227cafa094a821079086ab297.zip | |
Annotate newable classes
This annotates classes that can safely be instantiated by
extensions, per the Stable Interface Policy.
Bug: T247862
Change-Id: Ia280f559874fc0750265ddeb7f831e65fd7d7d6a
Diffstat (limited to 'includes/libs/Message')
| -rw-r--r-- | includes/libs/Message/DataMessageValue.php | 4 | ||||
| -rw-r--r-- | includes/libs/Message/ListParam.php | 4 | ||||
| -rw-r--r-- | includes/libs/Message/MessageValue.php | 4 | ||||
| -rw-r--r-- | includes/libs/Message/ScalarParam.php | 4 |
4 files changed, 16 insertions, 0 deletions
diff --git a/includes/libs/Message/DataMessageValue.php b/includes/libs/Message/DataMessageValue.php index 686b2ed4bfd9..4bec3ad5893b 100644 --- a/includes/libs/Message/DataMessageValue.php +++ b/includes/libs/Message/DataMessageValue.php @@ -17,6 +17,8 @@ namespace Wikimedia\Message; * `[ 0 => new ScalarParam( ParamType::TEXT, 1 ), 1 => new ScalarParam( ParamType::TEXT, 10 ) ]`. * * DataMessageValues are pure value objects and are safely newable. + * + * @newable */ class DataMessageValue extends MessageValue { /** @var string */ @@ -26,6 +28,8 @@ class DataMessageValue extends MessageValue { private $data; /** + * @stable for calling + * * @param string $key * @param (MessageParam|MessageValue|string|int|float)[] $params * @param string|null $code String representing the concept behind diff --git a/includes/libs/Message/ListParam.php b/includes/libs/Message/ListParam.php index 7f7d19865ac2..68f4489e9970 100644 --- a/includes/libs/Message/ListParam.php +++ b/includes/libs/Message/ListParam.php @@ -6,11 +6,15 @@ 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. + * + * @newable */ class ListParam extends MessageParam { private $listType; /** + * @stable for calling. + * * @param string $listType One of the ListType constants. * @param (MessageParam|MessageValue|string|int|float)[] $elements Values in the list. * Values that are not instances of MessageParam are wrapped using ParamType::TEXT. diff --git a/includes/libs/Message/MessageValue.php b/includes/libs/Message/MessageValue.php index 78e3c22cb463..746dbb2e1474 100644 --- a/includes/libs/Message/MessageValue.php +++ b/includes/libs/Message/MessageValue.php @@ -10,6 +10,8 @@ namespace Wikimedia\Message; * IMessageFormatterFactory. * * MessageValues are pure value objects and are safely newable. + * + * @newable */ class MessageValue { /** @var string */ @@ -19,6 +21,8 @@ class MessageValue { private $params; /** + * @stable for calling + * * @param string $key * @param (MessageParam|MessageValue|string|int|float)[] $params Values that are not instances * of MessageParam are wrapped using ParamType::TEXT. diff --git a/includes/libs/Message/ScalarParam.php b/includes/libs/Message/ScalarParam.php index ea4c9a02019a..7484561beaaa 100644 --- a/includes/libs/Message/ScalarParam.php +++ b/includes/libs/Message/ScalarParam.php @@ -6,11 +6,15 @@ namespace Wikimedia\Message; * Value object representing a message parameter holding a single value. * * Message parameter classes are pure value objects and are safely newable. + * + * @newable */ class ScalarParam extends MessageParam { /** * Construct a text parameter * + * @stable for calling. + * * @param string $type One of the ParamType constants. * @param string|int|float|MessageValue $value */ |