PHP 7.4.3 released

vsprintf

(PHP 4 >= 4.1.0, PHP 5, PHP 7)

vsprintfGibt einen formatierten String zurück

Beschreibung

vsprintf ( string $format , array $args ) : string

Verhält sich wie sprintf(), akzeptiert jedoch ein Array anstelle mehrerer Werte als Parameter.

Parameter-Liste

format

Der Formatstring setzt sich aus keiner oder mehreren Anweisungen zusammen: Normale Zeichen (abgesehen von %), die direkt in das Ergebnis kopiert werden und Konvertierungsanweisungen, die jeweils ihre eigenen Parameter abrufen.

Eine Konvertierungsanweisung folgt diesem Prototypen: %[ArgNum$][Flags][Weite][.Präzision]Spezifizierer.

ArgNum

Eine Ganzzahl gefolgt von einem Dollarzeichen $, die die Nummer des Arguments angibt, das für die Konversion verwendet werden soll.

Flags
Flag Beschreibung
- Linksbündig innerhalb der angegebenen Feldbreite; Rechtsbündig ist der Standard
+ Positive Zahlen mit einem Pluszeichen +; Standardmäßig werden nur negative Zahlen mit negativen Vorzeichen ausgegeben
(Leerzeichen) Füllt das Ergebnis mit Leerzeichen auf. Dies ist der Standard.
0 Füllt nach Links mit Nullen auf. Mit dem s-Spezifizierer kann dies auch nach rechts mit Nullen auffüllen.
'(Zeichen) Füllt das Ergebnis mit dem angegebenen Zeichen auf.

Weite

Eine Ganzzahle die angibt, wie viele Zeichen (Minimum) das Konvertierungsergebnis haben soll.

Präzision

Die Bedeutung eines Punkts . gefolgt von einer Ganzzahl hängt vom Spezifizierer ab:

  • Für die Spezifizierer e, E, f und F: Dies stellt die Anzahl der Nachkommastellen an, die nach dem Dezimaltrennzeichen ausgegeben werden soll (Standradmäßig ist dies 6).
  • Für die Spezifizierer g und G: Die maximale Anzahl der auszugebenenden signifikanten Nachkommastellen.
  • Für den s Spezifizierer: Verhält sich wie ein Abschneidepunkt, der eine maximale Anzahl an Zeichen in der Zeichenkette angibt.

Hinweis: Wenn der Punkt ohne einen expliziten Wert für die Präzision angegeben wird, wird 0 angenommen.

Hinweis: Wird ein Spezifizierer angegeben, der größer ist als PHP_INT_MAX, so wird eine Warnung ausgegeben.

Spezifizierer
Spezifizierer Beschreibung
% Ein Prozentzeichen. Kein Parameter nötig.
b Der Parameter wird als Ganzzahl behandelt und als Binärzahl ausgegeben.
c Der Parameter wird als Ganzzahl behandelt und als Zeichen aus dem ASCII-Zeichensatz ausgegeben.
d Der Parameter wird als Ganzzahl behandelt und als (vorzeichenbehaftete) Dezimalzahl ausgegeben.
e Der Parameter wird als Zahl in wissenschaftlicher Schreibweise (z.B. 1.2e+2) behandelt. Die Angabe der Präzision steht seit PHP 5.2.1 für die Anzahl Zeichen nach dem Dezimalpunkt. In früheren Versionen wurde dies als die Anzahl signifikanter Dezimalstellen betrachtet (eins weniger).
E Wie der Spezifizierer e, aber schreibt einen Großbuchstaben (z.B. 1.2E+2).
f Der Parameter wird als Gleitkommazahl betrachtet und als Gleitkommazahl ausgegeben (abhängig von der Locale).
F Der Parameter wird als Gleitkommazahl betrachtet und als Gleitkommazahl (unabhängig von der Locale) ausgegeben. Verfügbar seit PHP 5.0.3.
g

Generelles Format.

Sei P die Präzision wenn nicht Null, 6 wenn die Präzision nicht angegeben ist oder 1 wenn die Präzision Null ist. Dann, wenn eine Konvertierung mittels E einen Exponenten von X hätte:

Wenn P > X ≥ −4 ist die Konvertierung mit Spezifizierer f und Präzision P - (X + 1). Andernfalls wie mit Spezifizierer e und Präzision P - 1.

