fileperms.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 871a231f4a1caa5fb258ae53b1bb7d1fb2a0f949 Maintainer: HonestQiao Status: ready -->
<!-- CREDITS: mowangjuanzi -->
<refentry xml:id="function.fileperms" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>fileperms</refname>
  <refpurpose>获取文件权限</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>int</type><type>false</type></type><methodname>fileperms</methodname>
   <methodparam><type>string</type><parameter>filename</parameter></methodparam>
  </methodsynopsis>
  <para>
   获取指定文件权限。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       文件的路径。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   以数字模式返回文件权限。此模式的低位与 <function>chmod</function>
   期望权限相同，然而在大多数平台上，返回值还将会包含指定 <parameter>filename</parameter>
   的文件类型信息。下面的示例示范了如何在 POSIX 系统上测试特定权限和文件类型的返回值。
  </para>
  <para>
   对于本地文件，特定的返回值是通过 C 库的 <function>stat</function> 函数返回结构中的
   <literal>st_mode</literal> 成员的值。Exactly which bits are set
   can vary from platform to platform, and looking up your specific platform's
   documentation is recommended if parsing the non-permission bits of the
   return value is required.
  </para>
  <para>
   失败时返回 &false;。
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  &fs.emits.warning.on.failure;
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>以八进制的形式显示文件的权限</title>
    <programlisting role="php">
<![CDATA[
<?php
echo substr(sprintf('%o', fileperms('/tmp')), -4);
echo substr(sprintf('%o', fileperms('/etc/passwd')), -4);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
1777
0644
]]>
    </screen>
   </example>
   <example>
    <title>输出全部权限</title>
    <programlisting role="php">
<![CDATA[
<?php
$perms = fileperms('/etc/passwd');

switch ($perms & 0xF000) {
    case 0xC000: // 套接字
        $info = 's';
        break;
    case 0xA000: // 符号链接
        $info = 'l';
        break;
    case 0x8000: // regular
        $info = 'r';
        break;
    case 0x6000: // 块设备
        $info = 'b';
        break;
    case 0x4000: // 目录
        $info = 'd';
        break;
    case 0x2000: // 字符设备
        $info = 'c';
        break;
    case 0x1000: // FIFO 管道
        $info = 'p';
        break;
    default: // 位置
        $info = 'u';
}

// 所有者
$info .= (($perms & 0x0100) ? 'r' : '-');
$info .= (($perms & 0x0080) ? 'w' : '-');
$info .= (($perms & 0x0040) ?
            (($perms & 0x0800) ? 's' : 'x' ) :
            (($perms & 0x0800) ? 'S' : '-'));

// 组
$info .= (($perms & 0x0020) ? 'r' : '-');
$info .= (($perms & 0x0010) ? 'w' : '-');
$info .= (($perms & 0x0008) ?
            (($perms & 0x0400) ? 's' : 'x' ) :
            (($perms & 0x0400) ? 'S' : '-'));

// 其它
$info .= (($perms & 0x0004) ? 'r' : '-');
$info .= (($perms & 0x0002) ? 'w' : '-');
$info .= (($perms & 0x0001) ?
            (($perms & 0x0200) ? 't' : 'x' ) :
            (($perms & 0x0200) ? 'T' : '-'));

echo $info;
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
-rw-r--r--
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &note.clearstatcache;
  &tip.fopen-wrapper.stat;
 </refsect1>

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