Oc-windows.ru

IT Новости из мира ПК
0 просмотров
Рейтинг статьи
1 звезда2 звезды3 звезды4 звезды5 звезд
Загрузка...

Php build query string

Php build query string

http_build_query — Generate URL-encoded query string

Описание string http_build_query ( array formdata [, string numeric_prefix] )

Generates a URL-encoded query string from the associative (or indexed) array provided. formdata may be an array or object containing properties. A formdata array may be a simple one-dimensional structure, or an array of arrays (who in turn may contain other arrays). If numeric indices are used in the base array and a numeric_prefix is provided, it will be prepended to the numeric index for elements in the base array only. This is to allow for legal variable names when the data is decoded by PHP or another CGI application later on.

Пример 1. Simple usage of http_build_query()

= array( ‘foo’ => ‘bar’ ,
‘baz’ => ‘boom’ ,
‘cow’ => ‘milk’ ,
‘php’ => ‘hypertext processor’ );

echo http_build_query ( $data ); // foo=bar&baz=boom&cow=milk&php=hypertext+processor
?>

Пример 2. http_build_query() with numerically index elements.

= array( ‘foo’ , ‘bar’ , ‘baz’ , ‘boom’ , ‘cow’ => ‘milk’ , ‘php’ => ‘hypertext processor’ );

echo http_build_query ( $data );
/* Outputs:
0=foo&1=bar&2=baz&3=boom&cow=milk&php=hypertext+processor
*/

echo http_build_query ( $data , ‘myvar_’ );
/* Outputs:
myvar_0=foo&myvar_1=bar&myvar_2=baz&myvar_3=boom&cow=milk&php=hypertext+processor
*/
?>

Пример 3. http_build_query() with complex arrays

= array( ‘user’ =>array( ‘name’ => ‘Bob Smith’ ,
‘age’ => 47 ,
‘sex’ => ‘M’ ,
‘dob’ => ‘5/12/1956’ ),
‘pastimes’ =>array( ‘golf’ , ‘opera’ , ‘poker’ , ‘rap’ ),
‘children’ =>array( ‘bobby’ =>array( ‘age’ => 12 ,
‘sex’ => ‘M’ ),
‘sally’ =>array( ‘age’ => 8 ,
‘sex’ => ‘F’ )),
‘CEO’ );

echo http_build_query ( $data , ‘flags_’ );
?>

this will output : (word wrapped for readability)

user[name]=Bob+Smith&user[age]=47&user[sex]=M&user[dob]=5%1F12%1F1956& pastimes[0]=golf&pastimes[1]=opera&pastimes[2]=poker&pastimes[3]=rap& children[bobby][age]=12&children[bobby][sex]=M&children[sally][age]=8& children[sally][sex]=F&flags_0=CEO

Замечание: Only the numerically indexed element in the base array «CEO» received a prefix. The other numeric indices, found under pastimes, do not require a string prefix to be legal variable names.

Пример 4. Using http_build_query() with an object

class myClass <
var $foo ;
var $baz ;

function myClass ()
<
$this -> foo = ‘bar’ ;
$this -> baz = ‘boom’ ;
>
>

$data = new myClass ();

echo http_build_query ( $data ); // foo=bar&baz=boom

http_build_query — Генерирует URL-кодированную строку запроса

http_build_query — Генерирует URL-кодированную строку запроса

Описание

Генерирует URL-кодированную строку запроса из предоставленного ассоциативного (или индексного) массива.

Список параметров

Может быть массивом или объектом, содержащим свойства.

Если query_data массив, то он может быть простой одномерной структурой, или массивом массивов (который, в свою очередь, может содержать другие массивы).

Если query_data объект, тогда только общедоступные (public) свойства будут включены в результат.

Если числовые индексы используются в базовом массиве и этот параметр указан, то будет добавлен числовой индекс только для элементов в базом массиве.

Это позволяет обеспечить допустимые имена переменных, в которые позже данные декодируются PHP или другим CGI приложением.

arg_separator.output Используется в качестве разделителя аргументов, если этот параметр указан.

