doc-fr/reference/filesystem/functions/fileperms.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 871a231f4a1caa5fb258ae53b1bb7d1fb2a0f949 Maintainer: jpauli Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.fileperms" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>fileperms</refname>
  <refpurpose>Lit les droits d'un fichier</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>
   Lit les droits du fichier donné.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       Chemin vers le fichier.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne les permissions du fichier sous forme numérique. Les bits de poids
   faible sont les mêmes que ceux des permissions dans <function>chmod</function>,
   cependant certaines plateformes incluent dans le retour des informations sur
   le type de fichier donné dans <parameter>filename</parameter>. Les exemples
   qui suivent montrent comment tester la valeur de retour concernant les
   permissions et le type de fichier sur des systèmes POSIX comme Linux ou macOS.
  </para>
  <para>
   Pour les fichiers locaux, la valeur spécifique <literal>st_mode</literal>
   de la structure C retournée par la fonction <function>stat</function> est utilisée.
   Les bits affectés peuvent changer en fonction de la plateforme et vous devriez
   vous renseigner à son sujet si vous devez analyser les bits ne concernant
   pas la permission.
  </para>
  <para>
   Returns &false; on failure.
  </para>
 </refsect1>

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

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Affichage des droits en valeur octale</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>Affichage de tous les droits</title>
    <programlisting role="php">
<![CDATA[
<?php
$perms = fileperms('/etc/passwd');

switch ($perms & 0xF000) {
    case 0xC000: // Socket
        $info = 's';
        break;
    case 0xA000: // Lien symbolique
        $info = 'l';
        break;
    case 0x8000: // Régulier
        $info = 'r';
        break;
    case 0x6000: // Block special
        $info = 'b';
        break;
    case 0x4000: // dossier
        $info = 'd';
        break;
    case 0x2000: // Caractère spécial
        $info = 'c';
        break;
    case 0x1000: // pipe FIFO
        $info = 'p';
        break;
    default: // Inconnu
        $info = 'u';
}

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

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

// Tout le monde
$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
-->