G Wie der Spezifizierer g, aber es wird E und F verwendet.
o Der Parameter wird als Ganzzahl betrachtet und als Oktalzahl ausgegeben.
s Der Parameter wird als Zeichenkette betrachtet und ausgegeben.
u Der Parameter wird als Ganzzahl betrachtet und als vorzeichenlose Dezimalzahl ausgegeben.
x Der Parameter wird als Ganzzahl betrachtet und als Hexadezimalzahl (mit Kleinbuchstaben) ausgegeben.
X Der Parameter wird als Ganzzahl betrachtet und als Hexadezimalzahl (mit Großbuchstaben) ausgegeben.

Warnung

Der Spezifizierer c ignoriert Auffüllung und Weite.

Warnung

Der Versuch, die Kombination aus Zeichenketten mit Weite-Spezifizierern und Zeichensätzen die mehr als ein Byte pro zeichen erwarten zu verwenden, führt zu unvorhersehbaren Ergebnissen.

Variablen werden auf einen für den Spezifizier passenden Typen umgewandelt:

Typ-Behandlung
Typ Spezifizierer
string s
integer d, u, c, o, x, X, b
double g, G, e, E, f, F

args

Rückgabewerte

Gibt Array-Werte als formatierten String entsprechend der Format-Anweisung. Im Fehlerfall wird FALSE zurückgegeben.

Beispiele

Beispiel #1 vsprintf(): mit Nullen aufgefüllte Ganzzahlen

<?php
print vsprintf("%04d-%02d-%02d"explode('-''1988-8-1'));
?>

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

1988-08-01

Siehe auch

  • printf() - Gibt einen formatierten String aus
  • sprintf() - Gibt einen formatierten String zurück
  • fprintf() - Schreibt einen formatierten String in einen Stream
  • vprintf() - Gibt einen formatierten String aus
  • vfprintf() - Schreibt einen formatierten String in einen Stream
  • sscanf() - Überträgt einen String in ein angegebenes Format
  • fscanf() - Interpretiert den Input einer Datei entsprechend einem angegebenen Format
  • number_format() - Formatiert eine Zahl mit Tausender-Trennzeichen
  • date() - Formatiert ein(e) angegebene(s) Ortszeit/Datum

add a note add a note

User Contributed Notes 15 notes

up
24
spectrumcat
3 years ago
Instead of inventing own functions in case you'd like to use array keys as placeholder names and replace corresponding array values in a string, just use the str_replace:

$string = 'Hello %name!';
$data = array(
  '%name' => 'John'
);

$greeting = str_replace(array_keys($data), array_values($data), $string);
up
12
Josef Kufner
7 years ago
<?php
/**
* Like vsprintf, but accepts $args keys instead of order index.
* Both numeric and strings matching /[a-zA-Z0-9_-]+/ are allowed.
*
* Example: vskprintf('y = %y$d, x = %x$1.1f', array('x' => 1, 'y' => 2))
* Result:  'y = 2, x = 1.0'
*
* $args also can be object, then it's properties are retrieved
* using get_object_vars().
*
* '%s' without argument name works fine too. Everything vsprintf() can do
* is supported.
*
* @author Josef Kufner <jkufner(at)gmail.com>
*/
function vksprintf($str, $args)
{
    if (
is_object($args)) {
       
$args = get_object_vars($args);
    }
   
$map = array_flip(array_keys($args));
   
$new_str = preg_replace_callback('/(^|[^%])%([a-zA-Z0-9_-]+)\$/',
            function(
$m) use ($map) { return $m[1].'%'.($map[$m[2]] + 1).'$'; },
           
$str);
    return
vsprintf($new_str, $args);
}
?>
up
3
jed at NOSPAM dot jed dot bz
15 years ago
vsprintf() accepts arrays with any keys, so the array_shift() technique is unnecessary when writing a printf-type function. Any parameters you require are easily unset from the array you retrieve with func_get_args():

<?php

function mysprintf($format) {
   
$args = func_get_args();
    unset(
$args[0]); /* get rid of "$format" */
   
return vsprintf($format, $args);
}

/* I use this technique in production code as follows: */
function logf($target, $string) {
   
$args = func_get_args();
    unset(
$args[0], $args[1]);
   
fprintf($GLOBALS['config']['logtargets'][$target],
       
"[%s] %s\n", date('H:i'), wordwrap(vsprintf($string, $args), 75, '\n\r '));
}

/* e.g.:
    logf(DEBUG, "Oops! %s", mysql_error());
*/

?>

array_shift() and other costly array operations aren't required, as far as I know. I could be wrong.
up
4
Roadster
13 years ago
Please note: The same functionality (sortof) can be attained between version 4.0.4 and 4.1.0 using call_user_func_array.

Example:

call_user_func_array("sprintf", $arg)

