Класс QUrlQuery

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

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

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

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

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

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

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

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

Он используется для разбора строковых запросов, встречающихся в URL, например:

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

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

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

Кодирование

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

Обработка пробелов и знака плюс ("+")

Веб-браузеры обычно кодируют пробелы, найденные в элементах HTML-формы, в знак плюс ("+") и знаки плюс в их процентно-закодированную форму (%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()

Создаёт объект QUrlQuery без параметров. Параметры можно задать позже, вызвав setQuery() или добавить их с помощью addQueryItem().

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

QUrlQuery::QUrlQuery(const QUrl &url)

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

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

QUrlQuery::QUrlQuery(const QString &queryString)

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

QUrlQuery::QUrlQuery(const QUrlQuery &other)

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

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().

QChar QUrlQuery::defaultQueryPairDelimiter()

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

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

QChar QUrlQuery::defaultQueryValueDelimiter()

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

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

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

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

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

Примечание: Нестандартные разделители следует выбирать среди тех, что 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 = ...) const

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

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

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

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

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

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

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

Перемещающее присваивание other текущему экземпляру QUrlQuery.

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

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

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