По умолчанию, PHP_QUERY_RFC1738 .

Если enc_type равен PHP_QUERY_RFC1738 , тогда кодирование осуществляется по » RFC 1738 и типу контента application/x-www-form-urlencoded, который подразумевает, что пробелы кодируются как символы «плюс»(+).

Если enc_type равен PHP_QUERY_RFC3986 , тогда кодирование осуществляется в соответствии с » RFC 3986, и пробелы будут кодированы как %20.

Возвращаемые значения

Возвращает URL-кодированную строку.

Список изменений

ВерсияОписание
5.4.0Добавлен параметр enc_type .
5.1.3Квадратные скобки экранируются.
5.1.2Добавлен параметр arg_separator .

Примеры

Пример #1 Простой пример использования http_build_query()

= array( ‘foo’ => ‘bar’ ,
‘baz’ => ‘boom’ ,
‘cow’ => ‘milk’ ,
‘php’ => ‘hypertext processor’ );

echo http_build_query ( $data ) . «n» ;
echo http_build_query ( $data , » , ‘&’ );

Результат выполнения данного примера:

Пример #2 Пример использования http_build_query() с числовыми индексами элементов.

= array( ‘foo’ , ‘bar’ , ‘baz’ , ‘boom’ , ‘cow’ => ‘milk’ , ‘php’ => ‘hypertext processor’ );

echo http_build_query ( $data ) . «n» ;
echo http_build_query ( $data , ‘myvar_’ );
?>

Результат выполнения данного примера:

Пример #3 Пример использования http_build_query() с многомерными массивами

= array( ‘user’ =>array( ‘name’ => ‘Bob Smith’ ,
‘age’ => 47 ,
‘sex’ => ‘M’ ,
‘dob’ => ‘5/12/1956’ ),
‘pastimes’ =>array( ‘golf’ , ‘opera’ , ‘poker’ , ‘rap’ ),
‘children’ =>array( ‘bobby’ =>array( ‘age’ => 12 ,
‘sex’ => ‘M’ ),
‘sally’ =>array( ‘age’ => 8 ,
‘sex’ => ‘F’ )),
‘CEO’ );

echo http_build_query ( $data , ‘flags_’ );
?>

Результат выполнения данных примеров: (символы перенесены для удобства чтения)

Только числовой индексированный элемент «CEO» в базовом массиве получил префикс. Другие числовые индексы, найденные в pastimes, не требуют строкового префикса чтобы быть допустимым именем переменной.

Пример #4 Пример использования http_build_query() с объектом

class parentClass <
public $pub = ‘publicParent’ ;
protected $prot = ‘protectedParent’ ;
private $priv = ‘privateParent’ ;
public $pub_bar = Null ;
protected $prot_bar = Null ;
private $priv_bar = Null ;

public function __construct () <
$this -> pub_bar = new childClass ();
$this -> prot_bar = new childClass ();
$this -> priv_bar = new childClass ();
>
>

class childClass <
public $pub = ‘publicChild’ ;
protected $prot = ‘protectedChild’ ;
private $priv = ‘privateChild’ ;
>

$parent = new parentClass ();

echo http_build_query ( $parent );
?>

Результат выполнения данного примера:

Смотрите также

  • parse_str() — Разбирает строку в переменные
  • parse_url() — Разбирает URL и возвращает его компоненты
  • urlencode() — URL-кодирование строки
  • array_walk() — Применяет заданную пользователем функцию к каждому элементу массива

http_build_query

http_build_query — Generate URL-encoded query string

Description

Generates a URL-encoded query string from the associative (or indexed) array provided.

Parameters

May be an array or object containing properties.

If query_data is an array, it may be a simple one-dimensional structure, or an array of arrays (which in turn may contain other arrays).

If query_data is an object, then only public properties will be incorporated into the result.

If numeric indices are used in the base array and this parameter is provided, it will be prepended to the numeric index for elements in the base array only.

This is meant to allow for legal variable names when the data is decoded by PHP or another CGI application later on.

arg_separator.output is used to separate arguments, unless this parameter is specified, and is then used.

