PclZip::privDeleteByRule( $p_result_list, $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_result_list

$p_options

Performance profile

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

Scaling

Scales with input

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

Instructions

9–131

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

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 accessunlink()called directly

What one call costs · 16 distinct outcomes

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

Uses · 12

• PclZipUtilCopyBlock()
• PclZipUtilRename()
• PclZip::privOpenFd()
• PclZip::privReadEndCentralDir()
• PclZip::privCloseFd()
• PclZip::privErrorLog()
• PclZip::errorCode()
• PclZip::privReadCentralFileHeader()
• PclZip::__construct()
• PclZip::privReadFileHeader()
• PclZip::privCheckFileHeaders()
• PclZip::privWriteCentralHeader()

Used by · 1

• PclZip::delete()

Source code

View on Trac ↗View on GitHub ↗

4710  function privDeleteByRule(&$p_result_list, &$p_options)4711  {4712    $v_result=1;4713    $v_list_detail = array();4714 4715    // ----- Open the zip file4716    if (($v_result=$this->privOpenFd('rb')) != 1)4717    {4718      // ----- Return4719      return $v_result;4720    }4721 4722    // ----- Read the central directory information4723    $v_central_dir = array();4724    if (($v_result = $this->privReadEndCentralDir($v_central_dir)) != 1)4725    {4726      $this->privCloseFd();4727      return $v_result;4728    }4729 4730    // ----- Go to beginning of File4731    @rewind($this->zip_fd);4732 4733    // ----- Scan all the files4734    // ----- Start at beginning of Central Dir4735    $v_pos_entry = $v_central_dir['offset'];4736    @rewind($this->zip_fd);4737    if (@fseek($this->zip_fd, $v_pos_entry))4738    {4739      // ----- Close the zip file4740      $this->privCloseFd();4741 4742      // ----- Error log4743      PclZip::privErrorLog(PCLZIP_ERR_INVALID_ARCHIVE_ZIP, 'Invalid archive size');4744 4745      // ----- Return4746      return PclZip::errorCode();4747    }4748 4749    // ----- Read each entry4750    $v_header_list = array();4751    $j_start = 0;4752    for ($i=0, $v_nb_extracted=0; $i<$v_central_dir['entries']; $i++)4753    {4754 4755      // ----- Read the file header4756      $v_header_list[$v_nb_extracted] = array();4757      if (($v_result = $this->privReadCentralFileHeader($v_header_list[$v_nb_extracted])) != 1)4758      {4759        // ----- Close the zip file4760        $this->privCloseFd();4761 4762        return $v_result;4763      }4764 4765 4766      // ----- Store the index4767      $v_header_list[$v_nb_extracted]['index'] = $i;4768 4769      // ----- Look for the specific extract rules4770      $v_found = false;4771 4772      // ----- Look for extract by name rule4773      if (   (isset($p_options[PCLZIP_OPT_BY_NAME]))4774          && ($p_options[PCLZIP_OPT_BY_NAME] != 0)) {4775 4776          // ----- Look if the filename is in the list4777          for ($j=0; ($j<sizeof($p_options[PCLZIP_OPT_BY_NAME])) && (!$v_found); $j++) {4778 4779              // ----- Look for a directory4780              if (substr($p_options[PCLZIP_OPT_BY_NAME][$j], -1) == "/") {4781 4782                  // ----- Look if the directory is in the filename path4783                  if (   (strlen($v_header_list[$v_nb_extracted]['stored_filename']) > strlen($p_options[PCLZIP_OPT_BY_NAME][$j]))4784                      && (substr($v_header_list[$v_nb_extracted]['stored_filename'], 0, strlen($p_options[PCLZIP_OPT_BY_NAME][$j])) == $p_options[PCLZIP_OPT_BY_NAME][$j])) {4785                      $v_found = true;4786                  }4787                  elseif (   (($v_header_list[$v_nb_extracted]['external']&0x00000010)==0x00000010) /* Indicates a folder */4788                          && ($v_header_list[$v_nb_extracted]['stored_filename'].'/' == $p_options[PCLZIP_OPT_BY_NAME][$j])) {4789                      $v_found = true;

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.