Класс 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 формы, QUrlQuery также никогда не декодирует последовательность «%2B» в знак плюс ни не кодирует знак плюс. Фактически, все последовательности «%2B» или «+», обнаруженные в ключах, значениях или строке запроса, оставляются точно так, как они написаны (за исключением преобразования «%2b» в «%2B» к верхнему регистру).

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

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

Этот режим форматирования следует использовать только при работе с текстом, представленным пользователю в контекстах, где процентное кодирование нежелательно. Обратите внимание, что методы установки и получения запроса QUrlQuery не поддерживают соответствующий режим парсинга 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. Этот метод не перезаписывает существующие элементы с тем же ключом.

См. также 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()

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

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

[static] char16_t QUrlQuery::defaultQueryValueDelimiter()

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

См. также 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() и Кодирование.

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

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

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

См. также addQueryItem(), allQueryItemValues() и Кодирование.

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

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

См. также setQueryItems() и Кодирование.

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)

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

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

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

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

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

См. также 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 содержат одинаковое содержимое в том же порядке и используют те же разделители запроса.