http_build_query
(PHP 5, PECL pecl_http:0.1.0-0.9.0)
http_build_query — Erstellen eines URL-kodierten Query-Strings
Beschreibung
Erstellt einen URL-kodierten Query-String aus einem gegebenen assoziativen (oder indexierten) Array.
Parameter Liste
- formdata
-
Kann ein Array oder ein Objekt sein, das Eigenschaften enthält.
Das Array kann eine einfache eindimensionale Struktur haben, oder ein Array aus Arrays sein (die wiederum weitere Arrays enthalten können).
- numeric_prefix
-
Wenn numerische Indizes im äußeren Array verwendet werden und ein numeric_prefix angegeben wurde, wird dieser nur den numerischen Schlüsseln im äußeren Array vorangestellt.
Dieser Weg wurde gewählt, um gültige Variablennamen zu erhalten, wenn die Daten später von PHP oder einer anderen CGI-Applikation dekodiert werden.
- arg_separator
-
arg_separator.output wird verwendet, um die Argumente voneinander zu trennen, es sei denn, dass der Parameter angegeben ist. In diesem Falle wird letzteres verwendet.
Rückgabewerte
Gibt einen URL-kodierten String zurück.
ChangeLog
| Version | Beschreibung |
|---|---|
| 5.1.2 | arg_separator -Parameter hinzugefügt. |
| 5.1.3 | Eckige Klammern werden maskiert. |
Beispiele
Example#1 Einfache Verwendung von http_build_query()
<?php
$data = array('foo'=>'bar',
'baz'=>'boom',
'cow'=>'milch',
'php'=>'hypertext processor');
echo http_build_query($data); // foo=bar&baz=boom&cow=milch&php=hypertext+processor
echo http_build_query($data, '', '&'); // foo=bar&baz=boom&cow=milch&php=hypertext+processor
?>
Example#2 http_build_query() mit numerischen Index-Elementen.
<?php
$data = array('foo', 'bar', 'baz', 'boom', 'kuh' => 'milch', 'php' =>'hypertext processor');
echo http_build_query($data) . "\n";
echo http_build_query($data, 'meineVariable_');
?>
Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
0=foo&1=bar&2=baz&3=boom&kuh=milch&php=hypertext+processor meineVariable_0=foo&meineVariable_1=bar&meineVariable_2=baz&meineVariable_3=boom&kuh=milch&php=hypertext+processor
Example#3 http_build_query() mit verschachtelten Arrays
<?php
$data = array('user'=>array('name'=>'Bob Smith',
'alter'=>47,
'geschlecht'=>'M',
'geb'=>'5/12/1956'),
'hobbies'=>array('golf', 'opera', 'poker', 'rap'),
'kinder'=>array('bobby'=>array('alter'=>12,
'geschlecht'=>'M'),
'sally'=>array('alter'=>8,
'geschlecht'=>'F')),
'CEO');
echo http_build_query($data, 'flags_');
?>
Ausgabe: (für bessere Lesbarkeit umgebrochen!)
user[name]=Bob+Smith&user[alter]=47&user[geschlecht]=M&user[geb]=5%2F12%2F1956& hobbies[0]=golf&hobbies[1]=opera&hobbies[2]=poker&hobbies[3]=rap& kinder[bobby][alter]=12&kinder[bobby][geschlecht]=M&kinder[sally][alter]=8& kinder[sally][geschlecht]=F&flags_0=CEO
Hinweis: Nur das numerische Indexelement im äußeren Array "CEO" erhält ein Prefix. Die anderen numerischen Indizes unterhalb von hobbies benötigen kein String-Prefix, um einen gültigen Variablennamen darzustellen.
Example#4 Verwendung von http_build_query() mit einem Objekt
<?php
class meineKlasse {
var $foo;
var $baz;
function meineKlasse() {
$this->foo = 'bar';
$this->baz = 'boom';
}
}
$data = new meineKlasse();
echo http_build_query($data); // foo=bar&baz=boom
?>