From 8bffa662766ee9c3908290c98d1af32dab4a9be5 Mon Sep 17 00:00:00 2001
From: Christoph Michael Becker <cmb@php.net>
Date: Sun, 22 Nov 2020 14:00:54 +0000
Subject: [PATCH] Add ValueError page

Patch contributed by George Peter Banyard <girgias@php.net>.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351496 c90b9560-bf6c-de11-be94-00142212c4b1
---
 language/errors/php7.xml           |  3 ++
 language/predefined/exceptions.xml |  1 +
 language/predefined/valueerror.xml | 79 ++++++++++++++++++++++++++++++
 language/predefined/versions.xml   |  1 +
 4 files changed, 84 insertions(+)
 create mode 100644 language/predefined/valueerror.xml

diff --git a/language/errors/php7.xml b/language/errors/php7.xml
index 5e179b95dd..5c0b2ae7e9 100644
--- a/language/errors/php7.xml
+++ b/language/errors/php7.xml
@@ -66,6 +66,9 @@
          </listitem>
         </itemizedlist>
        </listitem>
+       <listitem>
+        <simpara><classname>ValueError</classname></simpara>
+       </listitem>
       </itemizedlist>
      </listitem>
      <listitem>
diff --git a/language/predefined/exceptions.xml b/language/predefined/exceptions.xml
index 6f4647f479..7653c0809e 100644
--- a/language/predefined/exceptions.xml
+++ b/language/predefined/exceptions.xml
@@ -23,6 +23,7 @@
  &language.predefined.compileerror;
  &language.predefined.parseerror;
  &language.predefined.typeerror;
+ &language.predefined.valueerror;
 </part>
 
 <!-- Keep this comment at the end of the file
diff --git a/language/predefined/valueerror.xml b/language/predefined/valueerror.xml
new file mode 100644
index 0000000000..ac87ffc49b
--- /dev/null
+++ b/language/predefined/valueerror.xml
@@ -0,0 +1,79 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<phpdoc:exceptionref xml:id="class.valueerror"
+ xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:phpdoc="http://php.net/ns/phpdoc">
+ <title>ValueError</title>
+ <titleabbrev>ValueError</titleabbrev>
+
+ <partintro>
+
+<!-- {{{ Error intro -->
+  <section xml:id="valueerror.intro">
+   &reftitle.intro;
+   <para>
+    A <classname>ValueError</classname> is thrown when the
+    type of an argument is correct but the value of it is incorrect.
+    For example, passing a negative integer when the function expects a
+    positive one, or passing an empty string/array when the function expects
+    it to not be empty.
+  </para>
+  </section>
+<!-- }}} -->
+
+  <section xml:id="valueerror.synopsis">
+   &reftitle.classsynopsis;
+
+<!-- {{{ Synopsis -->
+   <classsynopsis>
+    <ooclass><classname>ValueError</classname></ooclass>
+
+<!-- {{{ Class synopsis -->
+    <classsynopsisinfo>
+     <ooclass>
+      <classname>ValueError</classname>
+     </ooclass>
+
+     <ooclass>
+      <modifier>extends</modifier>
+      <classname>Error</classname>
+     </ooclass>
+    </classsynopsisinfo>
+<!-- }}} -->
+
+    <classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.error')/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.error')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+   </classsynopsis>
+<!-- }}} -->
+  </section>
+ </partintro>
+</phpdoc:exceptionref>
+
+<!-- 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
+-->
diff --git a/language/predefined/versions.xml b/language/predefined/versions.xml
index 2164003aae..a9333d6600 100644
--- a/language/predefined/versions.xml
+++ b/language/predefined/versions.xml
@@ -25,6 +25,7 @@
  <function name="parseerror" from="PHP 7"/>
  <function name="typeerror" from="PHP 7"/>
  <function name="argumentcounterror" from="PHP 7 &gt;= PHP 7.1.0"/>
+ <function name="valueerror" from="PHP 8"/>
 
  <function name="exception" from="PHP 5, PHP 7"/>
  <function name="exception::__clone" from="PHP 5, PHP 7"/>