PHP Portal » PHP Handbuch » curl_setopt

Werbung

curl_setopt


(PHP 4 >= 4.0.2, PHP 5)

curl_setoptEine Option für einen cURL Transfer setzen

Beschreibung

bool curl_setopt ( resource $ch , int $option , mixed $value )

Setzt eine Option für das angegeben cURL-Handle

Parameter-Liste

ch

Ein von curl_init() zurückgegebenes cURL-Handle.

option

Die zu setzende CURLOPT_XXX-Option

value

Der Wert für value

value sollte ein boolean für die folgenden Werte des Parameters option sein:

Option Wert für value Anmerkungen
CURLOPT_AUTOREFERER TRUE um automatisch den Referer: in Abfragen zu setzen, die einem Redirect per Location: folgen Verfügbar seit PHP 5.1.0.
CURLOPT_BINARYTRANSFER TRUE um die unbearbeiteten Daten zurüchzugeben wenn CURLOPT_RETURNTRANSFER gesetzt ist.
CURLOPT_COOKIESESSION TRUE um diesen Request als neue "Cookie Session" zu behandeln. Somit wird libcurl alle cookies die geladen werden sollen ignorieren, sofern es sich um "Session Cookies" einer vorherigen Session handelt. Standardmässig lädt und speichert libcurl alle cookies, unabhängig davon, ob es "Session Cookies" sind. Bei "Session Cookies" handelt es sich um Cookies ohne Ablaufdatum, die nur für die aktuelle Session gültig sind. Verfügbar seit PHP 5.1.0.
CURLOPT_CRLF TRUE um Unix-Zeilenumbrüche beim Transfer in CRLF-Zeilenumbrüche umzuwandeln.
CURLOPT_DNS_USE_GLOBAL_CACHE TRUE um den globalen DNS-Cache zu nutzen. Diese Option ist nicht thread-safe und standardmässig aktiviert.
CURLOPT_FAILONERROR TRUE um PHP anzuweisen, bei Fehlern (HTTP-Code ist größer oder gleich 400) ohne Fehlermeldung weiter zu arbeiten. Dieses Verhalten ist standardmässig aktiviert.
CURLOPT_FILETIME TRUE um zu versuchen, das Änderungsdatum des serverseitigen Dokuments zu ermitteln. Der Wert kann über die Funktion curl_getinfo() unter Verwendung des Parameters CURLINFO_FILETIME ermittelt werden.
CURLOPT_FOLLOWLOCATION TRUE um jedem "Location: "-Header zu folgen, den der Server als Teil der HTTP-Header zurückgibt. Die Verarbeitung erfolgt rekursiv, PHP wird jedem "Location: "-Header folgen, sofern nicht CURLOPT_MAXREDIRS gesetzt ist.
CURLOPT_FORBID_REUSE TRUE um die Verbindung nach der Verarbeitung explizit zu schließen, so daß sie nicht wiederverwendet werden kann.
CURLOPT_FRESH_CONNECT TRUE um den expliziten Aufbau einer neuen Verbindung zu erzwingen, anstatt auf eine gecachte zurückzugreifen.
CURLOPT_FTP_USE_EPRT TRUE, um EPRT (und LPRT) für aktive FTP-Downloads zu nutzen. Auf FALSE setzen, um EPRT und LPRT zu deaktivieren und ausschließlich PORT zu nutzen. Verfügbar seit PHP 5.0.0.
CURLOPT_FTP_USE_EPSV TRUE um vor dem Fallback auf PASV zunächst eine EPSV-Anweisung für einen FTP-Transfer auszuführen. Auf FALSE setzen, um EPSV zu deaktivieren.
CURLOPT_FTPAPPEND TRUE um Daten an die serverseitige Datei anzuhängen anstatt diese zu überschreiben.
CURLOPT_FTPASCII Ein Alias für CURLOPT_TRANSFERTEXT, das bevorzugt werden sollte.
CURLOPT_FTPLISTONLY TRUE um nur die Namen in einem FTP-Verzeichnis aufzulisten.
CURLOPT_HEADER TRUE um den Header in die Ausgabe aufzunehmen.
CURLOPT_HTTPGET TRUE um die HTTP-Request-Methode auf GET zu setzen. Da dies die Standard-Methode ist sollte dies nur nach einem Wechsel der Request-Methode notwendig sein.
CURLOPT_HTTPPROXYTUNNEL TRUE um einen vorhandenen Proxy-Tunnel zu nutzen
CURLOPT_MUTE TRUE um jegliche Ausgabe der cURL-Funktionen zu unterbinden
CURLOPT_NETRC TRUE um die lokale Datei ~/.netrc nach Benutzername/Passwort für die Authorisierung des Zugriffs zu durchsuchen.
CURLOPT_NOBODY TRUE um den Body nicht in die Ausgabe aufzunehmen.
CURLOPT_NOPROGRESS

