FTP Klasse

In den folgenden Abschnitten werden die einzelnen Methoden der Klasse erklärt.

connect


public void connect ( string $host, boolean $ssl = false, integer $port = 21, integer $timeout = 90)

Stellt eine FTP / SSL FTP Verbindung mit dem Zielserver her.

Parameterliste
host

Die Host Adresse des Ziel FTP Servers.

ssl

Wenn eine SSL FTP Verbindung aufgebaut werden soll, kann hier der Parameter ssl auf den Wert true gesetzt werden. Standardmäßig auf false

port

Der Port auf dem die FTP Verbindung aufgebaut werden kann. Standardmäßig auf den Wert 21

timeout

Gibt an nach wievielen Sekunden der Versuch eine Verbindung aufzubauen abgebrochen werden soll.


login


public void login ( string $username, string $password)

Meldet sich mit den Zugangsdaten bei der bereits aufgebauten FTP / SSL FTP Verbindung an.

Parameterliste
username

Der Benutzername um sich bei der offenen FTP / SSL FTP Verbindung anzumelden.

password

Das Passwort zum dazugehörigen Benutzernamen um sich bei der offenen FTP / SSL FTP Verbindung anzumelden.


set_passive_modus


public void set_passive_modus ( )

Setzt die offene FTP / SSL FTP Verbindung in den Passiven Modus.


get_remote_file


public bool get_remote_file ( string $remoteFile, string $localeFile)

Lädt eine Datei vom FTP Server auf den lokalen Server.

Parameterliste
remoteFile

Der absolute Pfad zur FTP Server Datei. Hierbei können nur Dateien heruntergeladen werden. Ordner sind nicht erlaubt.

localeFile

Der absolute Pfad zur lokalen Datei. Hierbei reicht es nicht wenn nur das Verzeichnis angegeben wird. Der Dateiname der zu erstellenden Datei muss ebenfalls angegeben werden.


modified_time


public int|string|bool modified_time ( string $remoteFile, mixed $timeFormat = null)

Gibt den zuletzt bearbeitet UNIX Zeitstempel oder als Datum formatiert Zeitangabe der FTP Server Datei zurück.

Parameterliste
remoteFile

Der absolute Pfad zur FTP Server Datei. Hierbei können auch Ordner ausgewählt werden.

timeFormat

Hier kann man entscheiden ob das zuletzt bearbeitet als UNIX Zeitstempel oder als formatiertes Datum zurück gegeben werden soll. Wenn der Parameter auf null gesetzt ist, wird der UNIX Zeitstempel zurück gegeben. Andernfalls das formatierte Datum. Standardmäßig auf null gesetzt.


up


public bool up ( )

Steigt in der offenen FTP Verbindung ein Verzeichnis weiter nach oben, soweit möglich.


is_dir


public bool is_dir ( string $remoteFile = '.')

Kontrolliert ob der angegebene absolute FTP Server Pfad ein Verzeichnis ist.

Parameterliste
remoteFile

Der absolute FTP Server Pfad der kontrolliert werden soll ob es sich um ein Verzeichnis handelt. Standardmäßig auf . gesetzt.


count


public int count ( string $remoteDirectory = '.', string $type = null, bool $recursive = true)

Zählt den Inhalt eines FTP Server Verzeichnisses und gibt die Anzahl an gefundenen Elementen zurück.

Parameterliste
remoteDirectory

Der absolute Pfad zum FTP Server Verzeichnis dessen Inhalt gezählt werden soll.

type

Hier kann man entscheiden was für ein Typ beim Zählen berücksichtigt werden soll. Man kann zwischen file, directory, link oder null wählen. Bei null wird der komplette Inhalt gezählt. Standardmäßig auf null

recursive

Hier kann man entscheiden ob auch der Inhalt von Unterverzeichnissen mitgezählt werden soll. Standardmäßig auf true gesetzt.


is_empty


public bool is_empty ( string $remoteDirectory)

Kontrolliert ob ein FTP Server Verzeichnis leer ist.

Parameterliste
remoteDirectory

Der absolute Pfad zum FTP Server Verzeichnis.


put_from_path


public bool put_from_path ( string $local_file)

Lädt eine lokale Datei auf den FTP Server.

Parameterliste
locale_file

