Класс QUrlQuery

Класс QUrlQuery предоставляет способ работы с парами «ключ-значение» в запросе URL. Подробнее...

• Список всех членов, включая унаследованные

Примечание: Все функции в этом классе являются многопоточными.

Открытые функции

Статические открытые члены

Связанные нечлены

Подробное описание

Используется для анализа строк запроса, найденных в URL, например:

Строки запроса, подобные вышеприведённым, используются для передачи параметров в URL и обычно декодируются в несколько пар «ключ-значение». Приведённый выше пример содержит два элемента в списке с ключами «type» и «color». QUrlQuery также может использоваться для создания строки запроса, подходящей для использования в QUrl::setQuery() из отдельных компонентов запроса.

Наиболее распространённый способ анализа строки запроса — инициализация в конструкторе путём передачи строки запроса. В противном случае можно использовать метод setQuery() для установки запроса, подлежащего анализу. Этот метод также можно использовать для анализа запроса с нестандартными разделителями после их установки с помощью функции setQueryDelimiters().

Кодированная строка запроса может быть получена снова с помощью query(). Это приведёт к кодированию всех хранящихся элементов с помощью разделителей.

Кодирование

Все методы-получатели в QUrlQuery поддерживают необязательный параметр типа QUrl::ComponentFormattingOptions, в том числе query(), которые определяют способ кодирования данных. За исключением QUrl::FullyDecoded, возвращаемое значение всё ещё должно рассматриваться как процентно-кодированная строка, поскольку существуют определённые значения, которые нельзя выразить в декодированной форме (например, управляющие символы, последовательности байтов, не декодируемые в UTF-8). По этой причине символ процента всегда представлен строкой «%25».

Обработка пробелов и знака «+»

Веб-браузеры обычно кодируют пробелы, найденные в элементах HTML FORM, в знак «+», а знаки «+» — в их процентно-кодированную форму (%2B). Однако спецификации Интернета, регулирующие URL, не считают пробелы и знак «+» эквивалентными.

По этой причине QUrlQuery никогда не кодирует пробел в «+» и никогда не декодирует «+» в пробел. Вместо этого пробелы будут отображаться как «%20» в закодированной форме.

Для поддержки кодирования, подобного кодированию элементов HTML form, QUrlQuery также никогда не декодирует последовательность «%2B» в знак «+», а также никогда не кодирует знак «+». Фактически, любые последовательности «%2B» или «+», найденные в ключах, значениях или строке запроса, остаются неизменными (за исключением преобразования «%2b» в «%2B» к верхнему регистру).

Полное декодирование

В формате QUrl::FullyDecoded все процентно-кодированные последовательности полностью декодируются, а символ «%» используется для представления самого себя. QUrl::FullyDecoded следует использовать с осторожностью, так как это может привести к потере данных. См. документацию по QUrl::FullyDecoded для получения информации о возможной потере данных.

Этот режим форматирования следует использовать только при работе с текстом, отображаемым пользователю в контекстах, где процентное кодирование нежелательно. Обратите внимание, что установщики QUrlQuery и методы query не поддерживают эквивалентный режим разбора QUrl::DecodedMode, поэтому использование QUrl::FullyDecoded для получения списка ключей может привести к тому, что ключи не будут найдены в объекте.

Нестандартные разделители

По умолчанию QUrlQuery использует знак равенства («=») для разделения ключа и его значения и амперсанд («&») для разделения пар «ключ-значение» друг от друга. Можно изменить разделители, которые QUrlQuery использует для анализа и реконструирования запроса, вызвав setQueryDelimiters().

Нестандартные разделители должны выбираться из числа так называемых «подразделителей» в RFC 3986. Это:

sub-delims    = "!" / "$" / "&" / "'" / "(" / ")"
              / "*" / "+" / "," / ";" / "="

Использование других символов не поддерживается и может привести к неожиданному поведению. QUrlQuery не проверяет, что вы передали корректный разделитель.

См. также QUrl.

Документация по функциям-членам

QUrlQuery::QUrlQuery(const QUrlQuery &other)

Копирует содержимое объекта QUrlQuery other, включая разделители запроса.

[since 5.13] QUrlQuery::QUrlQuery(std::initializer_list<QPair<QString, QString> > list)

Создаёт объект QUrlQuery из списка пар ключ/значение list.

Эта функция была добавлена в Qt 5.13.

QUrlQuery::QUrlQuery(const QString &queryString)