TRUE um die Fortschrittsanzeige für den Transfer auszublenden.

Hinweis: PHP setzt die Option automatisch auf TRUE. Dies sollte ausschließlich für die Fehlersuche geändert werden.

CURLOPT_NOSIGNAL TRUE um jegliche cURL-Funktion zu ignorieren, die ein Signal an den PHP-Prozess sendet. In multi-threaded SAPIs ist diese Option standardmässig aktiviert, so daß Timeouts weiterhin abgefangen werden können. Hinzugefügt in cURL 7.10 und PHP 5.0.0.
CURLOPT_POST TRUE um einen HTTP-POST-Request abzusetzen. Dabei handelt es sich um das übliche application/x-www-form-urlencoded, wie es im Allgemeinen von HTML-Formularen erzeugt wird.
CURLOPT_PUT TRUE um ein HTTP-PUT für eine Datei abzusetzen. Die fragliche Datei muss dabei über die Konstanten CURLOPT_INFILE und CURLOPT_INFILESIZE gesetzt werden.
CURLOPT_RETURNTRANSFER TRUE um den Tranfer als String zurückzuliefern, anstatt ihn direkt auszugeben.
CURLOPT_SSL_VERIFYPEER FALSE um die Überprüfung des Peerzertifikats seitens cURL zu unterdrücken. Alternative Zertifikate zur Überprüfung können mit der Option CURLOPT_CAINFO angegeben werden oder ein Zertifikat-Verzeichniss kann mit CURLOPT_CAPATH ausgewiesen werden. Ebenso muß CURLOPT_SSL_VERIFYHOST ggf. auf TRUE oder FALSE gesetzt werden, sofern CURLOPT_SSL_VERIFYPEER deaktiviert ist. TRUE als Standard seit cURL 7.10.
CURLOPT_TRANSFERTEXT TRUE um FTP-Transfers im ASCII-Modus durchzuführen. Für LDAP werden Daten in Klartext statt HTML übertragen. Unter Windows wird STDOUT nicht in den binären Modus gesetzt.
CURLOPT_UNRESTRICTED_AUTH TRUE um beim Folgen eines Location: -Headers (siehe CURLOPT_FOLLOWLOCATION) weiterhin Benutzername und Passwort zu senden, sogar nach einem Wechsel des Hostnamens. Hinzugefügt in PHP 5.0.0.
CURLOPT_UPLOAD TRUE um einen Upload vorzubereiten
CURLOPT_VERBOSE TRUE um ausführliche Informationen auszugeben, entweder nach STDERR oder in die mittels der Option CURLOPT_STDERR gewählte Datei.

Für die folgenden option -Parameter sollte value ein Integer sein:

