php-doc-en/reference/amqp/amqpconnection/construct.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="amqpconnection.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>AMQPConnection::__construct</refname>
  <refpurpose>Create an instance of AMQPConnection</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <methodname>AMQPConnection::__construct</methodname>
   <methodparam choice="opt"><type>array</type><parameter>credentials</parameter><initializer>array()</initializer></methodparam>
  </methodsynopsis>
  <para>
   Creates an <classname>AMQPConnection</classname> instance representing a connection to an AMQP broker.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>credentials</parameter></term>
     <listitem>
      <para>
       The <parameter>credentials</parameter> is an optional array of credential information for connecting to the AMQP
       broker.
      </para>
      <table>
       <title>Supported indexes</title>
       <tgroup cols="3">
        <thead>
         <row>
          <entry>key</entry>
          <entry>Description</entry>
          <entry>Default value</entry>
         </row>
        </thead>
        <tbody>
         <row>
          <!-- FIXME: WTF? Seriously? 32char max? -->
          <entry><emphasis>host</emphasis></entry>
          <entry>The host to connect too <note><simpara>Max 32 characters</simpara></note></entry>
          <entry><link linkend="ini.amqp.host">amqp.host</link></entry>
         </row>
         <row>
          <entry><emphasis>port</emphasis></entry>
          <entry>Port on the host</entry>
          <entry><link linkend="ini.amqp.port">amqp.port</link></entry>
         </row>
         <row>
          <entry><emphasis>vhost</emphasis></entry>
          <entry>The virtual host on the host <note><simpara>Max 32 characters</simpara></note></entry>
          <entry><link linkend="ini.amqp.vhost">amqp.vhost</link></entry>
         </row>
         <row>
          <entry><emphasis>login</emphasis></entry>
          <entry>The login name to use. <note><simpara>Max 32 characters</simpara></note></entry>
          <entry><link linkend="ini.amqp.login">amqp.login</link></entry>
         </row>
         <row>
          <entry><emphasis>password</emphasis></entry>
          <entry>Password <note><simpara>Max 32 characters</simpara></note></entry>
          <entry><link linkend="ini.amqp.password">amqp.password</link></entry>
         </row>
        </tbody>
       </tgroup>
      </table>
      <para>All other keys will be ignored.</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   An AMQPConnection object.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Throws <classname>AMQPException</classname> exception on parameter parsing
   failures, and option errors.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>AMQPConnection::__construct</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php

/* Create a connection using the INI values */
$connection1 = new AMQPConnection();

/* Specifying all keys */
$connection2 = new AMQPConnection(array(
    'host' => 'example.host',
    'vhost' => '/',
    'port' => 5763,
    'login' => 'user',
    'password' => 'password'
));

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    A connection will not be established untill
    <methodname>AMQPConnection::connect</methodname> is called.
   </para>
  </note>
 </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
-->