From 872194ac1ca5e51fbb9e0e5ba4d27f91aa783e82 Mon Sep 17 00:00:00 2001 From: Ignace Nyamagana Butera Date: Fri, 1 Dec 2017 14:36:42 +0100 Subject: [PATCH] update documentation architecture --- docs/5.0/components/{query-parsers.md => parsers.md} | 9 +++++++-- docs/5.0/components/query.md | 2 +- docs/5.0/functions.md | 8 ++++---- docs/_data/menu.yml | 1 + 4 files changed, 13 insertions(+), 7 deletions(-) rename docs/5.0/components/{query-parsers.md => parsers.md} (95%) diff --git a/docs/5.0/components/query-parsers.md b/docs/5.0/components/parsers.md similarity index 95% rename from docs/5.0/components/query-parsers.md rename to docs/5.0/components/parsers.md index ed0c583c..adff7883 100644 --- a/docs/5.0/components/query-parsers.md +++ b/docs/5.0/components/parsers.md @@ -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. + +

The parsers and their functions alias are defined in the League\Uri namespace.

~~~php 1.5.0:
Query::parse is deprecated and replaced by QueryParser::parse
Query::extract is deprecated and replaced by QueryParser::extract
Query::build is deprecated and replaced by QueryBuilder::build
-Please refers to the Query Parsers documentation page for more informations. +Please refers to the Query Parsers documentation page for more informations.

diff --git a/docs/5.0/functions.md b/docs/5.0/functions.md index c4a1ab43..ae47e4fd 100644 --- a/docs/5.0/functions.md +++ b/docs/5.0/functions.md @@ -94,10 +94,10 @@ Because these functions require different URI packages. Some of them may be miss ### URI components