Option Wert für value Anmerkungen
CURLOPT_BUFFERSIZE Die für jede Leseoperation zulässige Buffergröße. Es ist nicht garantiert, daß diese Einstellung genutzt wird. Hinzugefügt in cURL 7.10 and PHP 5.0.0.
CURLOPT_CLOSEPOLICY Sollte entweder CURLCLOSEPOLICY_LEAST_RECENTLY_USED oder CURLCLOSEPOLICY_OLDEST . Zwar existieren drei weitere CURLCLOSEPOLICY_-Konstanten, diese werden allerdings bisher nicht von cURL unterstützt.
CURLOPT_CONNECTTIMEOUT Die Anzahl Sekunden, die der Verbindungsaufbau maximal dauern darf; 0 hebt die Begrenzung auf.
CURLOPT_DNS_CACHE_TIMEOUT Die Dauer in Sekunden, die ein DNS-Eintrag im Speicher gehalten wird. Der Standard sind 120 Sekunden (2 Minuten).
CURLOPT_FTPSSLAUTH Die FTP-Authentisierungsmethode (wenn aktiviert): CURLFTPAUTH_SSL (versuche zunächst SSL), CURLFTPAUTH_TLS (versuche zunächst TLS), oder CURLFTPAUTH_DEFAULT (lass cURL entscheiden). Hinzugefügt in cURL 7.12.2 und PHP 5.1.0.
CURLOPT_HTTP_VERSION CURL_HTTP_VERSION_NONE (Standard, lässt cURL entscheiden, welche Version genutzt werden soll), CURL_HTTP_VERSION_1_0 (nutze HTTP/1.0), or CURL_HTTP_VERSION_1_1 (nutze HTTP/1.1).
CURLOPT_HTTPAUTH

Die zu nutzende HTTP-Authentisierungsmethode; zur Verfügung stehen: CURLAUTH_BASIC , CURLAUTH_DIGEST , CURLAUTH_GSSNEGOTIATE , CURLAUTH_NTLM , CURLAUTH_ANY , und CURLAUTH_ANYSAFE .

Um mehrere Methoden zu kombinieren kann der Bit-|(oder)-Operator verwendet werden; in diesem Fall wird cURL in Abstimmung mit dem Server die günstigste Methode auswählen.

CURLAUTH_ANY ist ein Alias für CURLAUTH_BASIC | CURLAUTH_DIGEST | CURLAUTH_GSSNEGOTIATE | CURLAUTH_NTLM.

CURLAUTH_ANYSAFE ist ein Alias für CURLAUTH_DIGEST | CURLAUTH_GSSNEGOTIATE | CURLAUTH_NTLM.

