mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 19:08:54 +00:00
c030e2adf7
- All id attributes are now xml:id - Add docbook namespace to all root elements - Replace <ulink /> with <link xlink:href /> - Minor markup fixes here and there git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@238160 c90b9560-bf6c-de11-be94-00142212c4b1
134 lines
3.9 KiB
XML
134 lines
3.9 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.10 $ -->
|
|
<refentry xml:id="function.mysqli-ssl-set" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>mysqli_ssl_set</refname>
|
|
<refname>mysqli->ssl_set()</refname>
|
|
<refpurpose>Used for establishing secure connections using SSL</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<para>Procedural style:</para>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>mysqli_ssl_set</methodname>
|
|
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>key</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>cert</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>ca</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>capath</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>cipher</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>Object oriented style (method):</para>
|
|
<classsynopsis>
|
|
<ooclass><classname>mysqli</classname></ooclass>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ssl_set</methodname>
|
|
<methodparam><type>string</type><parameter>key</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>cert</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>ca</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>capath</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>cipher</parameter></methodparam>
|
|
</methodsynopsis>
|
|
</classsynopsis>
|
|
<para>
|
|
Used for establishing secure connections using SSL. It must be called
|
|
before <function>mysqli_real_connect</function>. This function does
|
|
nothing unless OpenSSL support is enabled.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
&mysqli.link.description;
|
|
<varlistentry>
|
|
<term><parameter>key</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The path name to the key file.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>cert</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The path name to the certificate file.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>ca</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The path name to the certificate authority file.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>capath</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The pathname to a directory that contains trusted SSL CA certificates
|
|
in PEM format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>cipher</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A list of allowable ciphers to use for SSL encryption.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
<para>
|
|
Any unused SSL parameters may be given as &null;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
This function always returns &true; value. If SSL setup is
|
|
incorrect <function>mysqli_real_connect</function> will return an error
|
|
when you attempt to connect.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>mysqli_options</function></member>
|
|
<member><function>mysqli_real_connect</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:"../../../../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
|
|
-->
|