mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 02:48:56 +00:00
c030e2adf7
- All id attributes are now xml:id - Add docbook namespace to all root elements - Replace <ulink /> with <link xlink:href /> - Minor markup fixes here and there git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@238160 c90b9560-bf6c-de11-be94-00142212c4b1
116 lines
2.8 KiB
XML
116 lines
2.8 KiB
XML
<?xml version='1.0' encoding='iso-8859-1'?>
|
|
<!-- $Revision: 1.6 $ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ssh2-sftp-stat">
|
|
<refnamediv>
|
|
<refname>ssh2_sftp_stat</refname>
|
|
<refpurpose>Stat a file on a remote filesystem</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>ssh2_sftp_stat</methodname>
|
|
<methodparam><type>resource</type><parameter>sftp</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>path</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Stats a file on the remote filesystem following any symbolic links.
|
|
</para>
|
|
<para>
|
|
This function is similar to using the <function>stat</function> function
|
|
with the <link linkend="wrappers.ssh2">ssh2.sftp://</link> wrapper in PHP5
|
|
and returns the same values.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>sftp</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>path</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
See the documentation for <function>stat</function> for details on the
|
|
values which may be returned.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Stating a file via SFTP</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$connection = ssh2_connect('shell.example.com', 22);
|
|
ssh2_auth_password($connection, 'username', 'password');
|
|
|
|
$sftp = ssh2_sftp($connection);
|
|
$statinfo = ssh2_sftp_stat($sftp, '/path/to/file');
|
|
|
|
$filesize = $statinfo['size'];
|
|
$group = $statinfo['gid'];
|
|
$owner = $statinfo['uid'];
|
|
$atime = $statinfo['atime'];
|
|
$mtime = $statinfo['mtime'];
|
|
$mode = $statinfo['mode'];
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>ssh2_sftp_lstat</function></member>
|
|
<member><function>lstat</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:"../../../../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
|
|
-->
|