Spec-Zone.ru › Hammerspoon

hs.httpserver.hsminweb.cgilua.urlcode

Функции поддержки модуля совместимости CGILua для кодирования и декодирования компонентов URL в соответствии с RFC 3986.

Обзор API

  • Функции — API-вызовы, предлагаемые непосредственно расширением
    • encodetable
    • escape
    • insertfield
    • parsequery
    • unescape

Документация API

Функции

encodetable
Подпись hs.httpserver.hsminweb.cgilua.urlcode.encodetable(table) -> string
Тип Функция
Описание

Кодирует таблицу пар ключ-значение в строку запроса, подходящую для включения в URL.

Параметры
  • table — таблица пар ключ-значение, которая должна быть преобразована в строку запроса
Возвращает
  • строка запроса, как указано в RFC 3986.
Примечания
  • строка будет иметь вид: «ключ1=значение1&ключ2=значение2…», где все ключи и значения должным образом закодированы с помощью cgilua.urlcode.escape. Если вы создаёте URL вручную, результат этой функции следует добавить в конец URL после символа «?» для указания начала строки запроса.
Источник extensions/httpserver/cgilua_compatibility_functions.lua строка 462
escape
Подпись hs.httpserver.hsminweb.cgilua.urlcode.escape(string) -> string
Тип Функция
Описание

Кодирует URL предоставленную строку, делая её безопасной в качестве компонента URL.

Параметры
  • строка — строка, которую нужно закодировать
Возвращает
  • строка с символами, не являющимися буквенно-цифровыми, закодированными в процентах, а пробелами, преобразованными в «+» в соответствии с RFC 3986.
Примечания
  • эта функция предполагает, что предоставленная строка является одним компонентом и кодирует URL все символы, не являющиеся буквенно-цифровыми. Не используйте эту функцию для создания строки запроса URL — используйте cgilua.urlcode.encodetable.
Источник extensions/httpserver/cgilua_compatibility_functions.lua строка 432
insertfield
Подпись hs.httpserver.hsminweb.cgilua.urlcode.insertfield(table, key, value) -> none
Тип Функция
Описание

Вставляет указанный ключ и значение в таблицу пар ключ-значение.

Параметры
  • table — таблица аргументов, которая строится
  • ключ — имя ключа
  • значение — значение, которое нужно присвоить указанному ключу
Возвращает
  • Ничего
Примечания
  • Если ключ уже существует в таблице, его значение преобразуется в таблицу (если это не таблица) и новое значение добавляется в конец массива значений для ключа.
  • Эта функция используется внутри cgilua.urlcode.parsequery, или может быть использована для подготовки таблицы пар ключ-значение для cgilua.urlcode.encodetable.
Источник extensions/httpserver/cgilua_compatibility_functions.lua строка 486
parsequery
Подпись hs.httpserver.hsminweb.cgilua.urlcode.parsequery(query, table) -> none
Тип Функция
Описание

Разбирает строку запроса и сохраняет пары ключ-значение в предоставленной таблице.

Параметры
  • запрос — закодированная по URL строка запроса, либо из URL, либо из тела POST-запроса, закодированного в формате «x-www-form-urlencoded».
  • table — таблица, в которую добавляются пары ключ-значение
Возвращает
  • Ничего
Примечания
  • Спецификация допускает, чтобы одному ключу были назначены несколько значений в закодированной строке, но не определяет поведение; по соглашению, веб-серверы назначают эти несколько значений одному ключу в массиве (таблице). Эта функция следует этому соглашению. Это наиболее часто используется формами, которые позволяют выбирать несколько вариантов с помощью флажков или в списке выбора.
  • Эта функция использует cgilua.urlcode.insertfield для построения таблицы ключ-значение.
Источник extensions/httpserver/cgilua_compatibility_functions.lua строка 517
unescape
Подпись hs.httpserver.hsminweb.cgilua.urlcode.unescape(string) -> string
Тип Функция
Описание

Удаляет любое кодирование URL в предоставленной строке.

Параметры
  • строка — строка, которую нужно декодировать
Возвращает
  • строка со всеми символами «+» преобразованными в пробелы и все закодированные в процентах последовательности, преобразованными в их эквиваленты ASCII.
Источник extensions/httpserver/cgilua_compatibility_functions.lua строка 448

© 2014–2017 Hammerspoon contributors
Licensed under the MIT License.
https://www.hammerspoon.org/docs/hs.httpserver.hsminweb.cgilua.urlcode.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API