Page MenuHomeWickedGov Phorge
Files F1426653

ParamType.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

ParamType.php
View Options

<?php
namespace Wikimedia\Message;
/**
* The constants used to specify parameter types. The values of the constants
* are an unstable implementation detail.
*
* Unless otherwise noted, these should be used with an instance of ScalarParam.
*/
class ParamType {
/** A simple text string or another MessageValue, not otherwise formatted. */
public const TEXT = 'text';
/** A number, to be formatted using local digits and separators */
public const NUM = 'num';
/**
* A number of seconds, to be formatted as natural language text.
* The value will be output exactly.
*/
public const DURATION_LONG = 'duration';
/**
* A number of seconds, to be formatted as natural language text in an abbreviated way.
* The output will be rounded to an appropriate magnitude.
*/
public const DURATION_SHORT = 'period';
/**
* An expiry time.
*
* The input is either a timestamp in one of the formats accepted by the
* Wikimedia\Timestamp library, or "infinity" if the thing doesn't expire.
*
* The output is a date and time in local format, or a string representing
* an "infinite" expiry.
*/
public const EXPIRY = 'expiry';
/**
* A date time in one of the formats accepted by the Wikimedia\Timestamp library.
*
* The output is a date and time in local format.
*/
public const DATETIME = 'datetime';
/**
* A date in one of the formats accepted by the Wikimedia\Timestamp library.
*
* The output is a date in local format.
*/
public const DATE = 'date';
/**
* A time in one of the formats accepted by the Wikimedia\Timestamp library.
*
* The output is a time in local format.
*/
public const TIME = 'time';
/**
* User Group
* @since 1.38
*/
public const GROUP = 'group';
/**
* For arbitrary stringable objects
* @since 1.38
* @deprecated since 1.43
*/
public const OBJECT = 'object';
/** A number of bytes. The output will be rounded to an appropriate magnitude. */
public const SIZE = 'size';
/** A number of bits per second. The output will be rounded to an appropriate magnitude. */
public const BITRATE = 'bitrate';
/** A list of values. Must be used with ListParam. */
public const LIST = 'list';
/**
* A text parameter which is substituted after formatter processing.
*
* The creator of the parameter and message is responsible for ensuring
* that the value will be safe for the intended output format, and
* documenting what that intended output format is.
*/
public const RAW = 'raw';
/**
* A text parameter which is substituted after formatter processing.
* The output will be escaped as appropriate for the output format so
* as to represent plain text rather than any sort of markup.
*/
public const PLAINTEXT = 'plaintext';
public static function cases(): array {
return [
self::TEXT,
self::NUM,
self::DURATION_LONG,
self::DURATION_SHORT,
self::EXPIRY,
self::DATETIME,
self::DATE,
self::TIME,
self::GROUP,
self::OBJECT,
self::SIZE,
self::BITRATE,
self::LIST,
self::RAW,
self::PLAINTEXT,
];
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, May 16, 13:31 (1 d, 19 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
1e/2b/d2fd010c09ef760cec50a75ba88d
Default Alt Text
ParamType.php (3 KB)

Event Timeline