Hinzugefügt in PHP 5.0.0.
CURLOPT_INFILESIZE Die erwartete Dateigröße der hochzuladenden Datei in Bytes
CURLOPT_LOW_SPEED_LIMIT Die Transfergeschwindigkeit in Bytes pro Sekunde, die bei Unterschreitung in Kombination mit der Überschreitung von CURLOPT_LOW_SPEED_TIME Sekunden bewirkt, dass der Transfer aufgrund der zu niedrigen Transferrate abgebrochen wird.
CURLOPT_LOW_SPEED_TIME Die Zeit in Sekunden, in der die Transferrate unter CURLOPT_LOW_SPEED_LIMIT gedultet wird. Nach dieser Zeit wird die Transferrate als zu langsam angesehen und der Transfer wird beendet.
CURLOPT_MAXCONNECTS Die maximal erlaubte Anzahl persistenter Verbindungen; bei Erreichen des Limits wird mittels CURLOPT_CLOSEPOLICY entschieden, welche Verbindung geschlossen wird.
CURLOPT_MAXREDIRS Die maximal erlaubte Anzahl von HTTP-Weiterleitungen. Verwenden Sie diese Option zusammen mit CURLOPT_FOLLOWLOCATION.
CURLOPT_PORT Erlaubt das Setzen eines alternativen Ports für die Verbindung.
CURLOPT_PROXYAUTH Die HTTP-Authentisierungsmethode(n) für die Proxy-Verbindung. Nutzt die gleiche Bitmaske wie in CURLOPT_HTTPAUTH beschrieben. Nur CURLAUTH_BASIC und CURLAUTH_NTLM sind momentan für Proxy-Verbindungen zulässig. Hinzugefügt in cURL 7.10.7 und PHP 5.1.0.
CURLOPT_PROXYPORT Der Port, auf den die Proxy-Verbindung erfolgen soll; kann auch mittels CURLOPT_PROXY gesetzt werden. Hinzugefügt in PHP 5.0.0.
CURLOPT_PROXYTYPE Entweder CURLPROXY_HTTP (Standard) oder CURLPROXY_SOCKS5 . Hinzugefügt in cURL 7.10 und PHP 5.0.0.
CURLOPT_RESUME_FROM Die Position in Bytes ab der ein Transfer fortgesetzt werden soll.
CURLOPT_SSL_VERIFYHOST 1 um auf die Existenz des Namens im Zertifikat zu prüfen, 2 stellt sicher, daß eine Übereinstimmung mit dem angegebenen Hostnamen vorliegt.
CURLOPT_SSLVERSION Ein Wert von 2 oder 3 wählt die entsprechende SSL-Version. Standardmässig wird PHP versuchen, die entsprechende Einstellung zu ermitteln, aber in einigen Fällen mag das manuelle Setzen dieser Option nötig sein.
CURLOPT_TIMECONDITION Dieser Wert gibt an, wie CURLOPT_TIMEVALUE behandelt werden soll. Mögliche Werte sind CURL_TIMECOND_IFMODSINCE (Standard) und CURL_TIMECOND_ISUNMODSINCE . Im ersten Fall wird geprüft, ob die Seite seit CURLOPT_TIMEVALUE geändert wurde; andernfalls wird ein "304 Not Modified"-Header zurückgegeben (vorausgesetzt CURLOPT_HEADER ist TRUE). CURL_TIMECOND_ISUNMODSINCE bewirkt das gegenteilige Verhalten. Hinzugefügt in PHP 5.1.0.
CURLOPT_TIMEOUT Die maximale Ausführungszeit in Sekunden für cURL-Funktionen.
CURLOPT_TIMEVALUE Zeit in Sekunden seit dem 1. Januar 1970. Dieser Wert wird von CURLOPT_TIMECONDITION genutzt.

Für die folgenden option -Parameter sollte value ein String sein:

Option Wert für value Anmerkungen
CURLOPT_CAINFO Der Name einer Datei, die ein oder mehrere Zerifikate enthält, gegen die der Peer geprüft wird. Macht nur Sinn in Verbindung mit CURLOPT_SSL_VERIFYPEER.
CURLOPT_CAPATH Ein Verzeichnis, das mehrere CA-Zertifikate enthält. Diese Option sollte In Kombination mit CURLOPT_SSL_VERIFYPEER genutzt werden.
CURLOPT_COOKIE Der Inhalt des im HTTP-Request zu setzenden "Set-Cookie: "-Headers
CURLOPT_COOKIEFILE Der Name einer Datei, die Cookiedaten enthält. Diese Datei kann im Netscape-Format sein oder HTTP-geformte Header enthalten.
CURLOPT_COOKIEJAR Der Name einer Datei in der alle internen Cookies beim Schließen der Verbindung gespeichert werden.
CURLOPT_CUSTOMREQUEST

Eine benutzerdefinierte Request-Methode, die anstelle von GET oder HEAD für den HTTP-Request benutzt werden soll. Dies ist nützlich bei DELETE oder anderen unüblichen Requests. Zulässige Werte sind GET, POST, CONNECT etc. Vollständige HTTP-Requests wie GET /index.html HTTP/1.0\r\n\r\n sind unzulässig!

Hinweis: Führen Sie diese Anfragen nicht durch ohne sicherzugehen, daß Ihr Server die betreffenden Kommandos unterstützt.

