Skip to content

[Sync EN] Document FILTER_THROW_ON_FAILURE and the Filter exception classes (PHP 8.5) #3039

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lacatoire merged 1 commit into from
Jun 15, 2026
+159 −3
Merged

[Sync EN] Document FILTER_THROW_ON_FAILURE and the Filter exception classes (PHP 8.5) #3039

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion reference/filter/book.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 53054bf8decc8648cf2e90a493692a161e2371af Maintainer: yannick Status: ready -->
<!-- EN-Revision: 3d4ee5f40afbfe44db4f1b13a22a6a38d4b40c7b Maintainer: lacatoire Status: ready -->
<!-- Reviewed: yes -->
<book xml:id="book.filter" xmlns="http://docbook.org/ns/docbook">
<?phpdoc extension-membership="bundled" ?>
Expand Down Expand Up @@ -53,6 +53,9 @@
&reference.filter.examples;
&reference.filter.reference;

&reference.filter.filter.filterexception;
&reference.filter.filter.filterfailedexception;

</book>
<!-- Keep this comment at the end of the file
Local variables:
Expand Down
22 changes: 20 additions & 2 deletions reference/filter/constants.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 525aa5f198d482c0d03be54ddee5af13b376ab99 Maintainer: lacatoire Status: ready -->
<!-- Reviewed: no -->
<!-- EN-Revision: 3d4ee5f40afbfe44db4f1b13a22a6a38d4b40c7b Maintainer: lacatoire Status: ready -->
<appendix xml:id="filter.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.constants;
&extension.constants;
Expand Down Expand Up @@ -154,6 +153,25 @@
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.filter-throw-on-failure">
<term>
<constant>FILTER_THROW_ON_FAILURE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Lance une <exceptionname>Filter\FilterFailedException</exceptionname>
lorsqu'un filtre de validation échoue, au lieu de retourner &false;.
</simpara>
<simpara>
Utilisable avec tout filtre de validation
<constant>FILTER_VALIDATE_<replaceable>*</replaceable></constant>.
</simpara>
<simpara>
Disponible à partir de PHP 8.5.0.
</simpara>
</listitem>
</varlistentry>
</variablelist>

<variablelist xml:id="filter.constants.flags.sanitization">
Expand Down
67 changes: 67 additions & 0 deletions reference/filter/filter.filterexception.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 3d4ee5f40afbfe44db4f1b13a22a6a38d4b40c7b Maintainer: lacatoire Status: ready -->
<reference xml:id="class.filter-filterexception" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>La classe Filter\FilterException</title>
<titleabbrev>Filter\FilterException</titleabbrev>

<partintro>
<section xml:id="filter-filterexception.intro">
&reftitle.intro;
<simpara>
La classe de base pour les <type>Exception</type>s lancées par l'extension Filter.
</simpara>
</section>

<section xml:id="filter-filterexception.synopsis">
&reftitle.classsynopsis;

<packagesynopsis>
<package>Filter</package>

<classsynopsis class="class">
<ooexception>
<exceptionname>FilterException</exceptionname>
</ooexception>

<ooclass>
<modifier>extends</modifier>
<classname>Exception</classname>
</ooclass>

<classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Properties;']]))">
<xi:fallback/>
</xi:include>

<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='Exception'])">
<xi:fallback/>
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='Exception'])">
<xi:fallback/>
</xi:include>
</classsynopsis>
</packagesynopsis>
</section>
</partintro>
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
68 changes: 68 additions & 0 deletions reference/filter/filter.filterfailedexception.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 3d4ee5f40afbfe44db4f1b13a22a6a38d4b40c7b Maintainer: lacatoire Status: ready -->
<reference xml:id="class.filter-filterfailedexception" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>La classe Filter\FilterFailedException</title>
<titleabbrev>Filter\FilterFailedException</titleabbrev>

<partintro>
<section xml:id="filter-filterfailedexception.intro">
&reftitle.intro;
<simpara>
Lancée lorsqu'un filtre de validation échoue et que le drapeau
<constant>FILTER_THROW_ON_FAILURE</constant> est défini.
</simpara>
</section>

<section xml:id="filter-filterfailedexception.synopsis">
&reftitle.classsynopsis;

<packagesynopsis>
<package>Filter</package>

<classsynopsis class="class">
<ooexception>
<exceptionname>FilterFailedException</exceptionname>
</ooexception>

<ooclass>
<modifier>extends</modifier>
<classname>Filter\FilterException</classname>
</ooclass>

<classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Properties;']]))">
<xi:fallback/>
</xi:include>

<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='Exception'])">
<xi:fallback/>
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='Exception'])">
<xi:fallback/>
</xi:include>
</classsynopsis>
</packagesynopsis>
</section>
</partintro>
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Loading