umask.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: ea62fb83196997032641b50fe44420305466195e Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.umask">
 <refnamediv>
  <refname>umask</refname>
  <refpurpose>現在の umask を変更する</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>umask</methodname>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>mask</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>umask</function> は PHP の umask を
   <parameter>mask</parameter> &amp; 0777 にセットし、
   元の umask 値を返します。
   PHP がサーバー・モジュールとして動作中の場合、
   各リクエストが終了するたびに umask は元の値に戻されます。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>mask</parameter></term>
     <listitem>
      <para>
       新しい umask。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <parameter>mask</parameter> が &null; の場合、
   <function>umask</function>は単に現在の umask 値を返します。
   そうでない場合、元の umask 値を返します。
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>mask</parameter> は、nullable になりました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>umask</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$old = umask(0);
chmod("/path/some_dir/some_file.txt", 0755);
umask($old);

// チェック
if ($old != umask()) {
    die('An error occurred while changing back the umask');
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    マルチスレッドな Web サーバーでこの関数を使用することは避けてください。
    ファイルを生成後、<function>chmod</function> を使用してファイル権限を
    変更するのがより良い方法です。全て同じ umask が使用されるので、
    <function>umask</function> の使用は、スクリプトを同時に実行する場合や
    Web サーバー自身の予期しない動作を引き起こす原因になる可能性があります。
   </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
-->