PclZip::privAddFile( $p_filedescr, $p_header, $p_options )

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_filedescr

$p_header

$p_options

Performance profile

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

Heavy

Reads or writes the filesystem via filemtime().

Scaling

Constant

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

Instructions

85–218

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

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

What it touches

• filesystemfilesystem accessfilemtime()called directly

What one call costs · 148 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 6

• PclZipUtilPathReduction()
• PclZip::privErrorLog()
• PclZip::errorCode()
• PclZip::privConvertHeader2FileInfo()
• PclZip::privAddFileUsingTempFile()
• PclZip::privWriteFileHeader()

Used by · 1

• PclZip::privAddFileList()

Source code

View on Trac ↗View on GitHub ↗

2530  function privAddFile($p_filedescr, &$p_header, &$p_options)2531  {2532    $v_result=1;2533 2534    // ----- Working variable2535    $p_filename = $p_filedescr['filename'];2536 2537    // TBC : Already done in the fileAtt check ... ?2538    if ($p_filename == "") {2539      // ----- Error log2540      PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid file list parameter (invalid or empty list)");2541 2542      // ----- Return2543      return PclZip::errorCode();2544    }2545 2546    // ----- Look for a stored different filename2547    /* TBC : Removed2548    if (isset($p_filedescr['stored_filename'])) {2549      $v_stored_filename = $p_filedescr['stored_filename'];2550    }2551    else {2552      $v_stored_filename = $p_filedescr['stored_filename'];2553    }2554    */2555 2556    // ----- Set the file properties2557    clearstatcache();2558    $p_header['version'] = 20;2559    $p_header['version_extracted'] = 10;2560    $p_header['flag'] = 0;2561    $p_header['compression'] = 0;2562    $p_header['crc'] = 0;2563    $p_header['compressed_size'] = 0;2564    $p_header['filename_len'] = strlen($p_filename);2565    $p_header['extra_len'] = 0;2566    $p_header['disk'] = 0;2567    $p_header['internal'] = 0;2568    $p_header['offset'] = 0;2569    $p_header['filename'] = $p_filename;2570// TBC : Removed    $p_header['stored_filename'] = $v_stored_filename;2571    $p_header['stored_filename'] = $p_filedescr['stored_filename'];2572    $p_header['extra'] = '';2573    $p_header['status'] = 'ok';2574    $p_header['index'] = -1;2575 2576    // ----- Look for regular file2577    if ($p_filedescr['type']=='file') {2578      $p_header['external'] = 0x00000000;2579      $p_header['size'] = filesize($p_filename);2580    }2581 2582    // ----- Look for regular folder2583    else if ($p_filedescr['type']=='folder') {2584      $p_header['external'] = 0x00000010;2585      $p_header['mtime'] = filemtime($p_filename);2586      $p_header['size'] = filesize($p_filename);2587    }2588 2589    // ----- Look for virtual file2590    else if ($p_filedescr['type'] == 'virtual_file') {2591      $p_header['external'] = 0x00000000;2592      $p_header['size'] = strlen($p_filedescr['content']);2593    }2594 2595 2596    // ----- Look for filetime2597    if (isset($p_filedescr['mtime'])) {2598      $p_header['mtime'] = $p_filedescr['mtime'];2599    }2600    else if ($p_filedescr['type'] == 'virtual_file') {2601      $p_header['mtime'] = time();2602    }2603    else {2604      $p_header['mtime'] = filemtime($p_filename);2605    }2606 2607    // ------ Look for file comment2608    if (isset($p_filedescr['comment'])) {2609      $p_header['comment_len'] = strlen($p_filedescr['comment']);

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.