Skip to content

Commit 1775afb

Browse files
javiereguiluzjaviereguiluz
committed
minor #9846 Added docs for Symfony Polyfill components (javiereguiluz)
This PR was squashed before being merged into the 2.8 branch (closes #9846). Discussion ---------- Added docs for Symfony Polyfill components This fixes #6052 but before completing it, I'd like to ask @wouterj @xabbuh and @nicolas-grekas if you like this proposal or if you expect something different for these components docs. Thanks! Commits ------- 8c04898 Added docs for Symfony Polyfill components
2 parents 35098ee + 8c04898 commit 1775afb

14 files changed

+666
-0
lines changed

‎components/polyfill_apcu.rst‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
.. index::
2+
single: Polyfill
3+
single: APC
4+
single: Components; Polyfill
5+
6+
The Symfony Polyfill / APCu Component
7+
=====================================
8+
9+
This component provides ``apcu_*`` functions and the ``APCUIterator`` class
10+
to users of the legacy APC extension.
11+
12+
Installation
13+
------------
14+
15+
.. code-block:: terminal
16+
17+
$ composer require symfony/polyfill-apcu
18+
19+
Alternatively, you can clone the `<https://github.com/symfony/polyfill-apcu>`_ repository.
20+
21+
.. include:: /components/require_autoload.rst.inc
22+
23+
Usage
24+
-----
25+
26+
Once this component is installed in your application, you can use the following
27+
classes and functions, no matter if the `PHP APCu extension`_ is installed or
28+
not in your server. The only requirement is to have installed at least the
29+
`legacy APC extension`_.
30+
31+
Provided Classes
32+
~~~~~~~~~~~~~~~~
33+
34+
* :phpclass:`APCUIterator`
35+
36+
Provided Functions
37+
~~~~~~~~~~~~~~~~~~
38+
39+
* :phpfunction:`apcu_add`
40+
* :phpfunction:`apcu_delete`
41+
* :phpfunction:`apcu_exists`
42+
* :phpfunction:`apcu_fetch`
43+
* :phpfunction:`apcu_store`
44+
* :phpfunction:`apcu_cache_info`
45+
* :phpfunction:`apcu_cas`
46+
* :phpfunction:`apcu_clear_cache`
47+
* :phpfunction:`apcu_dec`
48+
* :phpfunction:`apcu_inc`
49+
* :phpfunction:`apcu_sma_info`
50+
51+
.. _`PHP APCu extension`: https://secure.php.net/manual/en/book.apcu.php
52+
.. _`legacy APC extension`: https://secure.php.net/manual/en/book.apc.php

‎components/polyfill_ctype.rst‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
.. index::
2+
single: Polyfill
3+
single: Ctype
4+
single: Components; Polyfill
5+
6+
The Symfony Polyfill / Ctype Component
7+
======================================
8+
9+
This component provides ``ctype_*`` functions to users who run PHP versions
10+
without the ctype extension.
11+
12+
Installation
13+
------------
14+
15+
.. code-block:: terminal
16+
17+
$ composer require symfony/polyfill-ctype
18+
19+
Alternatively, you can clone the `<https://github.com/symfony/polyfill-ctype>`_ repository.
20+
21+
.. include:: /components/require_autoload.rst.inc
22+
23+
Usage
24+
-----
25+
26+
Once this component is installed in your application, you can use the following
27+
functions, no matter if the `PHP Ctype extension`_ is installed or not in your
28+
server.
29+
30+
Provided Functions
31+
~~~~~~~~~~~~~~~~~~
32+
33+
* :phpfunction:`ctype_alnum`
34+
* :phpfunction:`ctype_alpha`
35+
* :phpfunction:`ctype_cntrl`
36+
* :phpfunction:`ctype_digit`
37+
* :phpfunction:`ctype_graph`
38+
* :phpfunction:`ctype_lower`
39+
* :phpfunction:`ctype_print`
40+
* :phpfunction:`ctype_punct`
41+
* :phpfunction:`ctype_space`
42+
* :phpfunction:`ctype_upper`
43+
* :phpfunction:`ctype_xdigit`
44+
45+
.. _`PHP Ctype extension`: https://secure.php.net/manual/en/book.ctype.php

‎components/polyfill_iconv.rst‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
.. index::
2+
single: Polyfill
3+
single: Iconv
4+
single: Components; Polyfill
5+
6+
The Symfony Polyfill / Iconv Component
7+
======================================
8+
9+
This component provides a native PHP implementation of the ``iconv_*``
10+
functions to users who run PHP versions without the ``iconv`` extension.
11+
12+
Installation
13+
------------
14+
15+
.. code-block:: terminal
16+
17+
$ composer require symfony/polyfill-iconv
18+
19+
Alternatively, you can clone the `<https://github.com/symfony/polyfill-iconv>`_ repository.
20+
21+
.. include:: /components/require_autoload.rst.inc
22+
23+
Usage
24+
-----
25+
26+
Once this component is installed in your application, you can use the following
27+
constants and functions, no matter if the `PHP iconv extension`_ is installed or
28+
not in your server. The only function not implemented in this component is
29+
:phpfunction:`ob_iconv_handler`.
30+
31+
Provided Constants
32+
~~~~~~~~~~~~~~~~~~
33+
34+
* ``ICONV_IMPL`` (value = ``'Symfony'``)
35+
* ``ICONV_VERSION`` (value = ``'1.0'``)
36+
* ``ICONV_MIME_DECODE_STRICT`` (value = ``1``)
37+
* ``ICONV_MIME_DECODE_CONTINUE_ON_ERROR`` (value = ``2``)
38+
39+
Provided Functions
40+
~~~~~~~~~~~~~~~~~~
41+
42+
These functions are always available:
43+
44+
* :phpfunction:`iconv`
45+
* :phpfunction:`iconv_get_encoding`
46+
* :phpfunction:`iconv_set_encoding`
47+
* :phpfunction:`iconv_mime_encode`
48+
* :phpfunction:`iconv_mime_decode_headers`
49+
50+
These functions are only available when the ``mbstring`` or the ``xml``
51+
extension are installed:
52+
53+
* :phpfunction:`iconv_strlen`
54+
* :phpfunction:`iconv_strpos`
55+
* :phpfunction:`iconv_strrpos`
56+
* :phpfunction:`iconv_substr`
57+
* :phpfunction:`iconv_mime_decode`
58+
59+
.. _`PHP iconv extension`: https://secure.php.net/manual/en/book.iconv.php
60+
.. _`mbstring`: https://secure.php.net/manual/en/book.mbstring.php
61+
.. _`xml`: https://secure.php.net/manual/en/book.xml.php

‎components/polyfill_intl_grapheme.rst‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
.. index::
2+
single: Polyfill
3+
single: Intl
4+
single: Components; Polyfill
5+
6+
The Symfony Polyfill / Intl Grapheme Component
7+
==============================================
8+
9+
This component provides a partial, native PHP implementation of the
10+
``grapheme_*`` functions to users who run PHP versions without the ``intl``
11+
extension.
12+
13+
Installation
14+
------------
15+
16+
.. code-block:: terminal
17+
18+
$ composer require symfony/polyfill-intl-grapheme
19+
20+
Alternatively, you can clone the `<https://github.com/symfony/polyfill-intl-grapheme>`_ repository.
21+
22+
.. include:: /components/require_autoload.rst.inc
23+
24+
Usage
25+
-----
26+
27+
Once this component is installed in your application, you can use the following
28+
constants and functions, no matter if the `PHP intl extension`_ is installed or
29+
not in your server.
30+
31+
Provided Constants
32+
~~~~~~~~~~~~~~~~~~
33+
34+
* ``GRAPHEME_EXTR_COUNT`` (value = ``0``)
35+
* ``GRAPHEME_EXTR_MAXBYTES`` (value = ``1``)
36+
* ``GRAPHEME_EXTR_MAXCHARS`` (value = ``2``)
37+
38+
Provided Functions
39+
~~~~~~~~~~~~~~~~~~
40+
41+
* :phpfunction:`grapheme_extract`
42+
* :phpfunction:`grapheme_stripos`
43+
* :phpfunction:`grapheme_stristr`
44+
* :phpfunction:`grapheme_strlen`
45+
* :phpfunction:`grapheme_strpos`
46+
* :phpfunction:`grapheme_strripos`
47+
* :phpfunction:`grapheme_strrpos`
48+
* :phpfunction:`grapheme_strstr`
49+
* :phpfunction:`grapheme_substr`
50+
51+
.. seealso::
52+
53+
The :doc:`polyfill-intl-icu </components/polyfill_intl_icu>` and
54+
:doc:`polyfill-intl-normalizer </components/polyfill_intl_normalizer>`
55+
components provide polyfills for other classes and functions related to the
56+
Intl PHP extension.
57+
58+
.. _`PHP intl extension`: https://secure.php.net/manual/en/book.intl.php

‎components/polyfill_intl_icu.rst‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
.. index::
2+
single: Polyfill
3+
single: ICU
4+
single: Components; Polyfill
5+
6+
The Symfony Polyfill / Intl ICU Component
7+
=========================================
8+
9+
This component provides a native PHP implementation of several Intl
10+
functions and classes to users who run PHP versions without the ``intl``
11+
extension.
12+
13+
Installation
14+
------------
15+
16+
.. code-block:: terminal
17+
18+
$ composer require symfony/polyfill-intl-icu
19+
20+
Alternatively, you can clone the `<https://github.com/symfony/polyfill-intl-icu>`_ repository.
21+
22+
.. include:: /components/require_autoload.rst.inc
23+
24+
Usage
25+
-----
26+
27+
Once this component is installed in your application, you can use the following
28+
classes and functions, no matter if the `PHP intl extension`_ is installed or
29+
not in your server.
30+
31+
Provided Classes
32+
~~~~~~~~~~~~~~~~
33+
34+
* :phpclass:`Collator`
35+
* :phpclass:`IntlDateFormatter`
36+
* :phpclass:`Locale`
37+
* :phpclass:`NumberFormatter`
38+
39+
Provided Functions
40+
~~~~~~~~~~~~~~~~~~
41+
42+
* :phpfunction:`intl_error_name`
43+
* :phpfunction:`intl_get_error_code`
44+
* :phpfunction:`intl_get_error_message`
45+
* :phpfunction:`intl_is_failure`
46+
47+
.. seealso::
48+
49+
The :doc:`polyfill-intl-grapheme </components/polyfill_intl_grapheme>` and
50+
:doc:`polyfill-intl-normalizer </components/polyfill_intl_normalizer>`
51+
components provide polyfills for other classes and functions related to the
52+
Intl PHP extension.
53+
54+
.. _`PHP intl extension`: https://secure.php.net/manual/en/book.intl.php

‎components/polyfill_intl_normalizer.rst‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
.. index::
2+
single: Polyfill
3+
single: Normalizer
4+
single: Components; Polyfill
5+
6+
The Symfony Polyfill / Intl Normalizer Component
7+
================================================
8+
9+
This component provides a fallback implementation for the ``Normalizer``
10+
class to users who run PHP versions without the ``intl`` extension.
11+
12+
Installation
13+
------------
14+
15+
.. code-block:: terminal
16+
17+
$ composer require symfony/polyfill-intl-normalizer
18+
19+
Alternatively, you can clone the `<https://github.com/symfony/polyfill-intl-normalizer>`_ repository.
20+
21+
.. include:: /components/require_autoload.rst.inc
22+
23+
Usage
24+
-----
25+
26+
Once this component is installed in your application, you can use the following
27+
classes and functions, no matter if the `PHP intl extension`_ is installed or
28+
not in your server.
29+
30+
Provided Classes
31+
~~~~~~~~~~~~~~~~
32+
33+
* :phpclass:`Normalizer`
34+
35+
Provided Functions
36+
~~~~~~~~~~~~~~~~~~
37+
38+
* :phpfunction:`normalizer_is_normalized`
39+
* :phpfunction:`normalizer_normalize`
40+
41+
.. seealso::
42+
43+
The :doc:`polyfill-intl-grapheme </components/polyfill_intl_grapheme>` and
44+
:doc:`polyfill-intl-icu </components/polyfill_intl_icu>` components provide
45+
polyfills for other classes and functions related to the Intl PHP extension.
46+
47+
.. _`PHP intl extension`: https://secure.php.net/manual/en/book.intl.php

0 commit comments

Comments
 (0)