First element of $arg is the format. This rescued me in a situation where version 4.1.0 wasn't available.
up
3
jon at ardentcreative dot co dot uk
14 years ago
This can be used for quick and dirty internationalization:

<?php
$GLOBALS
['strings']['example'] = "There are %d people.";

// Loads a phrase from the translations list in lang/$lang/phrases.php
function t() {
   
$args = func_get_args();
   
$nArgs = func_num_args();
   
   
$phrase = array_shift($args);
   
$nArgs--;
   
    include_once(
"../lang/" . lang() . "/phrases.php");
    if (isset(
$GLOBALS['strings'][$phrase])) {
        return
vsprintf($GLOBALS['strings'][$phrase], $args);
    } else {
        return
'<span style="color: #ff0000">Untranslated string: ' . $phrase . '</span>';
    }
}
?>
up
3
www dot wesley at gmail dot com
11 years ago
vnsprintf is equal to vsprintf except for associative, signed or floating keys.

vnsprintf supports for example "%assocKey$05d", "%-2$'+10s" and "%3.2$05u", vsprintf doesn't

vnsprintf( '%2$d', $array) [2nd value] is equal to vsprintf( '%2$d', $array) [2nd value]
vnsprintf( '%+2$d', $array) [key = 2] is equal to vnsprintf( '%2.0$d', $array) [key = 2]
vnsprintf( '%+2$d', $array) [key = 2] is different of vsprintf( '%+2$d', $array) [unsupported]

When you use signed or floating keys, vnsprintf searchs for the signed truncated key of the original array

Note¹: vnsprintf does not support for example "%someKeyf" (floating number, key = someKey) or "%+03d" (signed decimal number, key = 3), you should use "%someKey$f" or "%+03$d" respectively.
Note²: "%+03d" (or "%1$+03d") will be interpreted as signed zero-padded decimal number

<?php
function vnsprintf( $format, array $data)
{
   
preg_match_all( '/ (?<!%) % ( (?: [[:alpha:]_-][[:alnum:]_-]* | ([-+])? [0-9]+ (?(2) (?:\.[0-9]+)? | \.[0-9]+ ) ) ) \$ [-+]? \'? .? -? [0-9]* (\.[0-9]+)? \w/x', $format, $match, PREG_SET_ORDER | PREG_OFFSET_CAPTURE);
   
$offset = 0;
   
$keys = array_keys($data);
    foreach (
$match as &$value )
    {
        if ( (
$key = array_search( $value[1][0], $keys) ) !== FALSE || ( is_numeric( $value[1][0]) && ( $key = array_search( (int)$value[1][0], $keys) ) !== FALSE ) ) {
           
$len = strlen( $value[1][0]);
           
$format = substr_replace( $format, 1 + $key, $offset + $value[1][1], $len);
           
$offset -= $len - strlen( $key);
        }
    }
    return
vsprintf( $format, $data);
}

$examples = array(
   
2.8=>'positiveFloat',    // key = 2 , 1st value
   
-3=>'negativeInteger',    // key = -3 , 2nd value
   
'my_name'=>'someString'    // key = my_name , 3rd value
);

echo
vsprintf( "%%my_name\$s = '%my_name\$s'\n", $examples);    // [unsupported]
echo vnsprintf( "%%my_name\$s = '%my_name\$s'\n", $examples);    // output : "someString"

echo vsprintf( "%%2.5\$s = '%2.5\$s'\n", $examples);        // [unsupported]
echo vnsprintf( "%%2.5\$s = '%2.5\$s'\n", $examples);        // output : "positiveFloat"

echo vsprintf( "%%+2.5\$s = '%+2.5\$s'\n", $examples);        // [unsupported]
echo vnsprintf( "%%+2.5\$s = '%+2.5\$s'\n", $examples);        // output : "positiveFloat"

echo vsprintf( "%%-3.2\$s = '%-3.2\$s'\n", $examples);        // [unsupported]
echo vnsprintf( "%%-3.2\$s = '%-3.2\$s'\n", $examples);        // output : "negativeInteger"

echo vsprintf( "%%2\$s = '%2\$s'\n", $examples);            // output : "negativeInteger"
echo vnsprintf( "%%2\$s = '%2\$s'\n", $examples);            // output : [= vsprintf]

echo vsprintf( "%%+2\$s = '%+2\$s'\n", $examples);        // [unsupported]
echo vnsprintf( "%%+2\$s = '%+2\$s'\n", $examples);        // output : "positiveFloat"

echo vsprintf( "%%-3\$s = '%-3\$s'\n", $examples);        // [unsupported]
echo vnsprintf( "%%-3\$s = '%-3\$s'\n", $examples);        // output : "negativeInteger"
?>
up
3
dee jay simple zero07 at geemail dawt co
7 years ago
Using a heredoc with vprintf:

<?php
$string
= <<<THESTRING
I like the state of %1\$s <br />
I picked: %2\$d as a number, <br />
I also picked %2\$d as a number again <br />
%3\$s<br />
THESTRING;

$returnText = vprintf$string, array('Oregon','7','I Love Oregon')  );

echo
$returnText;
?>
up
1
steven at nevvix dot com
1 year ago
<?php
/**
* Return a formatted string like vsprintf() with named placeholders.
*
* When a placeholder doesn't have a matching key in `$args`,
*   the placeholder is returned as is to see missing args.
* @param string $format
* @param array $args
* @param string $pattern
* @return string
*/
function p($format, array $args, $pattern="/\{(\w+)\}/") {
    return
preg_replace_callback($pattern, function ($matches) use ($args) {
        return @
$args[$matches[1]] ?: $matches[0];
    },
$format);
}

$args = ["database"=>"people", "user"=>"staff", "pass"=>"pass123", "host"=>"localhost"];

// With PHP-like placeholders: the variable is embedded in a string "{$database}" but without the dollar sign
$format = <<<SQL
CREATE DATABASE IF NOT EXISTS {database};
GRANT ALL PRIVILEGES ON {database_name}.* TO '{user}'@'{host}';
SET PASSWORD = PASSWORD('{pass}');
SQL;
echo
p($format, $args);
/*
Result:

CREATE DATABASE IF NOT EXISTS people;
GRANT ALL PRIVILEGES ON {database_name}.* TO 'staff'@'localhost';
SET PASSWORD = PASSWORD('pass123');

The `{database_name}` placeholder doesn't exist as a matching key in `$args` so it's returned as is.
*/

// With Ruby-like placeholders
$format = <<<SQL
CREATE DATABASE IF NOT EXISTS :database;
GRANT ALL PRIVILEGES ON :database_name.* TO ':user'@':host';
SET PASSWORD = PASSWORD(':pass');
SQL;
echo
p($format, $args, "/:(\w+)/");
/*
Result:

CREATE DATABASE IF NOT EXISTS people;
GRANT ALL PRIVILEGES ON :database_name.* TO 'staff'@'localhost';
SET PASSWORD = PASSWORD('pass123');

The `:database_name` placeholder doesn't exist as a matching key in `$args` so it's returned as is.
*/
up
1
ASchmidt at Anamera dot net
2 years ago
It's necessary to clearly how to apply argument swapping when using an array of arguments. One might be tempted to use %0$ to reference $args[0].

In reality, the position specifier is always the array index+1:

$args[0]  is referenced by %1$...
$args[1]  is referenced by %2$...
etc.

Similarly, the first subpattern of a RegEx match would be found in $matches[1], the second in $match[2], etc. However if the $matches array is used as arguments to vsprint(), then the position specifier is subpattern+1:

preg_match( $pattern, $subject, $matches );
vsprintf( 'Full Match = %1$s, first Subpattern = %2$s, second Subpattern = %3$s', $matches );
up
-1
tbS dot P dot A dot M at S dot U dot K dot Staylorbarstow dot com
14 years ago
Simple but useful routine:

<?php
function vsprintf_iter($fmt,$data) {
    if (!
is_array($data)) return false;
   
$ret = '';
    foreach (
$data as $d) {
       
$ret .= vsprintf($fmt,$d);
    }
    return
$ret;
}
?>
up
-2
strata_ranger at hotmail dot com
9 years ago
Here's a simple variation on vsprintf() suitable for use with database queries where the results were retrieved as an associative array keyed by column names.

<?php

function dbsprintf($format, $fields, $row)
// $format - sprintf() compatible format string
// $row - Array containing key/value pairs of data
// $fields - Array containing key names (from $row) that are to be used as arguments
{
 
// Loop through $fields and insert the corresponding values from $row
 
foreach($fields as &$value)
  {
   
$value = $row[$value];
  } unset(
$value);
 
 
// Format the string and return
 
return vsprintf($format, $fields);
}

// Some data
$row = Array('id' => '12', 'name' => 'World');

// Outputs "Hello World!"
echo dbsprintf('Hello, %s!', Array('name'), $row);
// Outputs "Hello 12!"
echo dbsprintf('Hello, %s!', Array('id'), $row);

?>
up
-2
toneee at g mail dot com
14 years ago
I found this function to be useful for formatting sql queries.

I do something like this:

