ssh2_sftp_lstat

(PECL ssh2 >= 0.9.0)

ssh2_sftp_lstatStat a symbolic link

Description

function ssh2_sftp_lstat(resource $sftp, string $path): array|false

Stats a symbolic link on the remote filesystem without following the link.

This function is similar to using the lstat() function with the ssh2.sftp:// wrapper and returns the same values.

Parameters

sftp
An SSH2 SFTP resource opened by ssh2_sftp().
path
Path to the remote symbolic link.

Return Values

Returns an array of statistics for the given symbolic link on success or false on failure. See the documentation for stat() for details on the values which may be returned.

Examples

Example #1 Stating a symbolic link via SFTP

<?php
$connection = ssh2_connect('shell.example.com', 22);
ssh2_auth_password($connection, 'username', 'password');

$sftp = ssh2_sftp($connection);
$statinfo = ssh2_sftp_lstat($sftp, '/path/to/symlink');

$filesize = $statinfo['size'];
$group = $statinfo['gid'];
$owner = $statinfo['uid'];
$atime = $statinfo['atime'];
$mtime = $statinfo['mtime'];
$mode = $statinfo['mode'];
?>

See Also

  • ssh2_sftp_stat() - Stat a file on a remote filesystem
  • lstat() - Gives information about a file or symbolic link
  • stat() - Gives information about a file