sscanf

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

sscanf문자열을 형식에 따라 해석

설명

mixed sscanf ( string $str , string $format [, mixed &$... ] )

sscanf()printf()의 입력 형태입니다. sscanf()는 문자열 str을 읽어서 지정한 format에 따라 해석합니다. 형식은 sprintf() 문서에 설명되어 있습니다.

포맷 문자열의 모든 종류의 공백은 입력 문자열의 어떠한 공백에도 매치합니다. 이는 포맷 문자열의 탭 \t이 입력 문자열의 하나의 스페이스 문자에도 매치한다는 것을 의미합니다.

인수

str

해석할 입력 string.

format

str를 해석할 형식. sprintf() 문서에 설명되어 있습니다.

...

해석한 값을 가질 선택적인 참조 변수.

반환값

두 인수만 넘기면, 값을 해석하여 배열로 반환합니다. 혹은, 선택적인 인수를 넘기면, 할당한 값의 갯수를 반환합니다. 선택적인 인수는 참조로 넘겨야 합니다.

예제

Example #1 sscanf() 예제

<?php
// 시리얼 번호 얻기
list($serial) = sscanf("SN/2350001""SN/%d");
// 제조일 얻기
$mandate "January 01 2000";
list(
$month$day$year) = sscanf($mandate"%s %d %d");
echo 
"Item $serial was manufactured on: $year-" substr($month03) . "-$day\n";
?>

선택적인 인수를 지정하면, 할당한 값의 수를 반환합니다.

Example #2 sscanf() - 선택 인수 사용하기

<?php
// 작가 정보를 얻어서 DocBook 엔트리를 생성합니다.
$auth "24\tLewis Carroll";
$n sscanf($auth"%d\t%s %s"$id$first$last);
echo 
"<author xml:id='$id'>
    <firstname>
$first</firstname>
    <surname>
$last</surname>
</author>\n"
;
?>

참고

  • fscanf() - Parses input from a file according to a format
  • printf() - 형식화한 문자열을 출력
  • sprintf() - 형식화한 문자열을 반환

add a note add a note

User Contributed Notes 18 notes

up
67
jon at fuck dot org
22 years ago
this function is a great way to get integer rgb values from the html equivalent hex.

list($r, $g, $b) = sscanf('00ccff', '%2x%2x%2x');
up
16
elgabos at umail dot ucsb dot edu
22 years ago
After playing around with this for a while, I found that if you use %[^[]] instead of %s (since php has problems with spaces when using %s) it works nicely.

For those that aren't familiar with regular expressions, %[^[]] basically matches anything that isn't nothing.

Hope this helps. - Gabe
up
16
mikewillitsgmail.com
16 years ago
FYI - if you are trying to scan from a string which contains a filename with extension. For instance:

<?php

$out
= sscanf('file_name.gif', 'file_%s.%s', $fpart1, $fpart2);

?>

The scanned string in the $fpart1 parameter turns out to be 'name.gif' and $fpart2 will be NULL.

To get around this you can simply replace the "." with a space or another "white-space like" string sequence.

I didn't see any other comments on regarding string literals which contain a '.' so I thought I'd mention it. The subtle characteristics of having "white-space delimited" content I think can be a source of usage contention. Obviously, another way to go is regular expressions in this instance, but for newer users this may be helpful.

Just in case someone else spent 10 minutes of frustration like I did. This was seen on PHP Version 5.2.3-1ubuntu6.3.

Searching the bug reports shows another users misunderstanding: http://bugs.php.net/bug.php?id=7793
up
4
Brainiac361
19 years ago
The %[^[]]-trick may seem to work, but it doesn't!

What happens is that sscanf will simply match any characters but an opening square bracket (which is rather rare and that's why it might just seem to work).
But even worse it will expect a ]-character next and continue to match anything.

Now what you can do is make sscanf look for any character but a character that is really never used... a good choice is the linebreak "%[^\\n]", especially in combination with fscanf.

What you can also do is copy and paste any unused ascii character like #001 or something.
up
5
leg
16 years ago
@mikewillitsgmail.com:

<?php

$out
= sscanf('file_name.gif', 'file_%[^.].%s', $fpart1, $fpart2);

echo
'<pre>';
print_r($fpart1);
echo
'<hr />';
print_r($fpart2);
echo
'</pre>';

?>

output:

name
-
gif

The "^." part avoid the first searched string to be too greedy. But doesn't protect you against an "file_test.name.gif" input, with bad results!
up
4
Victor
12 years ago
One thing to note: unlike C/C++, a variable %n is assigned to will be counted in the return value.
up
3
Vincent Jansen
19 years ago
If you just wants filter out information between two parts of a string, i used the following, it works better for me then the sscanf function.

<?php
function scanstr($zoekstr,$part1,$part2) {
$firstpos=strpos ($zoekstr, $part1)+strlen($part1);
$lastpos=strpos ($zoekstr, $part2);
$scanresult=substr ($zoekstr, $firstpos, $lastpos-$firstpos);
    return(
$scanresult);
}
echo
scanstr ("var1=hello&var2=test&var3=more","var2=","&var3");
?>
up
2
anonymouse
18 years ago
I've seen several examples of people using brackets to define what look like regexp character classes. In my limited testing I don't think they are genuine character classes but they seem to be similar.

