Skip to content

Document new cURL constants (PHP 8.5) #5606

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 1 commit into
base: master
Choose a base branch
from
+121 −0
Open

Document new cURL constants (PHP 8.5) #5606

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
46 changes: 46 additions & 0 deletions reference/curl/constants.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,52 @@
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlfollow-all">
<term>
<constant>CURLFOLLOW_ALL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Value for <constant>CURLOPT_FOLLOWLOCATION</constant> that enables following
redirects and keeps a custom request method set with
<constant>CURLOPT_CUSTOMREQUEST</constant> in use for all requests, even
after redirects.
Available as of PHP 8.5.0 and cURL 8.13.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlfollow-obeycode">
<term>
<constant>CURLFOLLOW_OBEYCODE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Value for <constant>CURLOPT_FOLLOWLOCATION</constant> that enables following
redirects while obeying the HTTP response code: a custom request method set
with <constant>CURLOPT_CUSTOMREQUEST</constant> is kept, except that it is
changed to <literal>GET</literal> on the redirect status codes that require
it (such as 301, 302 and 303).
Available as of PHP 8.5.0 and cURL 8.13.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlfollow-firstonly">
<term>
<constant>CURLFOLLOW_FIRSTONLY</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Value for <constant>CURLOPT_FOLLOWLOCATION</constant> that enables following
redirects but uses a custom request method set with
<constant>CURLOPT_CUSTOMREQUEST</constant> for the first request only;
subsequent requests follow the method dictated by the redirect response code.
Available as of PHP 8.5.0 and cURL 8.13.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlftpauth-default">
<term>
<constant>CURLFTPAUTH_DEFAULT</constant>
Expand Down
60 changes: 60 additions & 0 deletions reference/curl/constants_curl_getinfo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,18 @@
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlinfo-conn-id">
<term>
<constant>CURLINFO_CONN_ID</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The ID of the last connection used by the transfer. The connection ID is unique among all connections using the same connection cache and is useful to tell connection reuse apart.
Available as of PHP 8.5.0 and cURL 8.2.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlinfo-connect-time">
<term>
<constant>CURLINFO_CONNECT_TIME</constant>
Expand Down Expand Up @@ -251,6 +263,18 @@
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlinfo-httpauth-used">
<term>
<constant>CURLINFO_HTTPAUTH_USED</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Bitmask indicating the HTTP authentication method(s) actually used in the previous request.
Available as of PHP 8.5.0 and cURL 8.12.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlinfo-http-code">
<term>
<constant>CURLINFO_HTTP_CODE</constant>
Expand Down Expand Up @@ -444,6 +468,18 @@
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlinfo-proxyauth-used">
<term>
<constant>CURLINFO_PROXYAUTH_USED</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Bitmask indicating the proxy authentication method(s) actually used in the previous request.
Available as of PHP 8.5.0 and cURL 8.12.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlinfo-proxy-error">
<term>
<constant>CURLINFO_PROXY_ERROR</constant>
Expand All @@ -468,6 +504,18 @@
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlinfo-queue-time-t">
<term>
<constant>CURLINFO_QUEUE_TIME_T</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The time, in microseconds, that the transfer was held in a waiting queue before it started, due to limits set with <constant>CURLMOPT_MAX_TOTAL_CONNECTIONS</constant> or similar options.
Available as of PHP 8.5.0 and cURL 8.6.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlinfo-redirect-count">
<term>
<constant>CURLINFO_REDIRECT_COUNT</constant>
Expand Down Expand Up @@ -776,6 +824,18 @@
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlinfo-used-proxy">
<term>
<constant>CURLINFO_USED_PROXY</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Whether the previous transfer used a proxy; returns <literal>1</literal> if a proxy was used and <literal>0</literal> otherwise.
Available as of PHP 8.5.0 and cURL 8.7.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlinfo-posttransfer-time-t">
<term>
<constant>CURLINFO_POSTTRANSFER_TIME_T</constant>
Expand Down
15 changes: 15 additions & 0 deletions reference/curl/constants_curl_setopt.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1380,6 +1380,21 @@
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlopt-infilesize-large">
<term>
<constant>CURLOPT_INFILESIZE_LARGE</constant>
(<type>int</type>)
</term>
<listitem>
<para>
The expected size, in bytes, of the file when uploading a file to
a remote site. This is the 64-bit variant of
<constant>CURLOPT_INFILESIZE</constant>, allowing sizes larger than
2 GB to be specified.
Available as of PHP 8.5.0.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlopt-interface">
<term>
<constant>CURLOPT_INTERFACE</constant>
Expand Down