php8.5
Home/ Manual/ ssh2 / functions/ ssh2_sftp_lstat

ssh2_sftp_lstat

PHP function Edit on GitHub ✎

(PECL ssh2 >= 0.9.0)

Stat a symbolic link

Description

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 successFalseforfailure. See the documentation for stat() for details on the values which may be returned.

Examples

Stating a symbolic link via SFTP

php
<?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

Source: reference/ssh2/functions/ssh2-sftp-lstat.xml · from the official PHP manual (php/doc-en)