My task was to use sscanf() to parse an array of strings with the format:

number SPACE string_which_may_also_have_spaces

The normal %s conversion command treats spaces as some kind of delimiter. So, you can get the strings if you know beforehand how many "words" there will be. But, my input was variable.

Here's what I came up with: (note use of the dollar-sign 'end of string' hidden delimiter)

sscanf($string_to_parse,'%d %[^$]s',$num,$text);

This conversion command says "look for an integer, then a space, then any string up to the end of the string"
up
2
codeslinger at compsalot dot com
19 years ago
Security Note:

Although it is a very powerful technique, keep in mind that it is easily deceived.

Many successful exploits have been based on scanf attacks.  It should not be used on untrusted input without a lot of additional validation.
up
2
skeltoac
18 years ago
To parse a line from an Apache access log in common format:

<?php
$log
= array();
$n = sscanf(trim($line), '%s %s %s [%[^]]] "%s %s %[^"]" %d %s "%[^"]" "%[^"]"',
   
$log['ip'],
   
$log['client'],
   
$log['user'],
   
$log['time'],
   
$log['method'],
   
$log['uri'],
   
$log['prot'],
   
$log['code'],
   
$log['bytes'],
   
$log['ref'],
   
$log['agent']
);
?>
up
1
narainsbrain at yahoo dot com
23 years ago
apparently, sscanf always splits at spaces, even if spaces are not specified in the format. consider this script:

<?php
$str
= "This is a\tsentence with\ttabs";
$scanned = sscanf($str, "%s\t%s\t%s");
echo
join(" : ", $scanned);
?>

this echoes "This : is : a", not the expected "This is a : sentence with : tabs."
this behaviour is fine if your strings don't contain spaces, but if they do you'd be better off using explode().
up
0
Philo
4 years ago
It should also be noted that when used with sscanf both x and X produce the same output (i.e. they are case-insensitive).

<?php
var_dump
(sscanf("0xdead|0XDEAD", "%X|%x")); // works
up
0
joshmckenneyATgmailDOT(0{
19 years ago
added country code (1) to phone number function:

function formatPhone($phone) {
       if (empty($phone)) return "";
       if (strlen($phone) == 7)
               sscanf($phone, "%3s%4s", $prefix, $exchange);
       else if (strlen($phone) == 10)
               sscanf($phone, "%3s%3s%4s", $area, $prefix, $exchange);
       else if (strlen($phone) > 10)
               if(substr($phone,0,1)=='1') {
                                 sscanf($phone, "%1s%3s%3s%4s", $country, $area, $prefix, $exchange);
                             }
                             else{
                                 sscanf($phone, "%3s%3s%4s%s", $area, $prefix, $exchange, $extension);
                                }
       else
               return "unknown phone format: $phone";
       $out = "";
       $out .= isset($country) ? $country.' ' : '';
       $out .= isset($area) ? '(' . $area . ') ' : '';
       $out .= $prefix . '-' . $exchange;
       $out .= isset($extension) ? ' x' . $extension : '';
       return $out;
}
up
-1
clcollie at mindspring dot com
24 years ago
Actually sscanf()_always_ returns an array if you specify less return variables than format specifiers. i may change this to return a scalar if only a single format specifier exists.
  Note that sscanf() is (almost) the complete functional equivalent of its "C" counterpart, so you can do the following to get the expected effect :

   sscanf("SN/2350001","SN/%d",&$serial)

The array return was a nicety for PHP.
up
-3
marcus at synchromedia dot co dot uk
21 years ago
In PHP >= 4.3.0, if you use additional reference parameters, you will get this warning:

PHP Warning:  Call-time pass-by-reference has been deprecated - argument passed by value

This clearly has the potential to cause unexpected consequences (vars left empty), and will break existing code. So don't do it! These docs need updating to say this too.

The syntax:

    list($a, $b) = sscanf("hello world", "%s %s");

will work as expected, and doesn't seem to cause any problems with Apache that I've noticed.
up
-4
sbarnum.pointsystems@com
22 years ago
More fun with phones!  This assumes that the phone number is 10 digits, with only numeric data, but it would be easy to check the length of the string first.

function formatPhone($phone) {
        if (empty($phone)) return "";
        sscanf($phone, "%3d%3d%4d", $area, $prefix, $exchange);
        $out = @$area ? "($area) " : "";
        $out .= $prefix . '-' . $exchange;
        return $out;
}
up
-9
nmmm at nmmm dot nu
12 years ago
This is more like C/C++ example, but works on PHP too.

<?php
$qs
= "index.php?id=34&name=john";

print_r(   sscanf($qs, "%[^?]?%[^?]")   );

$qs = "id=34&name=john";

print_r(   sscanf($qs, "id=%[^&]&name=%[^&]")   );
?>
up
-10
Igor Feghali
16 years ago
parses an input string with fixed field sizes that contains data with spaces:

<?php
$result
= sscanf("  Vendor: My Vendo Model: Super Model Foo  Rev: 1234"
                
'  Vendor: %8[ -~] Model: %16[ -~] Rev: %4c',
                
$vendor, $model, $rev);
?>

$vendor => My Vendo
$model => Super Model Foo
$rev => 1234
To Top