includes/libs/Message/ParamType.php

   1 <?php
   2
   3 namespace Wikimedia\Message;
   4
   5 /**
   6  * The constants used to specify parameter types. The values of the constants
   7  * are an unstable implementation detail, and correspond to the names of the
   8  * parameter types in the Message class.
   9  */
  10 class ParamType {
  11         /** A simple text parameter */
  12         const TEXT = 'text';
  13
  14         /** A number, to be formatted using local digits and separators */
  15         const NUM = 'num';
  16
  17         /** A number of seconds, to be formatted as natural language text. */
  18         const DURATION_LONG = 'duration';
  19
  20         /** A number of seconds, to be formatted in an abbreviated way. */
  21         const DURATION_SHORT = 'timeperiod';
  22
  23         /**
  24          * An expiry time for a block. The input is either a timestamp in one
  25          * of the formats accepted by the Wikimedia\Timestamp library, or
  26          * "infinity" for an infinite block.
  27          */
  28         const EXPIRY = 'expiry';
  29
  30         /** A number of bytes. */
  31         const SIZE = 'size';
  32
  33         /** A number of bits per second. */
  34         const BITRATE = 'bitrate';
  35
  36         /** The list type (ListParam) */
  37         const LIST = 'list';
  38
  39         /**
  40          * A text parameter which is substituted after preprocessing, and so is
  41          * not available to the preprocessor and cannot be modified by it.
  42          */
  43         const RAW = 'raw';
  44
  45         /** Reserved for future use. */
  46         const PLAINTEXT = 'plaintext';
  47 }