ParagonIE_Sodium_Core_Base64_Original::doEncode( string $src, bool $pad = true ): string

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$srcstring

$padbooloptional

Include = padding?Default: true

Return value

string

Performance profile

How much work a call to ParagonIE_Sodium_Core_Base64_Original::doEncode() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

15–54

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 111.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What one call costs · 3 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost ParagonIE_Sodium_Core_Base64_Original::doEncode() can have, taken from its control-flow graph on PHP 8.5.

Uses · 3

• ParagonIE_Sodium_Core_Util::strlen()Safe string length
• ParagonIE_Sodium_Core_Util::substr()Safe substring
• ParagonIE_Sodium_Core_Base64_Original::encode6Bits()Uses bitwise operators instead of table-lookups to turn 8-bit integers into 6-bit integers.

Used by · 2

• ParagonIE_Sodium_Core_Base64_Original::encode()Encode into Base64
• ParagonIE_Sodium_Core_Base64_Original::encodeUnpadded()Encode into Base64, no = padding

Source code

View on Trac ↗View on GitHub ↗

46    protected static function doEncode($src, $pad = true)47    {48        $dest = '';49        $srcLen = ParagonIE_Sodium_Core_Util::strlen($src);50        // Main loop (no padding):51        for ($i = 0; $i + 3 <= $srcLen; $i += 3) {52            /** @var array<int, int> $chunk */53            $chunk = unpack('C*', ParagonIE_Sodium_Core_Util::substr($src, $i, 3));54            $b0 = $chunk[1];55            $b1 = $chunk[2];56            $b2 = $chunk[3];57 58            $dest .=59                self::encode6Bits(               $b0 >> 2       ) .60                self::encode6Bits((($b0 << 4) | ($b1 >> 4)) & 63) .61                self::encode6Bits((($b1 << 2) | ($b2 >> 6)) & 63) .62                self::encode6Bits(  $b2                     & 63);63        }64        // The last chunk, which may have padding:65        if ($i < $srcLen) {66            /** @var array<int, int> $chunk */67            $chunk = unpack('C*', ParagonIE_Sodium_Core_Util::substr($src, $i, $srcLen - $i));68            $b0 = $chunk[1];69            if ($i + 1 < $srcLen) {70                $b1 = $chunk[2];71                $dest .=72                    self::encode6Bits($b0 >> 2) .73                    self::encode6Bits((($b0 << 4) | ($b1 >> 4)) & 63) .74                    self::encode6Bits(($b1 << 2) & 63);75                if ($pad) {76                    $dest .= '=';77                }78            } else {79                $dest .=80                    self::encode6Bits( $b0 >> 2) .81                    self::encode6Bits(($b0 << 4) & 63);82                if ($pad) {83                    $dest .= '==';84                }85            }86        }87        return $dest;88    }

Changelog

Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/sodium_compat/src/Core/Base64/Original.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.