CURLOPT_EGDSOCKET Analog CURLOPT_RANDOM_FILE, hier wird der Dateiname eines Entropy Gathering Daemon Socket erwartet.
CURLOPT_ENCODING Der Inhalt des "Accept-Encoding: "-Headers. Damit wird das Dekodieren der Serverantwort aktiviert. Unterstützte Kodierungen sind identity, deflate und gzip. Wird ein leerer String "" gesetzt wird ein Header mit allen unterstützten Kodierungen gesetzt. Hinzugefügt in cURL 7.10.
CURLOPT_FTPPORT Ein String, der genutzt wird, um die IP-Adresse zu erlangen, die von der FTP-POST-Anweisung genutzt wird. Die POST-Anweisung teilt dem entfernten Server mit, zu der angegebenen IP-Adresse zu verbinden. Der String kann eine einfache IP-Addresse, ein Hostname, der Name eines Netzwerkinterfaces (unter Unix) oder nur '-' sein, um die vordefinierte IP-Addresse (des Systems) zu nutzen.
CURLOPT_INTERFACE Der Name des zu nutzenden Netzwerkinterfaces für ausgehende Daten. Statt des Namens des Interfaces kann auch eine IP-Adresse oder ein Hostname übergeben werden.
CURLOPT_KRB4LEVEL Die KRB4 (Kerberos 4) Sicherheitsstufe. Folgende Werte (von niedriger zu höherer Stufe) sind gültig: clear, safe, confidential, private. Sollte der String keinen dieser Werte enthalten dann wird die höchste Stufe genutzt, d.h private. Sollte diese Option mit dem Wert NULL besetzt werden, wird KRB4 Security deaktiviert. Bislang wird KRB4 nur unter Verwendung des FTP unterstützt.
CURLOPT_POSTFIELDS Die in einem HTTP-POST-Request zu nutzenden Daten.
CURLOPT_PROXY Der HTTP-Proxy, durch den Requests getunnelt werden sollen.
CURLOPT_PROXYUSERPWD Benutzername und Passwort in der Form "[benutzername]:[passwort]" für die Proxy-Verbindung.
CURLOPT_RANDOM_FILE Ein Dateiname der zur Initialisierung des Zufallsgenerators für SSL benutzt wird.
CURLOPT_RANGE Bereiche an Daten, die empfangen werden sollen. Das Format sollte "X-Y" sein, wobei X oder Y optional sind. HTTP-Transfers unterstützen auch mehrere Komma-getrennte Intervalle im Format "X-Y,N-M".
CURLOPT_REFERER Der Inhalt des "Referer: "-Headers
CURLOPT_SSL_CIPHER_LIST Eine Liste der für SSL zulässigen Chiffren. RC4-SHA und TLSv1 sind zulässig.
CURLOPT_SSLCERT Der Name einer Datei die ein Zertifikat im PEM-Format enthält.
CURLOPT_SSLCERTPASSWD Das Passwort für das CURLOPT_SSLCERT-Zertifikat.
CURLOPT_SSLCERTTYPE Das Format des Zertifikats. Unterstützt werden PEM (Standard), DER und ENG. Hinzugefügt in cURL 7.9.3 und PHP 5.0.0.
CURLOPT_SSLENGINE Der Bezeichner für die Crypto Engine des privaten SSL-Schlüssels, der in CURLOPT_SSLKEY definiert ist.
CURLOPT_SSLENGINE_DEFAULT Der Bezeichner für die Crypto-Engine für asymmetrische kryptographische Operationen.
CURLOPT_SSLKEY Der Name einer Datei, die einen privaten SSL-Schlüssel enthält.
CURLOPT_SSLKEYPASSWD

Das geheime Passwort das für den in CURLOPT_SSLKEY definierten privaten SSL-Schlüssel.

Hinweis: Da diese Option sensible Daten enthält sollte das PHP-Script in einer sicheren Umgebung liegen.

CURLOPT_SSLKEYTYPE Der Typ des in CURLOPT_SSLKEY definierten privaten SSL-Schlüssels. Unterstützte Schlüssel-Typen sind PEM (Standard), DER und ENG.
CURLOPT_URL Der abzurufende URL; kann auch beim initialisieren der Session mittels curl_init() gesetzt werden.
CURLOPT_USERAGENT Der Wert des "User-Agent: "-Headers für den HTTP-Request
CURLOPT_USERPWD Benutzername und Passwort im Format "[benutzername]:[passwort]"

