From dee52b9d9f307506a06abf6498815d60ee7295b3 Mon Sep 17 00:00:00 2001
From: Adam Harvey <aharvey@php.net>
Date: Mon, 3 Nov 2014 11:54:59 +0000
Subject: [PATCH] Add OO documentation for finfo.

Fixes doc bug #68337 (Object-Oriented version of finfo is not properly
documented).


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335155 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/fileinfo/book.xml            |  1 +
 reference/fileinfo/finfo.xml           | 68 ++++++++++++++++++++++++++
 reference/fileinfo/finfo/buffer.xml    | 43 ++++++++++++++++
 reference/fileinfo/finfo/construct.xml | 42 ++++++++++++++++
 reference/fileinfo/finfo/file.xml      | 43 ++++++++++++++++
 reference/fileinfo/finfo/set-flags.xml | 41 ++++++++++++++++
 reference/fileinfo/versions.xml        |  9 +++-
 7 files changed, 246 insertions(+), 1 deletion(-)
 create mode 100644 reference/fileinfo/finfo.xml
 create mode 100644 reference/fileinfo/finfo/buffer.xml
 create mode 100644 reference/fileinfo/finfo/construct.xml
 create mode 100644 reference/fileinfo/finfo/file.xml
 create mode 100644 reference/fileinfo/finfo/set-flags.xml

diff --git a/reference/fileinfo/book.xml b/reference/fileinfo/book.xml
index 734e631529..bd5b79c1bb 100644
--- a/reference/fileinfo/book.xml
+++ b/reference/fileinfo/book.xml
@@ -22,6 +22,7 @@
  &reference.fileinfo.setup;
  &reference.fileinfo.constants;
  &reference.fileinfo.reference;
+ &reference.fileinfo.finfo;
 
 </book>
 