Создаёт объект QUrlQuery и анализирует строку запроса queryString, используя стандартные разделители. Чтобы проанализировать строку запроса с другими разделителями, необходимо сначала установить их, используя setQueryDelimiters(), а затем задать сам запрос с помощью setQuery().

QUrlQuery::QUrlQuery(const QUrl &url)

Создаёт объект QUrlQuery и анализирует строку запроса, найденную в URL url, используя стандартные разделители. Чтобы проанализировать строку запроса с другими разделителями, необходимо сначала установить их, используя setQueryDelimiters(), а затем задать сам запрос с помощью setQuery().

См. также QUrl::query().

QUrlQuery::QUrlQuery()

Создаёт пустой объект QUrlQuery. Запрос может быть задан позднее, вызвав setQuery(), или элементы могут быть добавлены, используя addQueryItem().

См. также setQuery() и addQueryItem().

[since 5.2] QUrlQuery &QUrlQuery::operator=(QUrlQuery &&other)

Перемещает other в данный экземпляр QUrlQuery.

Эта функция была добавлена в Qt 5.2.

QUrlQuery &QUrlQuery::operator=(const QUrlQuery &other)

Копирует содержимое объекта other QUrlQuery, включая разделители запроса.

QUrlQuery::~QUrlQuery()

Уничтожает объект QUrlQuery.

void QUrlQuery::addQueryItem(const QString &key, const QString &value)

Добавляет пару key = value в конец строки запроса URL. Этот метод не перезаписывает существующие элементы с тем же ключом.

Примечание: Этот метод не считает пробелы (ASCII 0x20) и знаки "+" одинаковыми, как это делают HTML-формы. Если вам нужны пробелы, представленные как знаки "+", используйте фактические знаки "+".

См. также hasQueryItem() и queryItemValue().

QStringList QUrlQuery::allQueryItemValues(const QString &key, QUrl::ComponentFormattingOptions encoding = QUrl::PrettyDecoded) const

Возвращает список значений строки запроса, ключ которых равен key из URL, используя параметры кодирования, указанные в encoding для кодирования возвращаемого значения. Если ключ key не найден, эта функция возвращает пустой список.

См. также queryItemValue() и addQueryItem().

void QUrlQuery::clear()

Очищает объект QUrlQuery, удаляя все пары ключ-значение, которые в нём хранятся. Если разделители запроса были изменены, эта функция сохранит их изменённые значения.

См. также isEmpty() и setQueryDelimiters().

[static] char16_t QUrlQuery::defaultQueryPairDelimiter()

Возвращает стандартный символ для разделения пар ключ-значение друг от друга: амперсанд ("&").

Примечание: Перед Qt 6 эта функция возвращала QChar.

См. также setQueryDelimiters(), queryPairDelimiter() и defaultQueryValueDelimiter().

[static] char16_t QUrlQuery::defaultQueryValueDelimiter()

Возвращает стандартный символ для разделения ключей и значений в запросе: знак равенства ("=").

Примечание: Перед Qt 6 эта функция возвращала QChar.

См. также setQueryDelimiters(), queryValueDelimiter() и defaultQueryPairDelimiter().

bool QUrlQuery::hasQueryItem(const QString &key) const

Возвращает true , если существует пара строки запроса, ключ которой равен key из URL.

См. также addQueryItem() и queryItemValue().

bool QUrlQuery::isEmpty() const

Возвращает true , если этот объект QUrlQuery не содержит пар ключ-значение, например, после создания по умолчанию или после анализа пустой строки запроса.

См. также setQuery() и clear().

QString QUrlQuery::query(QUrl::ComponentFormattingOptions encoding = QUrl::PrettyDecoded) const

Возвращает воссозданную строку запроса, образованную из пар ключ-значение, которые хранятся в этом объекте QUrlQuery, разделённых разделителями запроса, выбранными для этого объекта. Ключи и значения закодированы с помощью параметров, заданных в параметре encoding.

В этой функции единственным неоднозначным разделителем является символ "#", так как в URL он используется для разделения строки запроса от фрагмента, который может следовать за ней.

Порядок пар ключ-значение в возвращаемой строке точно такой же, как и в исходном запросе.

См. также setQuery(), QUrl::setQuery(), QUrl::fragment() и Encoding.

QString QUrlQuery::queryItemValue(const QString &key, QUrl::ComponentFormattingOptions encoding = QUrl::PrettyDecoded) const

Возвращает значение запроса, связанное с ключом key из URL, используя параметры кодирования, указанные в encoding, для кодирования возвращаемого значения. Если ключ key не найден, эта функция возвращает пустую строку. Если вам нужно различать пустое значение и несуществующий ключ, вы должны сначала проверить существование ключа, используя hasQueryItem().