By default, PHP_QUERY_RFC1738 .

If enc_type is PHP_QUERY_RFC1738 , then encoding is performed per » RFC 1738 and the application/x-www-form-urlencoded media type, which implies that spaces are encoded as plus (+) signs.

If enc_type is PHP_QUERY_RFC3986 , then encoding is performed according to » RFC 3986, and spaces will be percent encoded (%20).

Return Values

Returns a URL-encoded string.

Changelog

VersionDescription
5.4.0The enc_type parameter was added.
5.1.3Square brackets are escaped.
5.1.2The arg_separator parameter was added.

Examples

Example #1 Simple usage of http_build_query()

= array( ‘foo’ => ‘bar’ ,
‘baz’ => ‘boom’ ,
‘cow’ => ‘milk’ ,
‘php’ => ‘hypertext processor’ );

echo http_build_query ( $data ) . «n» ;
echo http_build_query ( $data , » , ‘&’ );

The above example will output:

Example #2 http_build_query() with numerically index elements.

= array( ‘foo’ , ‘bar’ , ‘baz’ , ‘boom’ , ‘cow’ => ‘milk’ , ‘php’ => ‘hypertext processor’ );

echo http_build_query ( $data ) . «n» ;
echo http_build_query ( $data , ‘myvar_’ );
?>

The above example will output:

Example #3 http_build_query() with complex arrays

= array( ‘user’ =>array( ‘name’ => ‘Bob Smith’ ,
‘age’ => 47 ,
‘sex’ => ‘M’ ,
‘dob’ => ‘5/12/1956’ ),
‘pastimes’ =>array( ‘golf’ , ‘opera’ , ‘poker’ , ‘rap’ ),
‘children’ =>array( ‘bobby’ =>array( ‘age’ => 12 ,
‘sex’ => ‘M’ ),
‘sally’ =>array( ‘age’ => 8 ,
‘sex’ => ‘F’ )),
‘CEO’ );

echo http_build_query ( $data , ‘flags_’ );
?>

this will output : (word wrapped for readability)

Only the numerically indexed element in the base array «CEO» received a prefix. The other numeric indices, found under pastimes, do not require a string prefix to be legal variable names.

Example #4 Using http_build_query() with an object

class parentClass <
public $pub = ‘publicParent’ ;
protected $prot = ‘protectedParent’ ;
private $priv = ‘privateParent’ ;
public $pub_bar = Null ;
protected $prot_bar = Null ;
private $priv_bar = Null ;

public function __construct () <
$this -> pub_bar = new childClass ();
$this -> prot_bar = new childClass ();
$this -> priv_bar = new childClass ();
>
>

class childClass <
public $pub = ‘publicChild’ ;
protected $prot = ‘protectedChild’ ;
private $priv = ‘privateChild’ ;
>

$parent = new parentClass ();

echo http_build_query ( $parent );
?>

The above example will output:

See Also

  • parse_str() — Parses the string into variables
  • parse_url() — Parse a URL and return its components
  • urlencode() — URL-encodes string
  • array_walk() — Apply a user function to every member of an array

http_build_query

http_build_query — Генерирует URL-кодированную строку запроса

Описание

Генерирует URL-кодированную строку запроса из предоставленного ассоциативного (или индексированного) массива.

Список параметров

Может быть массив или объект, содержащий свойства.

Если query_data массив, то он может быть простой одномерной структурой или массивом массивов (который, в свою очередь, может содержать другие массивы).

Если query_data объект, тогда только общедоступные свойства будут включены в результат.

Если числовые индексы используются в базовом массиве и этот параметр указан, то он будет добавлен к числовому индексу для элементов только в базовом массиве.

Это позволяет обеспечить допустимые имена переменных, в которые позже данные будут декодированы PHP или другим CGI-приложением.

arg_separator.output используется в качестве разделителя аргументов, но может быть переопределен путем указания этого параметра.

По умолчанию PHP_QUERY_RFC1738 .

Если enc_type равен PHP_QUERY_RFC1738 , тогда кодирование осуществляется по » RFC 1738 и типу контента application/x-www-form-urlencoded, что подразумевает, что пробелы кодируются как символы «плюс» (+).