Für die folgenden option -Parameter sollte value ein Array sein:

Option Wert für value Anmerkungen
CURLOPT_HTTP200ALIASES Ein Array von HTTP-200-Status die als gültige Antowrten und nicht als Fehler behandelt werden. Hinzugefügt in cURL 7.10.3 und PHP 5.0.0.
CURLOPT_HTTPHEADER Ein Array von HTTP-Headern.
CURLOPT_POSTQUOTE Ein Array von FTP-Kommandos, die nach dem FTP-Request auf dem Server ausgeführt werden sollen.
CURLOPT_QUOTE Ein Array von FTP-Kommandos, die vor dem FTP-Request auf dem Server ausgeführt werden sollen.

Für die folgenden option -Parameter sollte value eine Stream-Resource sein, so wie sie z.B. mittels fopen() erstellt werden kann

Option Wert für value Anmerkungen
CURLOPT_FILE Die Datei, in die der Transfer geschrieben werden soll. Standard ist STDOUT (der Browser).
CURLOPT_INFILE Die Datei die zum Upload gelesen werden soll.
CURLOPT_STDERR Eine Datei, in die Fehler ausgegeben werden, alternativ zu STDERR.
CURLOPT_WRITEHEADER In diese Datei werden die Header eines Transfers geschrieben.

Für die folgenden option -Parameter sollte value ein Callback sein, der eine valide Callback-Funktion repräsentiert.

Option Wert für value Anmerkungen
CURLOPT_HEADERFUNCTION Eine Callback-Funktion, die zwei Parameter erwartet. Der erste ist die cURL-Resource, der zweite ist ein String mit den zu schreibenden Headern. Bei Nutzung dieser Callback-Funktion liegt die Verantwortung für das Schreiben der Header bei Ihnen. Die Funktion sollte die Anzahl der geschriebenen Bytes zurückgeben.
CURLOPT_PASSWDFUNCTION Eine Callback-Funktion, die drei Parameter erwartet. Der erste ist die cURL-Resource, der zweite ein String der ein Passwort-Prompt enthält, der dritte Parameter enthält die maximal zulässige Länge des Passworts. Die Funktion sollte das Passwort als String zurückgeben.
CURLOPT_READFUNCTION Eine Callback-Funktion, die zwei Parameter erwartet. Der erste ist die cURL-Resource, der zweite ist ein String mit den zu lesenden Daten. Bei Nutzung dieser Callback-Funktion liegt die Verantwortung für das Lesen der Daten bei Ihnen. Die Funktion sollte die Anzahl der gelesenen Bytes zurückgeben, 0 um EOF zu signalisieren.
CURLOPT_WRITEFUNCTION Eine Callback-Funktion, die zwei Parameter erwartet. Der erste ist die cURL-Resource, der zweite ist ein String mit den zu schreibenden Daten. Bei Nutzung dieser Callback-Funktion liegt die Verantwortung für das Schreiben der Daten bei Ihnen. Die Funktion muss die genaue Anzahl geschriebener Bytes zurückgeben!

Rückgabewerte

Gibt bei Erfolg TRUE zurück. Im Fehlerfall wird FALSE zurückgegeben.

Beispiele

PHP Code
1
2
3
4
5
6
7
8
9
10
// erzeuge einen neuen cURL-Handle $ch = curl_init(); // setze die URL und andere Optionen curl_setopt($ch, CURLOPT_URL, "http://www.example.com/"); curl_setopt($ch, CURLOPT_HEADER, 0); // führe die Aktion aus und gebe die Daten an den Browser weiter curl_exec($ch); // schließe den cURL-Handle und gebe die Systemresourcen frei curl_close($ch);

Siehe auch