Skip to content

Document FILTER_THROW_ON_FAILURE and the Filter exception classes (PHP 8.5) #5607

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

Open
lacatoire wants to merge 4 commits into
base: master
Choose a base branch
from
+156 −0
Open

Document FILTER_THROW_ON_FAILURE and the Filter exception classes (PHP 8.5) #5607

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
60007d4
Document FILTER_THROW_ON_FAILURE and Filter exception classes (PHP 8.5)
lacatoire Jun 8, 2026
ff61cfd
Update constants.xml
lacatoire Jun 12, 2026
a06c95e
Update constants.xml
lacatoire Jun 12, 2026
d28891f
Update filter.filterfailedexception.xml
lacatoire Jun 12, 2026
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
3 changes: 3 additions & 0 deletions reference/filter/book.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,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
20 changes: 20 additions & 0 deletions reference/filter/constants.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,26 @@
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.filter-throw-on-failure">
<term>
<constant>FILTER_THROW_ON_FAILURE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Throws a <exceptionname>Filter\FilterFailedException</exceptionname> when a
validation filter fails, instead of returning &false;.
</simpara>
<simpara>
Can be used with any validation
<constant>FILTER_VALIDATE_<replaceable>*</replaceable></constant>
filter.
</simpara>
<simpara>
Available as of PHP 8.5.0.
</simpara>
</listitem>
</varlistentry>
</variablelist>

<variablelist xml:id="filter.constants.flags.sanitization">
Expand Down
66 changes: 66 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,66 @@
<?xml version="1.0" encoding="utf-8"?>
<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>The Filter\FilterException class</title>
<titleabbrev>Filter\FilterException</titleabbrev>

<partintro>
<section xml:id="filter-filterexception.intro">
&reftitle.intro;
<simpara>
The base class for <type>Exception</type>s thrown by the Filter extension.
</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
-->
67 changes: 67 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,67 @@
<?xml version="1.0" encoding="utf-8"?>
<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>The Filter\FilterFailedException class</title>
<titleabbrev>Filter\FilterFailedException</titleabbrev>

<partintro>
<section xml:id="filter-filterfailedexception.intro">
&reftitle.intro;
<simpara>
Thrown when a validation filter fails and the
<constant>FILTER_THROW_ON_FAILURE</constant> flag is set.
</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>
<exceptionname>Filter\FilterException</exceptionname>
</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