ftp_fget

(PHP 4, PHP 5, PHP 7, PHP 8)

ftp_fget — Télécharge un fichier via FTP dans un fichier local

Description

ftp_fget(
    FTP\Connection $ftp,
    resource $stream,
    string $remote_filename,
    int $mode = FTP_BINARY,
    int $offset = 0
): bool

ftp_fget() télécharge le fichier remote_filename depuis le serveur FTP et l'écrit dans le fichier identifié par stream.

Liste de paramètres

ftp: Une instance de FTP\Connection.
stream: Un pointeur de fichier ouvert dans lequel on écrit les données.
remote_filename: Le chemin vers le fichier distant.
mode: Le mode de transfert. Doit être soit FTP_ASCII, soit FTP_BINARY.
offset: La position du fichier distant à partir de laquelle le téléchargement commence.

Valeurs de retour

Cette fonction retourne true en cas de succès ou false si une erreur survient.

Historique

Version	Description
8.1.0	La paramètre `ftp` attend désormais une instance de FTP\Connection ; auparavant, une ressource était attendu.
7.3.0	Le paramètre `mode` est maintenant optionel. Précédemment il était obligatoire.

Exemples

Exemple #1 Exemple avec ftp_fget()

<?php

// Chemin vers le fichier distant
$remote_file = 'somefile.txt';
$local_file = 'localfile.txt';

// Ouverture du fichier pour écriture
$handle = fopen($local_file, 'w');

// Mise en place d'une connexion basique
$ftp = ftp_connect($ftp_server);

// Identification avec un nom d'utilisateur et un mot de passe
$login_result = ftp_login($ftp, $ftp_user_name, $ftp_user_pass);

// Tente de téléchargement le fichier $remote_file et de le sauvegarder dans $handle
if (ftp_fget($ftp, $handle, $remote_file, FTP_ASCII, 0)) {
 echo "Ecriture dans le fichier $local_file avec succès\n";
} else {
 echo "Il y a un problème lors du téléchargement du fichier $remote_file dans $local_file\n";
}

// Fermeture de la connexion et du pointeur de fichier
ftp_close($ftp);
fclose($handle);
?>

Voir aussi

ftp_get() - Télécharge un fichier depuis un serveur FTP
ftp_nb_get() - Lit un fichier sur un serveur FTP, et l'écrit dans un fichier (non bloquant)
ftp_nb_fget() - Lit un fichier sur un serveur FTP, et l'écrit dans un fichier (non bloquant)

add a note

User Contributed Notes 6 notes

down

broom at alturnanetworks dot com ¶

16 years ago


Another ftp_get_contents approach, using a temperary stream handler. Returns file contents as string. 



<?php

function ftp_get_contents ($conn_id, $filename,

//Create temp handler:

    $tempHandle = fopen('php://temp', 'r+');



//Get file from FTP assuming that it exists:

    ftp_fget($conn_id, $tempHandle, $filename, FTP_ASCII, 0));



    //Getting detailed stats to check filesize:

    $fstats = fstat($tempHandle);



    return fread($tempHandle, $fstats['size']);

}

?>

down

broom at alturnanetworks dot com ¶

16 years ago


<?php

/** 

 * Function returns contents via FTP connection and returns it as string (right version...)

 */

function ftp_get_contents ($conn_id, $filename) {

    //Create temp handler:

    $tempHandle = fopen('php://temp', 'r+');

    

    //Get file from FTP:

    if (@ftp_fget($conn_id, $tempHandle, $filename, FTP_ASCII, 0)) {

        rewind($tempHandle);

        return stream_get_contents($tempHandle);

    } else {

        return false;

    }

}

?>

down

lionskape at gmail dot com ¶

7 years ago


if you are using windows ftp-server with cp1251 encoding there are some troubles with russian "я" in filename\path.

php use telnet to connect ftp-server and there are special symbol with code 255 in telnet protocol. You can try use ftp_raw($connection, 'OPTS UTF8 ON'); and work in utf-8 (if server provides it).

P.S. sorry for my bad english

down

mike at eastghost dot com ¶

11 years ago


You might need to use ftp_pasv() if you're behind a firewall and receiving odd timeouts, file creation but now local data saving, etc.

down

-1

justrafi at gmail dot com ¶

16 years ago


I was in need to synchronize two folders on two separate servers, one is a Windows server, and the other is a Linux server. I created this short and sweet function to help me do this. PLEASE NOTICE: This will not copy folders, and probably will fail if remote folder contains anything else than files.

function sync_folders($host, $port, $username, $password, $remote_dir, $local_dir, $passive_mode = true) {
    $conn_id = ftp_connect($host, $port);
    if (!$conn_id) return false; # fail to connect
    if (!ftp_login($conn_id, $username, $password)) { ftp_close($conn_id); return false; }  # fail to login
    ftp_pasv($conn_id, $passive_mode);
    if (!ftp_chdir($conn_id, $remote_dir)) { ftp_close($conn_id); return false; } # fail to change dir
    if (substr($local_dir, -1) != '/') $local_dir .= '/';

    $list = ftp_nlist($conn_id, '.');
    sort($list);
    foreach ($list as $file) {
        if (!file_exists($local_dir . $file)) {
            $is_copied = ftp_get($conn_id, $local_dir . $file, $file, FTP_BINARY);
        }
    }
    ftp_close($conn_id);
    return true;
}

down

-3

rodrigo-rocha at oi dot net dot br ¶

22 years ago


If you suply only a filename to the second parameter of function the ftp_get will open a pointer to the local file creating it and write to it.It's ok if your server dont execute for to mutch time and you dont get too many files but if you do it too many times the pointers created by ftp_get will not be closed and will end your opened files capacity at your server making it to do not open any more files until you restart it.

add a note