Der absolute Pfad zur lokalen Datei, die auf den FTP Server hochgeladen werden soll. Dabei wird sie in das aktuelle Verzeichnis der offenen FTP / SSL FTP Verbindung geladen.


put_all


public bool put_all ( string $source_directory, string $target_directory, int $mode = FTP_BINARY)

Lädt ein komplettes Verzeichnis samt Inhalt rekursiv ins FTP Server Verzeichnis.

Parameterliste
source_directory

Der lokale absolute Pfad zum Verzeichnis das auf den FTP Server hochgeladen werden soll.

target_directory

Der absolute Pfad zum FTP Server Zielverzeichnis in dem die Daten hochgeladen werden sollen.

mode

Der FTP Datentransfer Modus. Folgende stehen zur Verfügung:

  • FTP_ASCII
  • FTP_TEXT
  • FTP_BINARY
  • FTP_IMAGE


put_from_string


public bool put_from_string ( string $remote_file, $content)

Lädt den Inhalt einer Variable in eine FTP Server Datei.

Parameterliste
remote_file

Der absolute Pfad zur FTP Server Datei.

content

Der Inhalt der in die FTP Server Datei geschrieben werden soll.


dir_size


public int dir_size ( string $remoteDirectory = '.', bool $recursive = true)

Gibt die Ordner Größe eines FTP Server Verzeichnisses zurück.

Parameterliste
remoteDirectory

Der absolute Pfad zum FTP Server Verzeichnis.

recursive

Ob auch Unterverzeichnis Größen mit in die Ordner Größe einberechnet werden sollen. Standardmäßig auf true


nlist


public array nlist ( string $remoteDirectory = '.', boolean $recursive = false, string $filter = 'sort')

Listet den Inhalt eines FTP Server Verzeichnisses auf. Auch rekursiv möglich.

Parameterliste
remoteDirectory

Der absolute Pfad zum FTP Server Verzeichnis dessen Inhalt aufgelistet werden soll.

recursive

Ob auch Unterverzeichnisse aus dem FTP Server Verzeichniss mit inbegriffen sein sollen. Standardmäßig auf true

filter

Filtert das Ergebnis mit einer PHP Vordefinierten Funktion. Standardmäßig die PHP Funktion sort()


mkdir


public bool nlist ( string $remoteDirectory, $recursive = false)

Erstellt auf dem FTP Server ein Verzeichnis. Auch rekursiv möglich.

Parameterliste
remoteDirectory

Der absolute Pfad zum FTP Server Verzeichnis das erstellt werden soll.

recursive

Ob der FTP Server Pfad rekursiv angelegt werden soll. Standardmäßig auf true


remove


public bool remove ( string $remoteFile)

Löscht eine FTP Server Datei entgültig.

Parameterliste
remoteFile

Der absolute Pfad zur FTP Server Datei die gelöscht werden soll.


rmdir


public bool rmdir ( string $remoteDirectory, bool $recursive = false)

Löscht ein FTP Server Verzeichnis samt Inhalt. Auch rekursiv möglich.

Parameterliste
remoteDirectory

Der absolute FTP Server Pfad zum Verzeichnis das gelöscht werden soll.

recursive

Ob das FTP Server Verzeichnis rekursiv gelöscht werden soll. Standardmäßig auf true gesetzt.


clean_dir


public bool clean_dir ( string $remoteDirectory)

Säubert ein komplettes FTP Verzeichnis rekursiv.

Parameterliste
remoteDirectory

Der absolute Pfad zum FTP Server Verzeichnis das geleert werden soll.


scan_dir


public array scan_dir ( string $remoteDirectory = '.', $recursive = false)

Scannt ein FTP Verzeichnis, auch rekursiv, und liefert alle gefundenen Dateien und Ordner zurück.

Parameterliste
remoteDirectory

Der absolute Pfad zum FTP Verzeichnis das gescannt werden soll.

recursive

Ob auch Unterverzeichnisse mit in den Scan einbezogen werden sollen.


rawlist


public array rawlist ( string $remoteDirectory = '.', $recursive = false)

Beinhaltet die selbe Funktion wie die Methode scan_dir nur das diese Methode noch detailliertere Informationen zur Datei zurückliefern.

Parameterliste
remoteDirectory

Der absolute Pfad zum FTP Verzeichnis das gescannt werden soll.

recursive

Ob auch Unterverzeichnisse mit in den Scan einbezogen werden sollen.