svn: /phpdoc/en/trunk/reference/mongo/ mongoid/gethostname.xml versions.xml

kristina Wed, 23 Jun 2010 17:39:13 +0000 Revision: http://svn.php.net/viewvc?view=revision&revision=300699 Log: added gethostname method Changed paths: A phpdoc/en/trunk/reference/mongo/mongoid/gethostname.xml U phpdoc/en/trunk/reference/mongo/versions.xml Added: phpdoc/en/trunk/reference/mongo/mongoid/gethostname.xml =================================================================== --- phpdoc/en/trunk/reference/mongo/mongoid/gethostname.xml (rev 0) +++ phpdoc/en/trunk/reference/mongo/mongoid/gethostname.xml 2010-06-23 17:39:13 UTC (rev 300699) @@ -0,0 +1,69 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision$ --> + +<refentry xml:id="mongoid.gethostname" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>MongoId::getHostname</refname> + <refpurpose>Gets the hostname being used for this machine's ids</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier><modifier>static</modifier><type>string</type><methodname>MongoId::getHostname</methodname> + <void/> + </methodsynopsis> + <para> + This returns the hostname <classname>MongoId</classname> is using to + generate unique ids. This should be the same value + <function>gethostname</function> returns. + </para> + <para> + It is identical to the function: + </para> + <programlisting role="php"> +<![CDATA[ +<?php + +public static function getHostname() { + return gethostname(); +} + +?> +]]> + </programlisting> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the hostname. + </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 +--> Property changes on: phpdoc/en/trunk/reference/mongo/mongoid/gethostname.xml ___________________________________________________________________ Added: svn:keywords + Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL Modified: phpdoc/en/trunk/reference/mongo/versions.xml =================================================================== --- phpdoc/en/trunk/reference/mongo/versions.xml 2010-06-23 17:32:16 UTC (rev 300698) +++ phpdoc/en/trunk/reference/mongo/versions.xml 2010-06-23 17:39:13 UTC (rev 300699) @@ -120,6 +120,7 @@ <function name='mongoid::getTimestamp' from='PECL mongo &gt;= 1.0.1'/> <function name='mongoid::__tostring' from='PECL mongo &gt;= 0.8.0'/> <function name='mongoid::__set_state' from='PECL mongo &gt;= 1.0.8'/> + <function name='mongoid::getHostname' from='PECL mongo &gt;= 1.0.8'/> <!-- MongoRegex --> <function name='mongoregex::__construct' from='PECL mongo &gt;= 0.8.1'/> <function name='mongoregex::__tostring' from='PECL mongo &gt;= 0.8.1'/>