Skip to content

Commit

Permalink
Merge pull request #8890 from obozdag/patch-5
Browse files Browse the repository at this point in the history
docs: Some typos and modifications in libraries/uri.rst
  • Loading branch information
kenjis authored May 16, 2024
2 parents 90659c8 + cbc33f4 commit 05b3f4f
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions user_guide_src/source/libraries/uri.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ Since v4.4.0, if you don't pass a URL, it returns the current URI:
The Current URI
---------------

Many times, all you really want is an object representing the current URL of this request.
You can use the :php:func:`current_url()` function available in the :doc:`../helpers/url_helper`:
When you need an object representing the current URL of the request,
you can use the :php:func:`current_url()` function available in the :doc:`../helpers/url_helper`:

.. literalinclude:: uri/004.php
:lines: 2-
Expand Down Expand Up @@ -141,12 +141,12 @@ When using the ``setPort()`` method, the port will be checked that it is within
Path
----

The path are all of the segments within the site itself. As expected, the ``getPath()`` and ``setPath()`` methods
The path is all of the segments within the site itself. As expected, the ``getPath()`` and ``setPath()`` methods
can be used to manipulate it:

.. literalinclude:: uri/016.php

.. note:: When setting the path this way, or any other way the class allows, it is sanitized to encode any dangerous
.. note:: When setting the path it is sanitized to encode any dangerous
characters, and remove dot segments for safety.

.. note:: Since v4.4.0, the ``SiteURI::getRoutePath()`` method,
Expand All @@ -166,7 +166,7 @@ be set as a string currently.

.. literalinclude:: uri/017.php

The ``setQuery()`` method overwrite any existing query variables.
The ``setQuery()`` method overwrites existing query variables.

.. note:: Query values cannot contain fragments. An InvalidArgumentException will be thrown if it does.

Expand All @@ -177,7 +177,7 @@ You can set query values using an array:

.. literalinclude:: uri/018.php

The ``setQueryArray()`` method overwrite any existing query variables.
The ``setQueryArray()`` method overwrites existing query variables.

Adding Query Value
^^^^^^^^^^^^^^^^^^
Expand All @@ -196,11 +196,12 @@ You can filter the query values returned by passing an options array to the ``ge

.. literalinclude:: uri/020.php

This only changes the values returned during this one call. If you need to modify the URI's query values more permanently,
This only changes the values returned during this one call.

Changing Query Values
^^^^^^^^^^^^^^^^^^^^^

If you need to modify the URI's query values more permanently,
you can use the ``stripQuery()`` and ``keepQuery()`` methods to change the actual object's query variable collection:

.. literalinclude:: uri/021.php
Expand Down

0 comments on commit 05b3f4f

Please sign in to comment.