PclZip::privFileDescrParseAtt( $p_file_list, $p_filedescr, $v_options, $v_requested_options = false )

Compatibility

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

Parameters

$p_file_list

$p_filedescr

$v_options

$v_requested_optionsoptional

Default: false

Performance profile

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

7–63

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

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 · 6 distinct outcomes

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

Uses · 4

• PclZipUtilOptionText()
• PclZipUtilPathReduction()
• PclZip::privErrorLog()
• PclZip::errorCode()

Used by · 2

• PclZip::add()
• PclZip::create()

Source code

View on Trac ↗View on GitHub ↗

1875  function privFileDescrParseAtt(&$p_file_list, &$p_filedescr, $v_options, $v_requested_options=false)1876  {1877    $v_result=1;1878 1879    // ----- For each file in the list check the attributes1880    foreach ($p_file_list as $v_key => $v_value) {1881 1882      // ----- Check if the option is supported1883      if (!isset($v_requested_options[$v_key])) {1884        // ----- Error log1885        PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid file attribute '".$v_key."' for this file");1886 1887        // ----- Return1888        return PclZip::errorCode();1889      }1890 1891      // ----- Look for attribute1892      switch ($v_key) {1893        case PCLZIP_ATT_FILE_NAME :1894          if (!is_string($v_value)) {1895            PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid type ".gettype($v_value).". String expected for attribute '".PclZipUtilOptionText($v_key)."'");1896            return PclZip::errorCode();1897          }1898 1899          $p_filedescr['filename'] = PclZipUtilPathReduction($v_value);1900 1901          if ($p_filedescr['filename'] == '') {1902            PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid empty filename for attribute '".PclZipUtilOptionText($v_key)."'");1903            return PclZip::errorCode();1904          }1905 1906        break;1907 1908        case PCLZIP_ATT_FILE_NEW_SHORT_NAME :1909          if (!is_string($v_value)) {1910            PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid type ".gettype($v_value).". String expected for attribute '".PclZipUtilOptionText($v_key)."'");1911            return PclZip::errorCode();1912          }1913 1914          $p_filedescr['new_short_name'] = PclZipUtilPathReduction($v_value);1915 1916          if ($p_filedescr['new_short_name'] == '') {1917            PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid empty short filename for attribute '".PclZipUtilOptionText($v_key)."'");1918            return PclZip::errorCode();1919          }1920        break;1921 1922        case PCLZIP_ATT_FILE_NEW_FULL_NAME :1923          if (!is_string($v_value)) {1924            PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid type ".gettype($v_value).". String expected for attribute '".PclZipUtilOptionText($v_key)."'");1925            return PclZip::errorCode();1926          }1927 1928          $p_filedescr['new_full_name'] = PclZipUtilPathReduction($v_value);1929 1930          if ($p_filedescr['new_full_name'] == '') {1931            PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid empty full filename for attribute '".PclZipUtilOptionText($v_key)."'");1932            return PclZip::errorCode();1933          }1934        break;1935 1936        // ----- Look for options that takes a string1937        case PCLZIP_ATT_FILE_COMMENT :1938          if (!is_string($v_value)) {1939            PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid type ".gettype($v_value).". String expected for attribute '".PclZipUtilOptionText($v_key)."'");1940            return PclZip::errorCode();1941          }1942 1943          $p_filedescr['comment'] = $v_value;1944        break;1945 1946        case PCLZIP_ATT_FILE_MTIME :1947          if (!is_int($v_value)) {1948            PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid type ".gettype($v_value).". Integer expected for attribute '".PclZipUtilOptionText($v_key)."'");1949            return PclZip::errorCode();1950          }1951 1952          $p_filedescr['mtime'] = $v_value;1953        break;1954

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-admin/includes/class-pclzip.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.