<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Stat a file on a remote filesystem</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ssh2-sftp-rmdir.html">ssh2_sftp_rmdir</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ssh2-sftp-symlink.html">ssh2_sftp_symlink</a></div>
<div class="up"><a href="ref.ssh2.html">SSH2 Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.ssh2-sftp-stat" class="refentry">
<div class="refnamediv">
<h1 class="refname">ssh2_sftp_stat</h1>
<p class="verinfo">(PECL ssh2 >= 0.9.0)</p><p class="refpurpose"><span class="refname">ssh2_sftp_stat</span> — <span class="dc-title">Stat a file on a remote filesystem</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ssh2-sftp-stat-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>ssh2_sftp_stat</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$sftp</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$path</code></span>
)</div>
<p class="para rdfs-comment">
Stats a file on the remote filesystem following any symbolic links.
</p>
<p class="para">
This function is similar to using the <span class="function"><a href="function.stat.html" class="function">stat()</a></span> function
with the <a href="wrappers.ssh2.html" class="link">ssh2.sftp://</a> wrapper in PHP 5
and returns the same values.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ssh2-sftp-stat-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">sftp</code></em></span>
<dd>
<p class="para">
An SSH2 SFTP resource opened by <span class="function"><a href="function.ssh2-sftp.html" class="function">ssh2_sftp()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">path</code></em></span>
<dd>
<p class="para">
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ssh2-sftp-stat-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
See the documentation for <span class="function"><a href="function.stat.html" class="function">stat()</a></span> for details on the
values which may be returned.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.ssh2-sftp-stat-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4626">
<p><strong>Example #1 Stating a file via SFTP</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$connection </span><span style="color: #007700">= </span><span style="color: #0000BB">ssh2_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'shell.example.com'</span><span style="color: #007700">, </span><span style="color: #0000BB">22</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">ssh2_auth_password</span><span style="color: #007700">(</span><span style="color: #0000BB">$connection</span><span style="color: #007700">, </span><span style="color: #DD0000">'username'</span><span style="color: #007700">, </span><span style="color: #DD0000">'password'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$sftp </span><span style="color: #007700">= </span><span style="color: #0000BB">ssh2_sftp</span><span style="color: #007700">(</span><span style="color: #0000BB">$connection</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$statinfo </span><span style="color: #007700">= </span><span style="color: #0000BB">ssh2_sftp_stat</span><span style="color: #007700">(</span><span style="color: #0000BB">$sftp</span><span style="color: #007700">, </span><span style="color: #DD0000">'/path/to/file'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$filesize </span><span style="color: #007700">= </span><span style="color: #0000BB">$statinfo</span><span style="color: #007700">[</span><span style="color: #DD0000">'size'</span><span style="color: #007700">];<br /></span><span style="color: #0000BB">$group </span><span style="color: #007700">= </span><span style="color: #0000BB">$statinfo</span><span style="color: #007700">[</span><span style="color: #DD0000">'gid'</span><span style="color: #007700">];<br /></span><span style="color: #0000BB">$owner </span><span style="color: #007700">= </span><span style="color: #0000BB">$statinfo</span><span style="color: #007700">[</span><span style="color: #DD0000">'uid'</span><span style="color: #007700">];<br /></span><span style="color: #0000BB">$atime </span><span style="color: #007700">= </span><span style="color: #0000BB">$statinfo</span><span style="color: #007700">[</span><span style="color: #DD0000">'atime'</span><span style="color: #007700">];<br /></span><span style="color: #0000BB">$mtime </span><span style="color: #007700">= </span><span style="color: #0000BB">$statinfo</span><span style="color: #007700">[</span><span style="color: #DD0000">'mtime'</span><span style="color: #007700">];<br /></span><span style="color: #0000BB">$mode </span><span style="color: #007700">= </span><span style="color: #0000BB">$statinfo</span><span style="color: #007700">[</span><span style="color: #DD0000">'mode'</span><span style="color: #007700">];<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.ssh2-sftp-stat-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.ssh2-sftp-lstat.html" class="function" rel="rdfs-seeAlso">ssh2_sftp_lstat()</a> - Stat a symbolic link</span></li>
<li class="member"> <span class="function"><a href="function.lstat.html" class="function" rel="rdfs-seeAlso">lstat()</a> - Gives information about a file or symbolic link</span></li>
<li class="member"> <span class="function"><a href="function.stat.html" class="function" rel="rdfs-seeAlso">stat()</a> - Gives information about a file</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ssh2-sftp-rmdir.html">ssh2_sftp_rmdir</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ssh2-sftp-symlink.html">ssh2_sftp_symlink</a></div>
<div class="up"><a href="ref.ssh2.html">SSH2 Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
