Added documentation for new GearmanWorker::setId() method.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@326992 c90b9560-bf6c-de11-be94-00142212c4b1

reference/gearman/gearmanworker/setid.xml

@@ -0,0 +1,92 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="function.func-name" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>GearmanWorker::setId</refname>
+  <refpurpose>Give the worker an identifier so it can be tracked when asking gearmand for the list of available workers.</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description"><!-- {{{ -->
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>bool</type><methodname>GearmanWorker::setId</methodname>
+   <methodparam><type>string</type><parameter>id</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Assigns the worker an identifier.
+  </para>
+ </refsect1><!-- }}} -->
+
+ <refsect1 role="parameters"><!-- {{{ -->
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>id</parameter></term>
+    <listitem>
+     <para>
+      A string identifier.
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1><!-- }}} -->
+
+ <refsect1 role="returnvalues"><!-- {{{ -->
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1><!-- }}} -->
+
+ <refsect1 role="examples"><!-- {{{ -->
+  &reftitle.examples;
+  <example><!-- {{{ -->
+   <title><function>GearmanWorker::setId</function> example</title>
+   <para>
+     Set an identifier for a simple worker.
+   </para>
+   <programlisting role="php">
+<![CDATA[
+<?php
+$worker= new GearmanWorker();
+$worker->setId('test');
+?>
+]]>
+   </programlisting>
+   &example.outputs.similar;
+   <screen>
+<![CDATA[
+Run the following command:
+gearadmin --workers
+
+Output:
+30 ::3a3a:3361:3361:3a33%976303667 - : test
+]]>
+   </screen>
+  </example><!-- }}} -->
+ </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
+-->