php-doc-en/reference/curl/functions/curl-version.xml
Yannick Torres ee73d00557 Fix some literal tag
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@324741 c90b9560-bf6c-de11-be94-00142212c4b1
2012-04-03 08:26:39 +00:00

148 lines
3.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.curl-version" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>curl_version</refname>
<refpurpose>Gets cURL version information</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>curl_version</methodname>
<methodparam choice="opt"><type>int</type><parameter>age</parameter><initializer>CURLVERSION_NOW</initializer></methodparam>
</methodsynopsis>
<para>
Returns information about the cURL version.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>age</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an associative array with the following elements:
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Indice</entry>
<entry>Value description</entry>
</row>
</thead>
<tbody>
<row>
<entry>version_number</entry>
<entry>cURL 24 bit version number</entry>
</row>
<row>
<entry>version</entry>
<entry>cURL version number, as a string</entry>
</row>
<row>
<entry>ssl_version_number</entry>
<entry>OpenSSL 24 bit version number</entry>
</row>
<row>
<entry>ssl_version</entry>
<entry>OpenSSL version number, as a string</entry>
</row>
<row>
<entry>libz_version</entry>
<entry>zlib version number, as a string</entry>
</row>
<row>
<entry>host</entry>
<entry>Information about the host where cURL was built</entry>
</row>
<row>
<entry>age</entry>
<entry></entry>
</row>
<row>
<entry>features</entry>
<entry>A bitmask of the <literal>CURL_VERSION_XXX</literal> constants</entry>
</row>
<row>
<entry>protocols</entry>
<entry>An array of protocols names supported by cURL</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>curl_version</function> example</title>
<para>
This example will check which features that's available
in cURL build by using the <literal>'features'</literal> bitmask returned
by <function>curl_version</function>.
</para>
<programlisting role="php">
<![CDATA[
<?php
// Get curl version array
$version = curl_version();
// These are the bitfields that can be used
// to check for features in the curl build
$bitfields = Array(
'CURL_VERSION_IPV6',
'CURL_VERSION_KERBEROS4',
'CURL_VERSION_SSL',
'CURL_VERSION_LIBZ'
);
foreach($bitfields as $feature)
{
echo $feature . ($version['features'] & constant($feature) ? ' matches' : ' does not match');
echo PHP_EOL;
}
?>
]]>
</programlisting>
</example>
</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
-->