Skip to main content

Top-10 PHP String Functions

By day I work as a programmer at ShoreGroup, Inc. By night I'm a freelance developer and now the managing editor for SitePoint's latest site, PHPMaster.com. Helping out with the site has been pretty fun so far; my Australian counterparts are all pretty cool, and I've met some really great new authors too. If you haven't visited yet, take a moment and check out PHPMaster.com (there's still some wrinkles to iron out on the site, but we're working to identify and fix them all as soon as we can).

Part of my duties as a managing editor include working with authors to make sure the site's content is well balanced. PHPMaster.com is targeting PHP programmers of all skill levels, so there should be a good mix of basic, beginner, intermediate, and advanced content. Planning for a beginner article that demonstrates basic string handling functions, I wondered which function to highlight. I wanted to show ones that would be most relevant, not necessarily ones that were my favorite, so I decided to do some static analysis of popular open-source projects to find out which string functions were used the most. The results were surprising, so I thought I'd share my "research."

I used the source of a closed-source PHP project that I have access to and the following open-source (or open-source-ish) projects as code samples for the analysis:

Then I ran the following PHP to tally the functions:

#! /usr/bin/env php
<?php
if ($_SERVER["argc"] != 4) {
    $script = basename(__FILE__);
    fprintf(STDERR, "usage: %s directory max exts\n", $script);
    fprintf(STDERR, "\tdirectory - directory to start traversal\n");
    fprintf(STDERR, "\tmax - maximum number of results to return\n");
    fprintf(STDERR, "\texts - comma-separated list of file extensions\n");
    fprintf(STDERR, "example: %s /var/www 20 php,inc\n", $script);
    exit(1);
}
// no error-checking... don't be stupid
$directory = $_SERVER["argv"][1];
$max = $_SERVER["argv"][2];
$extsRegex = "/(" . str_replace(",", "|", $_SERVER["argv"][3]) . ')$/';

$dirIter = new RecursiveDirectoryIterator($directory);
$recIter = new RecursiveIteratorIterator($dirIter);
$iter = new RegexIterator($recIter, $extsRegex);

$funcs = array();
foreach ($iter as $file) {
    $tokens = token_get_all(file_get_contents($file));
    foreach ($tokens as $t) {
        if (is_array($t) && $t[0] == T_STRING && function_exists($t[1])) {
            if (!isset($funcs[$t[1]])) {
                $funcs[$t[1]] = 0;
            }
            $funcs[$t[1]]++;
        }
    }
}
arsort($funcs);

$max = min(count($funcs), $max);
if ($max) {
    list($funcs) = array_chunk($funcs, $max, true);
}
print_r($funcs);

I took the resulting list of functions and extracted the string-specific ones to come up with this top-10 list (sorted in decreasing order of most-used):

  1. substr() - 6,605
  2. sprintf() - 5,604
  3. implode()/join() - 4,829
  4. strlen() - 4,557
  5. chr() - 4,122
  6. str_replace() - 4,009
  7. explode() - 3,401
  8. strpos() - 3,238
  9. htmlspecialchars() - 3,171
  10. trim() - 2,998

I expected functions like substr() and trim() to be on the list, but chr() was a surprise. Before this I probably would have laughed at you if you told me chr() is used almost twice as much as strtolower() (which came in 12th place with 2,267). Interesting results indeed!

Comments

  1. These strings are really helpful for PHP developers and thanks a lot for sharing them with us.

    ReplyDelete

Post a Comment

Popular posts from this blog

Writing a Minimal PSR-0 Autoloader

An excellent overview of autoloading in PHP and the PSR-0 standard was written by Hari K T over at PHPMaster.com , and it's definitely worth the read. But maybe you don't like some of the bloated, heavier autoloader offerings provided by various PHP frameworks, or maybe you just like to roll your own solutions. Is it possible to roll your own minimal loader and still be compliant? First, let's look at what PSR-0 mandates, taken directly from the standards document on GitHub : A fully-qualified namespace and class must have the following structure \<Vendor Name>\(<Namespace>\)*<Class Name> Each namespace must have a top-level namespace ("Vendor Name"). Each namespace can have as many sub-namespaces as it wishes. Each namespace separator is converted to a DIRECTORY_SEPARATOR when loading from the file system. Each "_" character in the CLASS NAME is converted to a DIRECTORY_SEPARATOR . The "_" character has no special ...

Safely Identify Dependencies for Chrooting

The most difficult part of setting up a chroot environment is identifying dependencies for the programs you want to copy to the jail. For example, to make cp available, not only do you need to copy its binary from /bin and any shared libraries it depends on, but the dependencies can have their own dependencies too that need to be copied. The internet suggests using ldd to list a binary’s dependencies, but that has its own problems. The man page for ldd warns not to use the script for untrusted programs because it works by setting a special environment variable and then executes the program. What’s a security-conscious systems administrator to do? The ldd man page recommends objdump as a safe alternative. objdump outputs information about an object file, including what shared libraries it links against. It doesn’t identify the dependencies’ dependencies, but it’s still a good start because it doesn’t try to execute the target file. We can overcome the dependencies of depende...

A Unicode fgetc() in PHP

In preparation for a presentation I’m giving at this month’s Syracuse PHP Users Group meeting, I found the need to read in Unicode characters in PHP one at a time. Unicode is still second-class in PHP; PHP6 failed and we have to fallback to extensions like the mbstring extension and/or libraries like Portable UTF-8 . And even with those, I didn’t see a unicode-capable fgetc() so I wrote my own. Years ago, I wrote a post describing how to read Unicode characters in C , so the logic was already familiar. As a refresher, UTF-8 is a multi-byte encoding scheme capable of representing over 2 million characters using 4 bytes or less. The first 128 characters are encoded the same as 7-bit ASCII with 0 as the most-significant bit. The other characters are encoded using multiple bytes, each byte with 1 as the most-significant bit. The bit pattern in the first byte of a multi-byte sequence tells us how many bytes are needed to represent the character. Here’s what the function looks like: f...