PclZip::create( $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::create() 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

27–106

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

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::create() 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::privCreate()

Source code

View on Trac ↗View on GitHub ↗

275  function create($p_filelist)276  {277    $v_result=1;278 279    // ----- Reset the error handler280    $this->privErrorReset();281 282    // ----- Set default values283    $v_options = array();284    $v_options[PCLZIP_OPT_NO_COMPRESSION] = FALSE;285 286    // ----- Look for variable options arguments287    $v_size = func_num_args();288 289    // ----- Look for arguments290    if ($v_size > 1) {291      // ----- Get the arguments292      $v_arg_list = func_get_args();293 294      // ----- Remove from the options list the first argument295      array_shift($v_arg_list);296      $v_size--;297 298      // ----- Look for first arg299      if ((is_int($v_arg_list[0])) && ($v_arg_list[0] > 77000)) {300 301        // ----- Parse the options302        $v_result = $this->privParseOptions($v_arg_list, $v_size, $v_options,303                                            array (PCLZIP_OPT_REMOVE_PATH => 'optional',304                                                   PCLZIP_OPT_REMOVE_ALL_PATH => 'optional',305                                                   PCLZIP_OPT_ADD_PATH => 'optional',306                                                   PCLZIP_CB_PRE_ADD => 'optional',307                                                   PCLZIP_CB_POST_ADD => 'optional',308                                                   PCLZIP_OPT_NO_COMPRESSION => 'optional',309                                                   PCLZIP_OPT_COMMENT => 'optional',310                                                   PCLZIP_OPT_TEMP_FILE_THRESHOLD => 'optional',311                                                   PCLZIP_OPT_TEMP_FILE_ON => 'optional',312                                                   PCLZIP_OPT_TEMP_FILE_OFF => 'optional'313                                                   //, PCLZIP_OPT_CRYPT => 'optional'314                                             ));315        if ($v_result != 1) {316          return 0;317        }318      }319 320      // ----- Look for 2 args321      // Here we need to support the first historic synopsis of the322      // method.323      else {324 325        // ----- Get the first argument326        $v_options[PCLZIP_OPT_ADD_PATH] = $v_arg_list[0];327 328        // ----- Look for the optional second argument329        if ($v_size == 2) {330          $v_options[PCLZIP_OPT_REMOVE_PATH] = $v_arg_list[1];331        }332        else if ($v_size > 2) {333          PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER,334		                       "Invalid number / type of arguments");335          return 0;336        }337      }338    }339 340    // ----- Look for default option values341    $this->privOptionDefaultThreshold($v_options);342 343    // ----- Init344    $v_string_list = array();345    $v_att_list = array();346    $v_filedescr_list = array();347    $p_result_list = array();348 349    // ----- Look if the $p_filelist is really an array350    if (is_array($p_filelist)) {351 352      // ----- Look if the first element is also an array353      //       This will mean that this is a file description entry354      if (isset($p_filelist[0]) && is_array($p_filelist[0])) {

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.