function PclZip::create in Quiz 6.5

Same name and namespace in other branches

1. 6.6 includes/moodle/lib/pclzip/pclzip.lib.php \PclZip::create()

File

includes/moodle/lib/pclzip/pclzip.lib.php, line 244

Class

PclZip

Code

function create($p_filelist) {

  //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, 'PclZip::create', "filelist='$p_filelist', ...");
  $v_result = 1;

  // ----- Reset the error handler
  $this
    ->privErrorReset();

  // ----- Set default values
  $v_options = array();
  $v_options[PCLZIP_OPT_NO_COMPRESSION] = FALSE;

  // ----- Look for variable options arguments
  $v_size = func_num_args();

  //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "$v_size arguments passed to the method");

  // ----- Look for arguments
  if ($v_size > 1) {

    // ----- Get the arguments
    $v_arg_list = func_get_args();

    // ----- Remove from the options list the first argument
    array_shift($v_arg_list);
    $v_size--;

    // ----- Look for first arg
    if (is_integer($v_arg_list[0]) && $v_arg_list[0] > 77000) {

      //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Variable list of options detected");

      // ----- Parse the options
      $v_result = $this
        ->privParseOptions($v_arg_list, $v_size, $v_options, array(
        PCLZIP_OPT_REMOVE_PATH => 'optional',
        PCLZIP_OPT_REMOVE_ALL_PATH => 'optional',
        PCLZIP_OPT_ADD_PATH => 'optional',
        PCLZIP_CB_PRE_ADD => 'optional',
        PCLZIP_CB_POST_ADD => 'optional',
        PCLZIP_OPT_NO_COMPRESSION => 'optional',
        PCLZIP_OPT_COMMENT => 'optional',
      ));
      if ($v_result != 1) {

        //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0);
        return 0;
      }
    }
    else {

      //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Static synopsis");

      // ----- Get the first argument
      $v_options[PCLZIP_OPT_ADD_PATH] = $v_arg_list[0];

      // ----- Look for the optional second argument
      if ($v_size == 2) {
        $v_options[PCLZIP_OPT_REMOVE_PATH] = $v_arg_list[1];
      }
      else {
        if ($v_size > 2) {
          PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid number / type of arguments");

          //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
          return 0;
        }
      }
    }
  }

  // ----- Init
  $v_string_list = array();
  $v_att_list = array();
  $v_filedescr_list = array();
  $p_result_list = array();

  // ----- Look if the $p_filelist is really an array
  if (is_array($p_filelist)) {

    // ----- Look if the first element is also an array
    //       This will mean that this is a file description entry
    if (isset($p_filelist[0]) && is_array($p_filelist[0])) {
      $v_att_list = $p_filelist;
    }
    else {
      $v_string_list = $p_filelist;
    }
  }
  else {
    if (is_string($p_filelist)) {

      // ----- Create a list from the string
      $v_string_list = explode(PCLZIP_SEPARATOR, $p_filelist);
    }
    else {
      PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid variable type p_filelist");

      //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0);
      return 0;
    }
  }

  // ----- Reformat the string list
  if (sizeof($v_string_list) != 0) {
    foreach ($v_string_list as $v_string) {
      if ($v_string != '') {
        $v_att_list[][PCLZIP_ATT_FILE_NAME] = $v_string;
      }
      else {

        //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Ignore an empty filename");
      }
    }
  }

  // ----- For each file in the list check the attributes
  $v_supported_attributes = array(
    PCLZIP_ATT_FILE_NAME => 'mandatory',
    PCLZIP_ATT_FILE_NEW_SHORT_NAME => 'optional',
    PCLZIP_ATT_FILE_NEW_FULL_NAME => 'optional',
  );
  foreach ($v_att_list as $v_entry) {
    $v_result = $this
      ->privFileDescrParseAtt($v_entry, $v_filedescr_list[], $v_options, $v_supported_attributes);
    if ($v_result != 1) {

      //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0);
      return 0;
    }
  }

  // ----- Expand the filelist (expand directories)
  $v_result = $this
    ->privFileDescrExpand($v_filedescr_list, $v_options);
  if ($v_result != 1) {

    //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0);
    return 0;
  }

  // ----- Call the create fct
  $v_result = $this
    ->privCreate($v_filedescr_list, $p_result_list, $v_options);
  if ($v_result != 1) {

    //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0);
    return 0;
  }

  // ----- Return

  //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $p_result_list);
  return $p_result_list;
}