<?php

class Params {

  /**
   * Список строк
   */
  const TYPE_LIST_STRING = 'strlist';

  /**
   * Список целочисленных значений.
   * Минимальное допустимое значение - 0.
   */
  const TYPE_LIST_POSITIVE = 'positivelist';

  /**
   * Список целочисленных значений.
   */
  const TYPE_LIST_INT = 'intlist';

  /**
   * Список слов.
   */
  const TYPE_LIST_WORD = 'wordlist';

  /**
   * Тип boolean.
   * Если значение передано, то вернет true. Иначе false.
   */
  const TYPE_BOOL = 'bool';

  /**
   * Тип строка
   */
  const TYPE_STRING = 'str';

  /**
   * String type
   */
  const TYPE_STRING_UTF = 'str_utf';

  /**
   * String type
   */
  const TYPE_TEXT = 'text';

  /**
   * Целое число.
   * Если передан параметр и его значение не число (проверка через is_numeric), то возвращается ошибка.
   * Возвращает только целое значение из параметра (intval).
   *
   * @see Params::TYPE_INT_SAFE
   */
  const TYPE_INT = 'int';

  /**
   * Целое число.
   * Если передан параметр и его значение не целое число (проверка через safeCleanInt), то возвращается ошибка.
   */
  const TYPE_INT_SAFE = 'safe_int';

  /**
   * Число с плавающей точкой.
   * Если передан параметр и его значение не число (проверка через is_numeric), то возвращается ошибка.
   */
  const TYPE_FLOAT = 'float';

  /**
   * Целое число.
   * Если передан параметр и его значение не число (проверка через is_numeric), то возвращается ошибка.
   * Если передано значение < 0, то возвращается ошибка.
   * Возвращает только целое значение из параметра (intval).
   *
   * @see Params::TYPE_INT_SAFE
   */
  const TYPE_POSITIVE = 'positive';

  const TYPE_JSON_UNSAFE = 'unsafe_json';

  const TYPE_JSON = 'json';

  const TYPE_JSON_SAFE = 'safe_json';

  /**
   * Параметр являтся объязательным
   */
  const REQUIRED = 'required';

  /**
   * Параметр являтся объязательным
   */
  const REQUIRED_SAFE = 'safe_required';

  /**
   * Значение параметра по-умолчанию
   */
  const VALUE_DEFAULT = 'def';

  /**
   * Значение параметра по-умолчанию
   */
  const VALUE_DEFAULT_SAFE = 'safe_def';

  /**
   * Минимальное значение числового параметра.
   * Если параметр не передан, то значение параметра по-умолчанию 0.
   * @see Params::INT_MINIMUM_SAFE
   */
  const INT_MINIMUM = 'min';

  /**
   * Минимальное значение числового параметра.
   * Проверяется только, если параметр передан.
   */
  const INT_MINIMUM_SAFE = 'safe_min';

  /**
   * Максимальное значение числового параметра.
   * Если параметр не передан, то значение параметра по-умолчанию 0.
   * @see Params::INT_MAXIMUM_SAFE
   */
  const INT_MAXIMUM = 'max';

  /**
   * Максимальное значение числового параметра.
   * Проверяется только, если параметр передан.
   */
  const INT_MAXIMUM_SAFE = 'safe_max';

  /**
   * Максимальное кол-во элементов в списке.
   */
  const LIST_MAXIMUM_SIZE = 'maxnum';

  /**
   * Минимальное кол-во элементов в списке.
   */
  const LIST_MINIMUM_SIZE = 'minnum';

  const STRING_MAXIMUM_LENGTH = 'maxlen';

  const STRING_MINIMUM_LENGTH = 'minlen';

  const STRING_MAXIMUM_LENGTH_SAFE = 'safe_maxlen';

  const STRING_MINIMUM_LENGTH_SAFE = 'safe_minlen';

  const VERSION_FROM = 'from_version';

  const VERSION_DEPRECATED_FROM = 'deprecated_from';

  const ALIAS = 'alias';

  const ALIAS4 = 'alias4';

  const NEW_LINES = 'newlines';

  const MAX_LIST = 'maxlist';

  const SLICE = 'slice';

  /**
   * Список допустимых значений для параметра.
   * Если параметр не передан и пустого значения нет в списке допустимых, то будет ошибка.
   * @see Params::ALLOWED_SAFE
   */
  const ALLOWED = 'allowed';

  /**
   * Список допустимых значений для параметра.
   * Проверяется только, если параметр передан.
   */
  const ALLOWED_SAFE = 'safe_allowed';

  /**
   * Parameter is hidden in documentation
   */
  const NO_DOCUMENTATION = 'nodoc';

  const IS_DEV_REQUEST = '_dev';

  const ID_SAFE = 'safe_id';

  const ID_LONG_SAFE = 'safe_id_long';

  const IDS_LONG_SAFE = 'safe_ids_long';

  const UNSAFE = 'unsafe';

  const OID = 'oid';

  const PEER = 'peer';
}