Если enc_type равен PHP_QUERY_RFC3986 , тогда кодирование осуществляется в соответствии с » RFC 3986, а пробелы будут закодированы в процентах (%20).

Возвращаемые значения

Возвращает URL-кодированную строку.

Список изменений

ВерсияОписание
5.4.0Добавлен параметр enc_type .
5.1.3Квадратные скобки экранируются.
5.1.2Добавлен параметр arg_separator .

Примеры

Пример #1 Простой пример использования http_build_query()

= array(
‘foo’ => ‘bar’ ,
‘baz’ => ‘boom’ ,
‘cow’ => ‘milk’ ,
‘php’ => ‘hypertext processor’
);

echo http_build_query ( $data ) . «n» ;
echo http_build_query ( $data , » , ‘&’ );

Результат выполнения данного примера:

Пример #2 Пример использования http_build_query() с числовыми индексами элементов.

= array( ‘foo’ , ‘bar’ , ‘baz’ , ‘boom’ , ‘cow’ => ‘milk’ , ‘php’ => ‘hypertext processor’ );

echo http_build_query ( $data ) . «n» ;
echo http_build_query ( $data , ‘myvar_’ );
?>

Результат выполнения данного примера:

Пример #3 Пример использования http_build_query() с многомерными массивами

= array(
‘user’ => array(
‘name’ => ‘Bob Smith’ ,
‘age’ => 47 ,
‘sex’ => ‘M’ ,
‘dob’ => ‘5/12/1956’
),
‘pastimes’ => array( ‘golf’ , ‘opera’ , ‘poker’ , ‘rap’ ),
‘children’ => array(
‘bobby’ => array( ‘age’ => 12 , ‘sex’ => ‘M’ ),
‘sally’ => array( ‘age’ => 8 , ‘sex’ => ‘F’ )
),
‘CEO’
);

echo http_build_query ( $data , ‘flags_’ );
?>

Результат выполнения данных примеров: (символы перенесены для удобства чтения)

Только числовой индексированный элемент «CEO» в базовом массиве получил префикс. Другие числовые индексы, найденные в pastimes, не требуют строкового префикса, чтобы быть допустимыми именами переменных.

Пример #4 Пример использования http_build_query() с объектом

class parentClass <
public $pub = ‘publicParent’ ;
protected $prot = ‘protectedParent’ ;
private $priv = ‘privateParent’ ;
public $pub_bar = Null ;
protected $prot_bar = Null ;
private $priv_bar = Null ;

public function __construct () <
$this -> pub_bar = new childClass ();
$this -> prot_bar = new childClass ();
$this -> priv_bar = new childClass ();
>
>

class childClass <
public $pub = ‘publicChild’ ;
protected $prot = ‘protectedChild’ ;
private $priv = ‘privateChild’ ;
>

$parent = new parentClass ();

echo http_build_query ( $parent );
?>

Результат выполнения данного примера:

Смотрите также

  • parse_str() — Разбирает строку в переменные
  • parse_url() — Разбирает URL и возвращает его компоненты
  • urlencode() — URL-кодирование строки
  • array_walk() — Применяет заданную пользователем функцию к каждому элементу массива

User Contributed Notes 23 notes

Params with null value do not present in result string.

= array( ‘test’ => null , ‘test2’ => 1 );
echo http_build_query ( $arr );
?>

will produce:

Passing null to $arg_separator is the same as passing an empty string, which is probably not what you want.

If you need to change the enc_type, use this:

Or possibly this:

http_build_query($query, null, ini_get(‘arg_separator.output’), PHP_QUERY_RFC3986);

// BAD CODE!
http_build_query($query, null, null, PHP_QUERY_RFC3986);

As noted before, with php5.3 the separator is & on some servers it seems. Normally if posting to another php5.3 machine this will not be a problem.

But if you post to a tomcat java server or something else the & might not be handled properly.

To overcome this specify:

http_build_query($array); //gives & to some servers

This function makes like this

To do it like this:

$query = http_build_query($query);
$query = preg_replace(‘/%5B[0-9]+%5D/simU’, ‘%5B%5D’, $query);

if you send boolean values it transform in integer :

$a = [teste1= true,teste2=false];
echo http_build_query($a)

//result will be teste1=1&teste2=0

Is it worth noting that if query_data is an associative array and a value is itself an empty array, or an array of nothing but empty array (or arrays containing only empty arrays etc.), the corresponding key will not appear in the resulting query string?
E.g.

$post_data = array(‘name’=>’miller’, ‘address’=>array(‘address_lines’=>array()), ‘age’=>23);
echo http_build_query($post_data);

When using the http_build_query function to create a URL query from an array for use in something like curl_setopt($ch, CURLOPT_POSTFIELDS, $post_url), be careful about the url encoding.

In my case, I simply wanted to pass on the received $_POST data to a CURL’s POST data, which requires it to be in the URL format. If something like a space [ ] goes into the http_build_query, it comes out as a +. If you’re then sending this off for POST again, you won’t get the expected result. This is good for GET but not POST.

Instead you can make your own simple function if you simply want to pass along the data:

= » ;
foreach ( $_POST AS $key => $value )
$post_url .= $key . ‘=’ . $value . ‘&’ ;
$post_url = rtrim ( $post_url , ‘&’ );
?>

You can then use this to pass along POST data in CURL.

= curl_init ( $some_url );
curl_setopt ( $ch , CURLOPT_POST , true );
curl_setopt ( $ch , CURLOPT_POSTFIELDS , $post_url );
curl_exec ( $ch );
?>

Note that at the final page that processes the POST data, you should be properly filtering/escaping it.

Correct implementation of coding the array of params without indexes (valdikks fixed code — didnt work for inner arrays):

Number to string conversion occured in () ?> is affected by locale settings, which might not be obvious.

setlocale ( LC_ALL , ‘us_En’ );
http_build_query ( $params ) // v=5.63

setlocale ( LC_ALL , ‘ru_RU’ );
http_build_query ( $params ) // v=5,63 mind the comma
?>

While http_build_query can also be used to encode most classes, into a query string, SimpleXML Elements with values are picked up as empty arrays, and therefore aren’t included naturally.

= simplexml_load_string ( ‘ value2 ‘ );
var_dump ( $xml , http_build_query ( $xml ) );
/* Outputs:
object(SimpleXMLElement)#1 (2) <
[«key»]=>
object(SimpleXMLElement)#2 (0) <
>
[«key2»]=>
string(6) «value2»
>
string(11) «key2=value2»
*/
?>

If you need the inverse functionality, and (like me) you cannot use pecl_http, you may want to use something akin to the following.

function http_parse_query ( $Query ) <

// mimic the behavior of $_GET, see also RFC 1738 and 3986.
$Delimiter = ini_get ( ‘arg_separator.input’ );
$Params = array();

foreach ( explode ( $Delimiter , $Query ) as $NameValue ) <
preg_match (
‘/^(?P [^=[]*)(?P [(?P [^]]*(][[^]]*)*)]?)?(?P =(?P .*))?$/’ ,
$NameValue ,
$NameValueParts
);

if (!empty( $NameValueParts [ ‘indices_present’ ])) <
$Indices = explode ( ‘][‘ , $NameValueParts [ ‘indices’ ]);

foreach ( $Indices as $Index ) <
if (! is_array ( $Param )) <
$Param = array();
>

if ( $Index === » ) <
$Param [] = array();
end ( $Param );
$Param =& $Param [ key ( $Param )];
> else <
if ( ctype_digit ( $Index ))

if (! array_key_exists ( $Index , $Param )) <
$Param [ $Index ] = array();
>
$Param =& $Param [ $Index ];
>
>
>

if (!empty( $NameValueParts [ ‘value_present’ ])) <
$Param = urldecode ( $NameValueParts [ ‘value’ ]);
> else <
$Param = » ;
>
>
>

Читать еще:  Php время в миллисекундах
Ссылка на основную публикацию
Adblock
detector