getcwd.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/dir.xml, last change in rev 1.7 -->
<refentry xml:id="function.getcwd" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>getcwd</refname>
  <refpurpose>Gets the current working directory</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>getcwd</methodname>
   <void/>
  </methodsynopsis>
  <para>
   Gets the current working directory.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the current working directory on success, or &false; on
   failure.
  </para> 
  <para>
   On some Unix variants, <function>getcwd</function> will return
   &false; if any one of the parent directories does not have the
   readable or search mode set, even if the current directory
   does. See <function>chmod</function> for more information on
   modes and permissions.
  </para>
 </refsect1>

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

// current directory
echo getcwd() . "\n";

chdir('cvs');

// current directory
echo getcwd() . "\n";

?>
]]>
     </programlisting>
     &example.outputs.similar;
     <screen>
<![CDATA[
/home/didou
/home/didou/cvs
]]>
     </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  <caution>
   <para>
    If the PHP interpreter has been built with ZTS (Zend Thread Safety) enabled,
    the current working directory returned by <function>getcwd</function>
    may be different from that returned by operating system interfaces.
    External libraries (invoked through <link linkend="book.ffi">FFI</link>)
    which depend on the current working directory will be affected.
   </para>
  </caution>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>chdir</function></member>
    <member><function>chmod</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:"~/.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
-->