diff --git a/reference/fileinfo/finfo.xml b/reference/fileinfo/finfo.xml
new file mode 100644
index 0000000000..ce604f02c0
--- /dev/null
+++ b/reference/fileinfo/finfo.xml
@@ -0,0 +1,68 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<phpdoc:classref xml:id="class.finfo" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+
+ <title>The finfo class</title>
+ <titleabbrev>finfo</titleabbrev>
+
+ <partintro>
+
+<!-- {{{ finfo intro -->
+  <section xml:id="finfo.intro">
+   &reftitle.intro;
+   <para>
+    This class provides an object oriented interface into the fileinfo
+    functions.
+   </para>
+  </section>
+<!-- }}} -->
+
+  <section xml:id="finfo.synopsis">
+   &reftitle.classsynopsis;
+
+<!-- {{{ Synopsis -->
+   <classsynopsis>
+    <ooclass><classname>finfo</classname></ooclass>
+
+<!-- {{{ Class synopsis -->
+    <classsynopsisinfo>
+     <ooclass>
+      <classname>finfo</classname>
+     </ooclass>
+    </classsynopsisinfo>
+<!-- }}} -->
+    
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.finfo')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])" />
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.finfo')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+   </classsynopsis>
+<!-- }}} -->
+
+  </section>
+
+ </partintro>
+
+ &reference.fileinfo.entities.finfo;
+
+</phpdoc:classref>
+
+<!-- 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/reference/fileinfo/finfo/buffer.xml b/reference/fileinfo/finfo/buffer.xml
new file mode 100644
index 0000000000..869eb26cae
--- /dev/null
+++ b/reference/fileinfo/finfo/buffer.xml
@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="finfo.buffer" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>finfo::buffer</refname>
+  <refpurpose>&Alias; <function>finfo_buffer</function></refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis role="oop">
+   <modifier>public</modifier> <type>string</type><methodname>finfo::buffer</methodname>
+   <methodparam><type>string</type><parameter>string</parameter><initializer>&null;</initializer></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>FILEINFO_NONE</initializer></methodparam>
+   <methodparam choice="opt"><type>resource</type><parameter>context</parameter><initializer>&null;</initializer></methodparam>
+  </methodsynopsis>
+  <para>
+   &info.function.alias; <function>finfo_buffer</function>
+  </para>
+ </refsect1>
+</refentry>
+
+<!-- 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/reference/fileinfo/finfo/construct.xml b/reference/fileinfo/finfo/construct.xml
new file mode 100644
index 0000000000..005a64fb77
--- /dev/null
+++ b/reference/fileinfo/finfo/construct.xml
@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="finfo.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>finfo::__construct</refname>
+  <refpurpose>&Alias; <function>finfo_open</function></refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <constructorsynopsis>
+   <modifier>public</modifier> <methodname>finfo::__construct</methodname>
+   <methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>FILEINFO_NONE</initializer></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter>magic_file</parameter><initializer>&null;</initializer></methodparam>
+  </constructorsynopsis>
+  <para>
+   &info.function.alias; <function>finfo_open</function>
+  </para>
+ </refsect1>
+</refentry>
+
+<!-- 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/reference/fileinfo/finfo/file.xml b/reference/fileinfo/finfo/file.xml
new file mode 100644
index 0000000000..f2199227e2
--- /dev/null
+++ b/reference/fileinfo/finfo/file.xml
@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="finfo.file" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>finfo::file</refname>
+  <refpurpose>&Alias; <function>finfo_file</function></refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis role="oop">
+   <modifier>public</modifier> <type>string</type><methodname>finfo::file</methodname>
+   <methodparam><type>string</type><parameter>file_name</parameter><initializer>&null;</initializer></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>FILEINFO_NONE</initializer></methodparam>
+   <methodparam choice="opt"><type>resource</type><parameter>context</parameter><initializer>&null;</initializer></methodparam>
+  </methodsynopsis>
+  <para>
+   &info.function.alias; <function>finfo_file</function>
+  </para>
+ </refsect1>
+</refentry>
+
+<!-- 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/reference/fileinfo/finfo/set-flags.xml b/reference/fileinfo/finfo/set-flags.xml
new file mode 100644
index 0000000000..48de19d748
--- /dev/null
+++ b/reference/fileinfo/finfo/set-flags.xml
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="finfo.set-flags" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>finfo::set_flags</refname>
+  <refpurpose>&Alias; <function>finfo_set_flags</function></refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis role="oop">
+   <modifier>public</modifier> <type>bool</type><methodname>finfo::set_flags</methodname>
+   <methodparam><type>int</type><parameter>options</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   &info.function.alias; <function>finfo_set_flags</function>
+  </para>
+ </refsect1>
+</refentry>
+
+<!-- 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/reference/fileinfo/versions.xml b/reference/fileinfo/versions.xml
index 31d94bca47..b08d782e1e 100644
--- a/reference/fileinfo/versions.xml
+++ b/reference/fileinfo/versions.xml
@@ -9,6 +9,13 @@
  <function name='finfo_file' from='PHP &gt;= 5.3.0, PECL fileinfo &gt;= 0.1.0'/>
  <function name='finfo_open' from='PHP &gt;= 5.3.0, PECL fileinfo &gt;= 0.1.0'/>
  <function name='finfo_set_flags' from='PHP &gt;= 5.3.0, PECL fileinfo &gt;= 0.1.0'/>
+
+ <function name='finfo' from='PHP 5 &gt;= 5.3.0, PECL fileinfo &gt;= 0.1.0'/>
+ <function name='finfo::__construct' from='PHP &gt;= 5.3.0, PECL fileinfo &gt;= 0.1.0'/>
+ <function name='finfo::buffer' from='PHP 5 &gt;= 5.3.0, PECL fileinfo &gt;= 0.1.0'/>
+ <function name='finfo::file' from='PHP &gt;= 5.3.0, PECL fileinfo &gt;= 0.1.0'/>
+ <function name='finfo::set_flags' from='PHP &gt;= 5.3.0, PECL fileinfo &gt;= 0.1.0'/>
+
  <function name='mime_content_type' from='PHP 4 &gt;= 4.3.0, PHP 5'/>
 </versions>
 
@@ -31,4 +38,4 @@ End:
 vim600: syn=xml fen fdm=syntax fdl=2 si
 vim: et tw=78 syn=sgml
 vi: ts=1 sw=1
--->
\ No newline at end of file
+-->