Finalise cURL documentation (#137)

* Unify `Mime-Typ` within cURL translations * Add `curlstringfile` documentation * Add `curl_multi_errno` documentation * Add `curl_reset` documentation * Add `curl_share_close` documentation * Add `curl_share_errno` documentation * Add `curl_share_init` documentation * Add `curl_share_setopt` documentation * Add `curl_share_strerror` documentation * Add `curl_strerror` documentation * Add `curl_unescape` documentation * Add `curl_upkeep` documentation --------- Co-authored-by: Martin Samesch <[email protected]>
php · Jul 9, 2023 · d2635ab · d2635ab
1 parent c5d63a1
commit d2635ab
Show file tree

Hide file tree

Showing 15 changed files with 1,427 additions and 8 deletions.
diff --git a/reference/curl/curlfile/construct.xml b/reference/curl/curlfile/construct.xml
@@ -47,7 +47,7 @@
     <term><parameter>mime_type</parameter></term>
     <listitem>
      <para>
-      Der Mimetyp der Datei.
+      Der MIME-Typ der Datei.
      </para>
     </listitem>
    </varlistentry>

diff --git a/reference/curl/curlstringfile.xml b/reference/curl/curlstringfile.xml
@@ -0,0 +1,125 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- EN-Revision: 5017547fee4dd0873d2ced02e2bb90b696f26a24 Maintainer: joshuaruesweg Status: ready -->
+<phpdoc:classref xml:id="class.curlstringfile" 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>Die Klasse CURLStringFile</title>
+ <titleabbrev>CURLStringFile</titleabbrev>
+
+ <partintro>
+
+<!-- {{{ CURLStringFile intro -->
+  <section xml:id="curlstringfile.intro">
+   &reftitle.intro;
+   <para>
+    <classname>CURLStringFile</classname> ermöglicht es Dateien direkt aus einer Variable hochzuladen.
+    Diese Klasse ist ähnlich wie <classname>CURLFile</classname>, nimmt allerdings den Inhalt der Datei und nicht den Dateinamen entgegen.
+    Diese Klasse oder <classname>CURLFile</classname> sollte benutzt werden, um eine Datei mit
+    <constant>CURLOPT_POSTFIELDS</constant> hochzuladen.
+   </para>
+  </section>
+<!-- }}} -->
+
+  <section xml:id="curlstringfile.synopsis">
+   &reftitle.classsynopsis;
+
+<!-- {{{ Synopsis -->
+   <classsynopsis>
+    <ooclass>
+     <classname>CURLStringFile</classname>
+    </ooclass>
+
+    <classsynopsisinfo>
+     <ooclass>
+      <classname>CURLStringFile</classname>
+     </ooclass>
+    </classsynopsisinfo>
+
+    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
+    <fieldsynopsis>
+     <modifier>public</modifier>
+     <type>string</type>
+     <varname linkend="curlstringfile.props.data">data</varname>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>public</modifier>
+     <type>string</type>
+     <varname linkend="curlstringfile.props.postname">postname</varname>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>public</modifier>
+     <type>string</type>
+     <varname linkend="curlstringfile.props.mime">mime</varname>
+    </fieldsynopsis>
+
+    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.curlstringfile')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='CURLStringFile'])">
+     <xi:fallback/>
+    </xi:include>
+   </classsynopsis>
+<!-- }}} -->
+
+  </section>
+
+<!-- {{{ CURLStringFile properties -->
+  <section xml:id="curlstringfile.props">
+   &reftitle.properties;
+   <variablelist>
+    <varlistentry xml:id="curlstringfile.props.data">
+     <term><varname>data</varname></term>
+     <listitem>
+      <para>Die hochzuladenden Daten.</para>
+     </listitem>
+    </varlistentry>
+    <varlistentry xml:id="curlstringfile.props.postname">
+     <term><varname>postname</varname></term>
+     <listitem>
+      <para>Der Name der Datei in den Upload-Daten.</para>
+     </listitem>
+    </varlistentry>
+    <varlistentry xml:id="curlstringfile.props.mime">
+     <term><varname>mime</varname></term>
+     <listitem>
+      <para>Der MIME-Typ der Datei (Vorgabe ist <literal>application/octet-stream</literal>).</para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </section>
+<!-- }}} -->
+
+  <section xml:id="curlstringfile.seealso">
+   &reftitle.seealso;
+   <para>
+    <simplelist>
+     <member>
+      <function>curl_setopt</function>
+     </member>
+     <member><classname>CURLFile</classname></member>
+    </simplelist>
+   </para>
+  </section>
+
+ </partintro>
+
+ &reference.curl.entities.curlstringfile;
+
+</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/curl/curlstringfile/construct.xml b/reference/curl/curlstringfile/construct.xml
@@ -0,0 +1,136 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- EN-Revision: 5017547fee4dd0873d2ced02e2bb90b696f26a24 Maintainer: joshuaruesweg Status: ready -->
+<refentry xml:id="curlstringfile.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>CURLStringFile::__construct</refname>
+  <refpurpose>Erstellt ein CURLStringFile-Objekt</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <constructorsynopsis role="CURLStringFile">
+   <modifier>public</modifier> <methodname>CURLStringFile::__construct</methodname>
+   <methodparam><type>string</type><parameter>data</parameter></methodparam>
+   <methodparam><type>string</type><parameter>postname</parameter></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter>mime</parameter><initializer>"application/octet-stream"</initializer></methodparam>
+  </constructorsynopsis>
+  <para>
+   Erstellt ein <classname>CURLStringFile</classname>-Objekt, welches zum Upload einer
+   Datei via <constant>CURLOPT_POSTFIELDS</constant> verwendet wird.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>data</parameter></term>
+    <listitem>
+     <para>
+      Die hochzuladenden Daten.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>postname</parameter></term>
+    <listitem>
+     <para>
+      Der in den Upload-Daten zu verwendende Dateiname.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>mime</parameter></term>
+    <listitem>
+     <para>
+      Der MIME-Typ der Datei (Vorgabe ist <literal>application/octet-stream</literal>).
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <example>
+   <title><function>CURLStringFile::__construct</function>-Beispiel</title>
+   <programlisting role="php">
+<![CDATA[
+<?php
+/* http://example.com/upload.php:
+<?php
+var_dump($_FILES);
+var_dump(file_get_contents($_FILES['test_string']['tmp_name']));
+?>
+*/
+
+// Erstellt ein cURL-Handle
+$ch = curl_init('http://example.com/upload.php');
+
+// Erstellt ein CURLStringFile-Objekt
+$cstringfile = new CURLStringFile('test upload contents','test.txt','text/plain');
+
+// POST-Daten hinzufügen
+$data = array('test_string' => $cstringfile);
+curl_setopt($ch, CURLOPT_POST, 1);
+curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
+
+// Das Handle ausführen
+curl_exec($ch);
+?>
+]]>
+   </programlisting>
+   &example.outputs;
+   <screen>
+<![CDATA[
+array(1) {
+  ["test_string"]=>
+  array(5) {
+    ["name"]=>
+    string(8) "test.txt"
+    ["type"]=>
+    string(10) "text/plain"
+    ["tmp_name"]=>
+    string(14) "/tmp/phpTtaoCz"
+    ["error"]=>
+    int(0)
+    ["size"]=>
+    int(20)
+  }
+}
+string(20) "test upload contents"
+]]>
+   </screen>
+  </example>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>curl_setopt</function></member>
+   </simplelist>
+  </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/curl/functions/curl-escape.xml b/reference/curl/functions/curl-escape.xml
@@ -42,7 +42,7 @@
    Gibt den kodierten String zurück. &return.falseforfailure;
   </para>
  </refsect1>
- 
+
  <refsect1 role="changelog">
   &reftitle.changelog;
   <informaltable>
@@ -64,7 +64,7 @@
   &reftitle.examples;
   <para>
    <example>
-    <title><function>curl_escape</function> Beispiel</title>
+    <title><function>curl_escape</function>-Beispiel</title>
     <programlisting role="php">
 <![CDATA[
 <?php

diff --git a/reference/curl/functions/curl-multi-errno.xml b/reference/curl/functions/curl-multi-errno.xml
@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<!-- EN-Revision: 7f99d5e488d161ce3b12d1dae405a283728933c3 Maintainer: joshuaruesweg Status: ready -->
+<refentry xml:id="function.curl-multi-errno" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>curl_multi_errno</refname>
+  <refpurpose>Gibt die Fehlernummer der letzten cURL-Multihandle-Operation zurück</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description"><!-- {{{ -->
+  &reftitle.description;
+  <methodsynopsis>
+   <type>int</type><methodname>curl_multi_errno</methodname>
+   <methodparam><type>CurlMultiHandle</type><parameter>multi_handle</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Gibt einen Integerwert zurück, der die Fehlernummer der letzten cURL-Multihandle-Operation enthält.
+  </para>
+ </refsect1><!-- }}} -->
+
+ <refsect1 role="parameters"><!-- {{{ -->
+  &reftitle.parameters;
+  <variablelist>
+    &curl.mh.description;
+  </variablelist>
+ </refsect1><!-- }}} -->
+
+ <refsect1 role="returnvalues"><!-- {{{ -->
+  &reftitle.returnvalues;
+  <para>
+   Gibt einen Integerwert zurück, der die Fehlernummer der letzten cURL-Multihandle-Operation enthält.
+  </para>
+ </refsect1><!-- }}} -->
+
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <informaltable>
+   <tgroup cols="2">
+    <thead>
+     <row>
+      <entry>&Version;</entry>
+      <entry>&Description;</entry>
+     </row>
+    </thead>
+    <tbody>
+     <row>
+      <entry>8.0.0</entry>
+      <entry>
+      Diese Funktion gibt bei Auftreten eines Fehlers nicht mehr &false; zurück.
+      </entry>
+     </row>
+     &curl.changelog.multi-handle-param;
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+
+ <refsect1 role="seealso"><!-- {{{ -->
+  &reftitle.seealso;
+  <simplelist>
+   <member><function>curl_errno</function></member>
+  </simplelist>
+ </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
+-->