mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
ecaa214642
In Solr, Stomp, Yaf. Also include constructor and destructor in StreamWrapper interface synopsis
144 lines
3.9 KiB
XML
144 lines
3.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="solrclient.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>SolrClient::__construct</refname>
|
|
<refpurpose>Constructor for the SolrClient object</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<constructorsynopsis>
|
|
<modifier>public</modifier> <methodname>SolrClient::__construct</methodname>
|
|
<methodparam><type>array</type><parameter>clientOptions</parameter></methodparam>
|
|
</constructorsynopsis>
|
|
<para>
|
|
Constructor for the SolrClient object
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>clientOptions</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
This is an array containing one of the following keys :
|
|
</para>
|
|
<para>
|
|
|
|
<![CDATA[
|
|
- secure (Boolean value indicating whether or not to connect in secure mode)
|
|
- hostname (The hostname for the Solr server)
|
|
- port (The port number)
|
|
- path (The path to solr)
|
|
- wt (The name of the response writer e.g. xml, json)
|
|
- login (The username used for HTTP Authentication, if any)
|
|
- password (The HTTP Authentication password)
|
|
- proxy_host (The hostname for the proxy server, if any)
|
|
- proxy_port (The proxy port)
|
|
- proxy_login (The proxy username)
|
|
- proxy_password (The proxy password)
|
|
- timeout (This is maximum time in seconds allowed for the http data transfer operation. Default is 30 seconds)
|
|
- ssl_cert (File name to a PEM-formatted file containing the private key + private certificate (concatenated in that order) )
|
|
- ssl_key (File name to a PEM-formatted private key file only)
|
|
- ssl_keypassword (Password for private key)
|
|
- ssl_cainfo (Name of file holding one or more CA certificates to verify peer with)
|
|
- ssl_capath (Name of directory holding multiple CA certificates to verify peer with )
|
|
|
|
Please note the if the ssl_cert file only contains the private certificate, you have to specify a separate ssl_key file
|
|
|
|
The ssl_keypassword option is required if the ssl_cert or ssl_key options are set.
|
|
|
|
]]>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="errors">
|
|
&reftitle.errors;
|
|
<para>
|
|
Throws <classname>SolrIllegalArgumentException</classname> on failure.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><methodname>SolrClient::__construct</methodname> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
$options = array
|
|
(
|
|
'hostname' => SOLR_SERVER_HOSTNAME,
|
|
'login' => SOLR_SERVER_USERNAME,
|
|
'password' => SOLR_SERVER_PASSWORD,
|
|
'port' => SOLR_SERVER_PORT,
|
|
'path' => SOLR_PATH_TO_SOLR,
|
|
'wt' => 'xml',
|
|
);
|
|
|
|
$client = new SolrClient($options);
|
|
|
|
$doc = new SolrInputDocument();
|
|
|
|
$doc->addField('id', 334455);
|
|
$doc->addField('cat', 'Software');
|
|
$doc->addField('cat', 'Lucene');
|
|
|
|
$updateResponse = $client->addDocument($doc);
|
|
|
|
?>
|
|
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><methodname>SolrClient::getOptions</methodname></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
|
|
-->
|