Если ключ key определён несколько раз, эта функция вернёт первый найденный ключ в порядке их появления в строке запроса или добавления с помощью addQueryItem().

См. также addQueryItem(), allQueryItemValues() и Encoding.

QList<QPair<QString, QString> > QUrlQuery::queryItems(QUrl::ComponentFormattingOptions encoding = QUrl::PrettyDecoded) const

Возвращает строку запроса URL в виде карты ключей и значений, используя параметры кодирования, указанные в encoding, для кодирования элементов. Порядок элементов совпадает с порядком их появления в строке запроса или установленного с помощью setQueryItems().

См. также setQueryItems() и Encoding.

QChar QUrlQuery::queryPairDelimiter() const

Возвращает символ, используемый для разделения пар ключ-значение при восстановлении строки запроса в query() или при анализе в setQuery().

См. также setQueryDelimiters() и queryValueDelimiter().

QChar QUrlQuery::queryValueDelimiter() const

Возвращает символ, используемый для разделения ключей и значений при восстановлении строки запроса в query() или при анализе в setQuery().

См. также setQueryDelimiters() и queryPairDelimiter().

void QUrlQuery::removeAllQueryItems(const QString &key)

Удаляет все пары строки запроса, ключ которых равен key из URL.

См. также removeQueryItem().

void QUrlQuery::removeQueryItem(const QString &key)

Удаляет пару «ключ-значение» строки запроса, ключ которой равен key, из URL. Если существует несколько элементов с ключом, равным key, удаляется первый элемент в порядке их появления в строке запроса или добавления с помощью addQueryItem().

См. также removeAllQueryItems().

void QUrlQuery::setQuery(const QString &queryString)

Парсит строку запроса в queryString и устанавливает внутренние элементы в найденные там значения. Если какие-либо разделители были заданы с помощью setQueryDelimiters(), эта функция будет использовать их вместо стандартных разделителей для разбора строки.

См. также query().

void QUrlQuery::setQueryDelimiters(QChar valueDelimiter, QChar pairDelimiter)

Устанавливает символы, используемые для разграничения между ключами и значениями, а также между парами «ключ-значение» в строке запроса URL. По умолчанию разделитель значений — «=», а разделитель пар — «&».

valueDelimiter будет использоваться для разделения ключей и значений, а pairDelimiter — для разделения пар «ключ-значение». Любые вхождения этих разделителей в закодированном представлении ключей и значений строки запроса будут кодироваться в проценты при возвращении в query().

Если valueDelimiter задан как «(» и pairDelimiter как «)», вышеупомянутая строка запроса будет представлена так:

http://www.example.com/cgi-bin/drawgraph.cgi?type(pie)color(green)

Примечание: Нестандартные разделители следует выбирать среди тех, что RFC 3986 называет «подразделителями». Они следующие:

sub-delims    = "!" / "$" / "&" / "'" / "(" / ")"
              / "*" / "+" / "," / ";" / "="

Использование других символов не поддерживается и может привести к неожиданному поведению. Этот метод не проверяет, что вы передали допустимый разделитель.

См. также queryValueDelimiter() и queryPairDelimiter().

void QUrlQuery::setQueryItems(const QList<QPair<QString, QString> > &query)

Устанавливает элементы в этом объекте QUrlQuery на query. Порядок элементов в query сохраняется.

Примечание: Этот метод не обрабатывает пробелы (ASCII 0x20) и знаки «+» как одинаковые, как это делают формы HTML. Если вам нужны пробелы, представленные как знаки «+», используйте фактические знаки «+».

См. также queryItems() и isEmpty().

void QUrlQuery::swap(QUrlQuery &other)

Меняет местами этот экземпляр запроса URL с other. Эта функция очень быстрая и никогда не терпит неудачу.

QString QUrlQuery::toString(QUrl::ComponentFormattingOptions encoding = QUrl::PrettyDecoded) const

Возвращает этот объект QUrlQuery в виде QString. encoding может использоваться для указания кодировки строки URL возвращаемого значения.

bool QUrlQuery::operator!=(const QUrlQuery &other) const

Возвращает true если other не равно этому объекту QUrlQuery. В противном случае возвращает false.

См. также operator==().

bool QUrlQuery::operator==(const QUrlQuery &other) const

Возвращает true если этот объект и объект other содержат одинаковое содержимое в том же порядке и используют те же разделители запроса.