PclZip::privFileDescrExpand( $p_filedescr_list, $p_options )
- Source
wp-admin/includes/class-pclzip.php:2004
Compatibility
- WordPress
- core
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
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_list$p_options
Performance profile
How much work a call to PclZip::privFileDescrExpand() 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
- Scaling
- Scales with input
- Instructions
- 11–92
- Plugin surface
- None
- Called by
- 3
Reads or writes the filesystem via file_exists().
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 158.
Nothing here hands control to plugin code.
3 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- filesystemfilesystem access
file_exists()called directly
What one call costs · 8 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost PclZip::privFileDescrExpand() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!$i | 11 | none |
$i && !file_exists() && !isset($v_descr) | 44 | PclZipUtilTranslateWinPath(), PclZipUtilPathReduction(), file_exists(), ::PclZip(), ::PclZip() |
$i && !file_exists() && isset($v_descr) && $v_dirlist_nb != 0 && $v_result != 1 | 66 | PclZipUtilTranslateWinPath(), PclZipUtilPathReduction(), file_exists(), ->privCalculateStoredFilename(), opendir(), ->privFileDescrExpand() |
$i && file_exists() && is_file() && $v_dirlist_nb != 0 && $v_result != 1 | 71 | PclZipUtilTranslateWinPath(), PclZipUtilPathReduction(), file_exists(), is_file(), ->privCalculateStoredFilename(), opendir(), ->privFileDescrExpand() |
$i && file_exists() && !is_file() && is_dir() && $v_dirlist_nb != 0 && $v_result != 1 | 78 | PclZipUtilTranslateWinPath(), PclZipUtilPathReduction(), file_exists(), is_file(), is_dir(), ->privCalculateStoredFilename(), opendir(), ->privFileDescrExpand() |
$i && !file_exists() && isset($v_descr) && $v_item_handler === false && $v_dirlist_nb != 0 && $v_result != 1 | 80 | PclZipUtilTranslateWinPath(), PclZipUtilPathReduction(), file_exists(), ->privCalculateStoredFilename(), opendir(), readdir(), closedir(), ->privFileDescrExpand() |
$i && file_exists() && is_file() && $v_item_handler === false && $v_dirlist_nb != 0 && $v_result != 1 | 85 | PclZipUtilTranslateWinPath(), PclZipUtilPathReduction(), file_exists(), is_file(), ->privCalculateStoredFilename(), opendir(), readdir(), closedir(), ->privFileDescrExpand() |
$i && file_exists() && !is_file() && is_dir() && $v_item_handler === false && $v_dirlist_nb != 0 && $v_result != 1 | 92 | PclZipUtilTranslateWinPath(), PclZipUtilPathReduction(), file_exists(), is_file(), is_dir(), ->privCalculateStoredFilename(), opendir(), readdir(), closedir(), ->privFileDescrExpand() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 158 | 11–92 | 15 | |
| 8.5 | 158 | 11–92 | 15 | |
| 8.4 | 158 | 11–92 | 15 | |
| 8.3 | 158 | 11–92 | 15 | |
| 8.2 | 158 | 11–92 | 15 | 1 more instruction than PHP 8.1 |
| 8.1 | 157 | 11–119 | 15 | |
| 7.4 | 157 | 11–119 | 15 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 6
Used by · 3
Source code
function privFileDescrExpand(&$p_filedescr_list, &$p_options) { $v_result=1; // ----- Create a result list $v_result_list = array(); // ----- Look each entry for ($i=0; $i<sizeof($p_filedescr_list); $i++) { // ----- Get filedescr $v_descr = $p_filedescr_list[$i]; // ----- Reduce the filename $v_descr['filename'] = PclZipUtilTranslateWinPath($v_descr['filename'], false); $v_descr['filename'] = PclZipUtilPathReduction($v_descr['filename']); // ----- Look for real file or folder if (file_exists($v_descr['filename'])) { if (@is_file($v_descr['filename'])) { $v_descr['type'] = 'file'; } else if (@is_dir($v_descr['filename'])) { $v_descr['type'] = 'folder'; } else if (@is_link($v_descr['filename'])) { // skip continue; } else { // skip continue; } } // ----- Look for string added as file else if (isset($v_descr['content'])) { $v_descr['type'] = 'virtual_file'; } // ----- Missing file else { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_MISSING_FILE, "File '".$v_descr['filename']."' does not exist"); // ----- Return return PclZip::errorCode(); } // ----- Calculate the stored filename $this->privCalculateStoredFilename($v_descr, $p_options); // ----- Add the descriptor in result list $v_result_list[sizeof($v_result_list)] = $v_descr; // ----- Look for folder if ($v_descr['type'] == 'folder') { // ----- List of items in folder $v_dirlist_descr = array(); $v_dirlist_nb = 0; if ($v_folder_handler = @opendir($v_descr['filename'])) { while (($v_item_handler = @readdir($v_folder_handler)) !== false) { // ----- Skip '.' and '..' if (($v_item_handler == '.') || ($v_item_handler == '..')) { continue; } // ----- Compose the full filename $v_dirlist_descr[$v_dirlist_nb]['filename'] = $v_descr['filename'].'/'.$v_item_handler; // ----- Look for different stored filename // Because the name of the folder was changed, the name of the // files/sub-folders also change if (($v_descr['stored_filename'] != $v_descr['filename']) && (!isset($p_options[PCLZIP_OPT_REMOVE_ALL_PATH]))) { if ($v_descr['stored_filename'] != '') { $v_dirlist_descr[$v_dirlist_nb]['new_full_name'] = $v_descr['stored_filename'].'/'.$v_item_handler; } else {Changelog
Unchanged from 6.7.7 through 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.