Text_Diff_Engine_string::diff( string $diff, string $mode = 'autodetect' ): array

Description

Compatibility

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

Parameters

$diffstring

The diff content.

$modestringoptional

The diff mode of the content in $diff. One of 'context', 'unified', or 'autodetect'.Default: 'autodetect'

Return value

array

List of all diff operations.

Performance profile

How much work a call to Text_Diff_Engine_string::diff() 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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

23–67

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What one call costs · 5 distinct outcomes

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

Uses · 3

• PEAR::raiseError()
• Text_Diff_Engine_string::parseContextDiff()Parses an array containing the context diff.
• Text_Diff_Engine_string::parseUnifiedDiff()Parses an array containing the unified diff.

Source code

View on Trac ↗View on GitHub ↗

38    function diff($diff, $mode = 'autodetect')39    {40        // Detect line breaks.41        $lnbr = "\n";42        if (strpos($diff, "\r\n") !== false) {43            $lnbr = "\r\n";44        } elseif (strpos($diff, "\r") !== false) {45            $lnbr = "\r";46        }47 48        // Make sure we have a line break at the EOF.49        if (substr($diff, -strlen($lnbr)) != $lnbr) {50            $diff .= $lnbr;51        }52 53        if ($mode != 'autodetect' && $mode != 'context' && $mode != 'unified') {54            return PEAR::raiseError('Type of diff is unsupported');55        }56 57        if ($mode == 'autodetect') {58            $context = strpos($diff, '***');59            $unified = strpos($diff, '---');60            if ($context === $unified) {61                return PEAR::raiseError('Type of diff could not be detected');62            } elseif ($context === false || $unified === false) {63                $mode = $context !== false ? 'context' : 'unified';64            } else {65                $mode = $context < $unified ? 'context' : 'unified';66            }67        }68 69        // Split by new line and remove the diff header, if there is one.70        $diff = explode($lnbr, $diff);71        if (($mode == 'context' && strpos($diff[0], '***') === 0) ||72            ($mode == 'unified' && strpos($diff[0], '---') === 0)) {73            array_shift($diff);74            array_shift($diff);75        }76 77        if ($mode == 'context') {78            return $this->parseContextDiff($diff);79        } else {80            return $this->parseUnifiedDiff($diff);81        }82    }

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/Text/Diff/Engine/string.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.