PclZip::add( $p_filelist )

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_filelist

Performance profile

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

30–110

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

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

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

Uses · 7

• PclZip::privErrorReset()
• PclZip::privParseOptions()
• PclZip::privErrorLog()
• PclZip::privOptionDefaultThreshold()
• PclZip::privFileDescrParseAtt()
• PclZip::privFileDescrExpand()
• PclZip::privAdd()

Source code

View on Trac ↗View on GitHub ↗

458  function add($p_filelist)459  {460    $v_result=1;461 462    // ----- Reset the error handler463    $this->privErrorReset();464 465    // ----- Set default values466    $v_options = array();467    $v_options[PCLZIP_OPT_NO_COMPRESSION] = FALSE;468 469    // ----- Look for variable options arguments470    $v_size = func_num_args();471 472    // ----- Look for arguments473    if ($v_size > 1) {474      // ----- Get the arguments475      $v_arg_list = func_get_args();476 477      // ----- Remove form the options list the first argument478      array_shift($v_arg_list);479      $v_size--;480 481      // ----- Look for first arg482      if ((is_int($v_arg_list[0])) && ($v_arg_list[0] > 77000)) {483 484        // ----- Parse the options485        $v_result = $this->privParseOptions($v_arg_list, $v_size, $v_options,486                                            array (PCLZIP_OPT_REMOVE_PATH => 'optional',487                                                   PCLZIP_OPT_REMOVE_ALL_PATH => 'optional',488                                                   PCLZIP_OPT_ADD_PATH => 'optional',489                                                   PCLZIP_CB_PRE_ADD => 'optional',490                                                   PCLZIP_CB_POST_ADD => 'optional',491                                                   PCLZIP_OPT_NO_COMPRESSION => 'optional',492                                                   PCLZIP_OPT_COMMENT => 'optional',493                                                   PCLZIP_OPT_ADD_COMMENT => 'optional',494                                                   PCLZIP_OPT_PREPEND_COMMENT => 'optional',495                                                   PCLZIP_OPT_TEMP_FILE_THRESHOLD => 'optional',496                                                   PCLZIP_OPT_TEMP_FILE_ON => 'optional',497                                                   PCLZIP_OPT_TEMP_FILE_OFF => 'optional'498                                                   //, PCLZIP_OPT_CRYPT => 'optional'499												   ));500        if ($v_result != 1) {501          return 0;502        }503      }504 505      // ----- Look for 2 args506      // Here we need to support the first historic synopsis of the507      // method.508      else {509 510        // ----- Get the first argument511        $v_options[PCLZIP_OPT_ADD_PATH] = $v_add_path = $v_arg_list[0];512 513        // ----- Look for the optional second argument514        if ($v_size == 2) {515          $v_options[PCLZIP_OPT_REMOVE_PATH] = $v_arg_list[1];516        }517        else if ($v_size > 2) {518          // ----- Error log519          PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid number / type of arguments");520 521          // ----- Return522          return 0;523        }524      }525    }526 527    // ----- Look for default option values528    $this->privOptionDefaultThreshold($v_options);529 530    // ----- Init531    $v_string_list = array();532    $v_att_list = array();533    $v_filedescr_list = array();534    $p_result_list = array();535 536    // ----- Look if the $p_filelist is really an array537    if (is_array($p_filelist)) {

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.