Skip to content

Commit

Permalink
update documentation architecture
Browse files Browse the repository at this point in the history
  • Loading branch information
nyamsprod committed Dec 1, 2017
1 parent f1e4470 commit 872194a
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,15 @@ layout: default
title: The Query component
---

Query Parsers
Parsers
=======

The library provides two classes `QueryParser` and `QueryBuilder` to ease query string creation and conversion.
The library provides the following classes to ease components parsing:

- `QueryParser` to parse and deserialize a query string.
- `QueryBuilder` to build a query string from a collection of key/value pairs.

<p class="message-notice">The parsers and their functions alias are defined in the <code>League\Uri</code> namespace.</p>

~~~php
<?php
Expand Down
2 changes: 1 addition & 1 deletion docs/5.0/components/query.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Since version <code>1.5.0</code>:<br>
<code>Query::parse</code> is deprecated and replaced by <code>QueryParser::parse</code><br>
<code>Query::extract</code> is deprecated and replaced by <code>QueryParser::extract</code><br>
<code>Query::build</code> is deprecated and replaced by <code>QueryBuilder::build</code><br>
Please refers to the <a href="/5.0/components/query-parsers">Query Parsers</a> documentation page for more informations.
Please refers to the <a href="/5.0/components/parsers">Query Parsers</a> documentation page for more informations.
</p>


Expand Down
8 changes: 4 additions & 4 deletions docs/5.0/functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,10 +94,10 @@ Because these functions require different URI packages. Some of them may be miss
### URI components

<ul class="item-list">
<li><a href="/5.0/components/query-parsers/#queryparserparse">parse_query</a></li>
<li><a href="/5.0/components/query-parsers/#queryparserextract">extract_query</a></li>
<li><a href="/5.0/components/query-parsers/#querybuilderbuild">build_query</a></li>
<li><a href="/5.0/components/query-parsers/#queryparserconvert">pairs_to_params</a></li>
<li><a href="/5.0/components/parsers/#queryparserparse">parse_query</a></li>
<li><a href="/5.0/components/parsers/#queryparserextract">extract_query</a></li>
<li><a href="/5.0/components/parsers/#querybuilderbuild">build_query</a></li>
<li><a href="/5.0/components/parsers/#queryparserconvert">pairs_to_params</a></li>
<li><a href="/5.0/parser/parser/#scheme-validation">is_scheme</a></li>
<li><a href="/5.0/parser/parser/#host-validation">is_host</a></li>
<li><a href="/5.0/parser/parser/#port-validation">is_port</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/_data/menu.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ version:
Uri components:
Overview: '/5.0/components/'
Installation: '/5.0/components/installation/'
Parsers: '/5.0/components/parsers/'
API: '/5.0/components/api/'
Scheme: '/5.0/components/scheme/'
UserInfo: '/5.0/components/userinfo/'
Expand Down

0 comments on commit 872194a

Please sign in to comment.