http_build_query

(PHP 5)

http_build_query -- Erstellen eines URL-kodierten Query-Strings

Beschreibung

string http_build_query ( array formdata [, string numeric_prefix] )

Erstellt einen URL-kodierten Query-String aus einem gegebenen assoziativem (oder indexiertem) Array. formdata kann ein Array oder ein Objekt sein, das Eigenschaften enthält. Ein formdata-Array kann eine einfache eindimensionale Struktur haben, oder ein Array aus Arrays sein (die wiederum weitere Arrays enthalten können). 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.

Anmerkung: arg_separator.output wird verwendet, um die Argumente voneinander zu trennen.

Beispiel 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
?>

Beispiel 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);
/* Ausgabe:
      0=foo&1=bar&2=baz&3=boom&kuh=milch&php=hypertext+processor
*/

echo http_build_query($data, 'meineVariable_');
/* Ausgabe: (fuer bessere Lesbarkeit umgebrochen!)
      meineVariable_0=foo&meineVariable_1=bar&meineVariable_2=baz&
      meineVariable_3=boom&kuh=milch&php=hypertext+processor
*/
?>

Beispiel 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

Anmerkung: 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.

Beispiel 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

?>

Siehe auch parse_str(), parse_url(), urlencode() und array_walk()