Aller au contenu

ftp_nlist()

Comprendre la fonction PHP ftp_nlist()

La fonction ftp_nlist() est une fonction PHP intégrée qui retourne un tableau de noms de fichiers dans le répertoire spécifié sur le serveur FTP. Dans cet article, nous examinerons cette fonction en détail et vous fournirons un guide complet pour l'utiliser dans vos projets PHP.

Qu'est-ce que ftp_nlist() ?

La fonction ftp_nlist() est une fonction PHP intégrée qui retourne un tableau de noms de fichiers dans le répertoire spécifié sur le serveur FTP. Notez que les noms de fichiers retournés n'incluent pas le préfixe du répertoire. La fonction prend deux paramètres :

  1. ftp_stream : L'objet FTP\Connection retourné par la fonction ftp_connect().
  2. directory : Le chemin du répertoire sur le serveur FTP.

La fonction retourne un tableau de noms de fichiers en cas de succès. Sinon, elle retourne false.

Syntaxe de ftp_nlist()

La syntaxe de la fonction ftp_nlist() est la suivante :

Syntaxe de ftp_nlist()

php
array ftp_nlist ( FTP\Connection $ftp_stream , string $directory )

La fonction ftp_nlist() prend deux paramètres obligatoires, ftp_stream et directory. Le paramètre ftp_stream est l'objet FTP\Connection retourné par la fonction ftp_connect(). Le paramètre directory est le chemin vers le répertoire sur le serveur FTP que vous souhaitez lister.

Utilisation de ftp_nlist()

Pour utiliser la fonction ftp_nlist(), vous devez d'abord établir une connexion au serveur FTP à l'aide de la fonction ftp_connect(). Voici un exemple :

Utilisation de ftp_nlist()

php
<?php

// Set up an FTP connection
$conn = ftp_connect('ftp.example.com');
if (!$conn) {
    die('Could not connect to FTP server.');
}

// Login with your FTP credentials
if (!ftp_login($conn, 'username', 'password')) {
    die('Login failed.');
}

// Enable passive mode (often required for directory listings)
ftp_pasv($conn, true);

// Get an array of filenames in the specified directory
$files = ftp_nlist($conn, '/public_html/');

// Output the array of filenames
print_r($files);

// Close the FTP connection
ftp_close($conn);

Dans cet exemple, nous établissons une connexion au serveur FTP à l'aide de la fonction ftp_connect() et vérifions qu'elle a réussi. Ensuite, nous nous connectons avec nos identifiants FTP à l'aide de la fonction ftp_login() et vérifions le succès de la connexion. Nous activons le mode passif, qui est souvent nécessaire pour que ftp_nlist() fonctionne correctement sur différents serveurs FTP. Nous obtenons un tableau de noms de fichiers dans le répertoire spécifié à l'aide de la fonction ftp_nlist() et affichons ce tableau à l'aide de la fonction print_r(). Enfin, nous fermons la connexion FTP à l'aide de la fonction ftp_close().

Gestion des erreurs dans ftp_nlist()

Il est important de gérer correctement les erreurs lors de l'utilisation de la fonction ftp_nlist(). Si la fonction retourne false, cela signifie que le listing a échoué. Notez qu'un répertoire vide retourne un tableau vide [], et non false. Voici un exemple de gestion des erreurs :

Gestion des erreurs dans ftp_nlist()

php
<?php

// $conn is assumed to be established from the previous example
$file_list = ftp_nlist($conn, '/public_html/');

if ($file_list === false) {
    echo "Failed to list directory on remote server.\n";
}

ftp_close($conn);

En gérant correctement les erreurs et en vérifiant la valeur de retour de la fonction, vous pouvez garantir le succès de vos opérations FTP à l'aide de la fonction ftp_nlist().

Conclusion

En conclusion, la fonction ftp_nlist() est un outil utile pour lister les noms de fichiers dans un répertoire sur un serveur FTP. Avec une utilisation appropriée et une gestion des erreurs, cette fonction peut s'avérer un atout précieux dans vos projets PHP.

Practice

What are the important things to know about the FTP nlist function in PHP?

Trouvez-vous cela utile?

Aperçu dual-run — comparez avec les routes Symfony en production.