php-doc-en/reference/posix/functions/posix-access.xml
2005-01-08 12:04:26 +00:00

128 lines
3.1 KiB
XML
Executable file

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.posix-access">
<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>
&note.sm.uidcheck;
</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="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
-->