File: posix-access.xml

package info (click to toggle)
php-doc 20081024-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 57,752 kB
  • ctags: 3,858
  • sloc: xml: 686,554; php: 19,446; perl: 610; cpp: 500; makefile: 336; sh: 114; awk: 28
file content (130 lines) | stat: -rwxr-xr-x 3,278 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.posix-access" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>posix_access</refname>
  <refpurpose>
   Determine accessibility of a file
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>posix_access</methodname>
   <methodparam><type>string</type><parameter>file</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>posix_access</function> checks the user's permission of a file.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>file</parameter></term>
      <listitem>
       <para>
        The name of the file to be tested.
       </para>
      </listitem>
     </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
      <listitem>
       <para>
        A mask consisting of one or more of <constant>POSIX_F_OK</constant>,
        <constant>POSIX_R_OK</constant>, <constant>POSIX_W_OK</constant> and
        <constant>POSIX_X_OK</constant>. Defaults to
        <constant>POSIX_F_OK</constant>.
       </para>
       <para>
        <constant>POSIX_R_OK</constant>, <constant>POSIX_W_OK</constant> and
        <constant>POSIX_X_OK</constant> request checking whether the file
        exists and has read, write and execute permissions, respectively.
        <constant>POSIX_F_OK</constant> just requests checking for the
        existence of the file.
       </para>
      </listitem>
     </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>posix_access</function> example</title>
    <para>
     This example will check if the $file is readable and writable, otherwise
     will print an error message.
    </para>
    <programlisting role="php">
<![CDATA[
<?php

$file = 'some_file';

if (posix_access($file, POSIX_R_OK | POSIX_W_OK)) {
    echo 'The file is readable and writable!';

} else {
    $error = posix_get_last_error();

    echo "Error $error: " . posix_strerror($error);
}

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &note.sm.uidcheck;
 </refsect1>

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