function sql_build($template, $params = array()) {
  global $sql_templates;
  if (isset($sql_templates[$template])) {
    $sql = vsprintf($sql_templates[$template], $params);
    return $sql;
  }
  return false;
}

// Fetch list of contacts, for a given section id
$sql_templates['contacts_by_section'] = <<<ENDSQL
select
  id,
  name,
  email, 
  address,
  photo_id
from
  contacts
where
  section_id = %d
ENDSQL;

You also give yourself an added layer of security on the sql due to the sprintf formatting. For example, using %d will not allow any sql injection for that parameter.
up
-2
samviseNOSPAM at hobbitonNOSPAM dot it
17 years ago
i wrote a short function that make use of vsprintf. It is useful in first coding/debugging of php scripts, because it is called like a simple printf and it display in italic (you can change it of course ;-) ) every debug messages, making it easy to remove them when your code is ready.

here goes :

<?php
function printd() {
       
$debug_array=func_get_args();
       
$debug_numargs=func_num_args();
       
$debug_fmt=$debug_array[0];
        for (
$i = 0 ; $i < $debug_numargs ; $i++ )
               
$debug_array[$i] = $debug_array[$i+1];
       
$debug_text=vsprintf($debug_fmt, $debug_array);
       
printf("--> debug <i>%s</i>\n",
               
$debug_text);
}
?>
up
-2
jeppe dot dyrby at gmail dot com
10 years ago
Heres a new version of the vnsprintf function, i call it dsprintf, but that should matter.

<?php
function dsprintf() {
 
$data = func_get_args(); // get all the arguments
 
$string = array_shift($data); // the string is the first one
 
if (is_array(func_get_arg(1))) { // if the second one is an array, use that
   
$data = func_get_arg(1);
  }
 
$used_keys = array();
 
// get the matches, and feed them to our function
 
$string = preg_replace('/\%\((.*?)\)(.)/e',
   
'dsprintfMatch(\'$1\',\'$2\',\$data,$used_keys)',$string);
 
$data = array_diff_key($data,$used_keys); // diff the data with the used_keys
 
return vsprintf($string,$data); // yeah!
}

function
dsprintfMatch($m1,$m2,&$data,&$used_keys) {
  if (isset(
$data[$m1])) { // if the key is there
   
$str = $data[$m1];
   
$used_keys[$m1] = $m1; // dont unset it, it can be used multiple times
   
return sprintf("%".$m2,$str); // sprintf the string, so %s, or %d works like it should
 
} else {
    return
"%".$m2; // else, return a regular %s, or %d or whatever is used
 
}
}
$str = "Hello, %(place)s, how is it hanning at %(place)s? %s works just as well";
$find = array(
 
'place' => 'world',
 
'sprintf',
 
'not used'
);
echo
dsprintf($str, $find);
// 'Hello, world, how is it hanning at world? sprintf works just as well'
?>
up
-6
thomas att familie dash flori dot de
7 years ago
Here is my example for named placeholders. It uses python like named placeholders except that it only allows /[a-z][a-zA-Z0-9_]/ for names.

<?php

/**
* Returns a formatted string. Accepts named arguments.
* @param string $format
* @param array $args
* @return string
**/
function vsprintfn($format, $args) {
   
// search format patterns
   
preg_match_all('/((?:^|[^%])(?:%%)*)%(\([a-z][a-zA-Z0-9_]*\))?((\+|-)?(0| |\'.)?-?[0-9\.]*[bcdeEufFgGosxX])/', $format, $matches);
   
// determine the order of the arguments
   
$j = 0;
   
$order = array();
    foreach (
$matches[0] as $i => $match) {
        if (
$matches[2][$i] == '') {
           
$key = $j++;
        } else {
           
$key = substr($matches[2][$i],1,-1);
        }
       
$order[] = $key;
    }
   
// prepare the data array for vsprintf in the given order
   
$data = array();
    foreach (
$order as $key) {
        if (isset(
$args[$key])) {
           
$data[] = $args[$key];
        }
    }
   
// replace named format patterns with default format patterns
   
$format = preg_replace('/((?:^|[^%])(?:%%)*)%(\([a-z][a-zA-Z0-9_]*\))((\+|-)?(0| |\'.)?-?[0-9\.]*[bcdeEufFgGosxX])/', '$1%$3', $format);
   
// return formatted string
   
return vsprintf($format, $data);
}

$exampleData = array(0=>2.2314123123,'test'=>2.1234883);
echo
vsprintfn('%%2.5f = %2.5f', $exampleData) . "\n";
echo
vsprintfn('%%(test)09.5f = %(test)\'%9.5f', $exampleData) . "\n";

?>
To Top