Changeset 47123

Timestamp:

01/29/2020 12:54:21 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Fix typos in wp-admin/includes/class-pclzip.php.

With the upstream library not updated in 10 years since the last time it was merged, it should be safe to treat it as "adopted" rather than external, and make these fixes.

Props passoniate, ottok.
Fixes #49163. See #38464.

File:

• trunk/src/wp-admin/includes/class-pclzip.php (modified) (25 diffs)

trunk/src/wp-admin/includes/class-pclzip.php

@@ -35 +35 @@
   // (which is not a very smart choice, specifically for windows paths !).
   // A better separator should be a comma (,). This constant gives you the
-  // abilty to change that.
+  // ability to change that.
   // However notice that changing this value, may have impact on existing
   // scripts, using space separated filenames.
-  // Recommanded values for compatibility with older versions :
+  // Recommended values for compatibility with older versions :
   //define( 'PCLZIP_SEPARATOR', ' ' );
-  // Recommanded values for smart separation of filenames.
+  // Recommended values for smart separation of filenames.
   if (!defined('PCLZIP_SEPARATOR')) {
     define( 'PCLZIP_SEPARATOR', ',' );
@@ -69 +69 @@
   // ----- Optional threshold ratio for use of temporary files
   //       Pclzip sense the size of the file to add/extract and decide to
-  //       use or not temporary file. The algorythm is looking for
+  //       use or not temporary file. The algorithm is looking for
   //       memory_limit of PHP and apply a ratio.
   //       threshold = memory_limit * ratio.
@@ -249 +249 @@
   //   in the archive.
   //   In this synopsis, the function takes an optional variable list of
-  //   options. See bellow the supported options.
+  //   options. See below the supported options.
   // Parameters :
   //   $p_filelist : An array containing file or directory names, or
@@ -683 +683 @@
   //   file is not extracted.
   //
-  //   If both PCLZIP_OPT_PATH and PCLZIP_OPT_ADD_PATH aoptions
+  //   If both PCLZIP_OPT_PATH and PCLZIP_OPT_ADD_PATH options
   //   are used, the path indicated in PCLZIP_OPT_ADD_PATH is append
   //   at the end of the path value of PCLZIP_OPT_PATH.
@@ -1065 +1065 @@
   // Description :
   //   ***** Deprecated *****
-  //   delete(PCLZIP_OPT_BY_INDEX, $p_index) should be prefered.
+  //   delete(PCLZIP_OPT_BY_INDEX, $p_index) should be preferred.
   // --------------------------------------------------------------------------------
   function deleteByIndex($p_index)
@@ -1127 +1127 @@
       }
 
-      // ----- Read the central directory informations
+      // ----- Read the central directory information
       $v_central_dir = array();
       if (($v_result = $this->privReadEndCentralDir($v_central_dir)) != 1)
@@ -1392 +1392 @@
     }
 
-    // ----- Check that the file is readeable
+    // ----- Check that the file is readable
     if (!is_readable($this->zipname)) {
       // ----- Error log
@@ -1699 +1699 @@
                   $v_sort_flag=true;
 
-                  // ----- TBC : An automatic sort should be writen ...
+                  // ----- TBC : An automatic sort should be written ...
                   // ----- Error log
                   PclZip::privErrorLog(PCLZIP_ERR_INVALID_OPTION_VALUE, "Invalid order of index range for option '".PclZipUtilOptionText($p_options_list[$i])."'");
@@ -2190 +2190 @@
     }
 
-    // ----- Read the central directory informations
+    // ----- Read the central directory information
     $v_central_dir = array();
     if (($v_result = $this->privReadEndCentralDir($v_central_dir)) != 1)
@@ -2202 +2202 @@
     @rewind($this->zip_fd);
 
-    // ----- Creates a temporay file
+    // ----- Creates a temporary file
     $v_zip_temp_name = PCLZIP_TEMPORARY_DIR.uniqid('pclzip-').'.tmp';
 
@@ -2392 +2392 @@
   // Description :
   //   $p_add_dir and $p_remove_dir will give the ability to memorize a path which is
-  //   different from the real path of the file. This is usefull if you want to have PclTar
+  //   different from the real path of the file. This is useful if you want to have PclTar
   //   running in any directory, and memorize relative path from an other directory.
   // Parameters :
@@ -2632 +2632 @@
       }
 
-      // ----- Update the informations
+      // ----- Update the information
       // Only some fields can be modified
       if ($p_header['stored_filename'] != $v_local_header['stored_filename']) {
@@ -2784 +2784 @@
       }
 
-      // ----- Update the informations
+      // ----- Update the information
       // Nothing can be modified
     }
@@ -2947 +2947 @@
 
       // ----- Look for short name change
-      // Its when we cahnge just the filename but not the path
+      // Its when we change just the filename but not the path
       if (isset($p_filedescr['new_short_name'])) {
         $v_path_info = pathinfo($p_filename);
@@ -3170 +3170 @@
     }
 
-    // ----- Read the central directory informations
+    // ----- Read the central directory information
     $v_central_dir = array();
     if (($v_result = $this->privReadEndCentralDir($v_central_dir)) != 1)
@@ -3221 +3221 @@
   // Function : privConvertHeader2FileInfo()
   // Description :
-  //   This function takes the file informations from the central directory
+  //   This function takes the file information from the central directory
   //   entries and extract the interesting parameters that will be given back.
   //   The resulting file infos are set in the array $p_info
@@ -3314 +3314 @@
     }
 
-    // ----- Read the central directory informations
+    // ----- Read the central directory information
     $v_central_dir = array();
     if (($v_result = $this->privReadEndCentralDir($v_central_dir)) != 1)
@@ -3714 +3714 @@
       }
 
-      // ----- Update the informations
+      // ----- Update the information
       // Only some fields can be modified
       $p_entry['filename'] = $v_local_header['filename'];
@@ -4081 +4081 @@
       }
 
-      // ----- Update the informations
+      // ----- Update the information
       // Only some fields can be modified
       $p_entry['filename'] = $v_local_header['filename'];
@@ -4194 +4194 @@
       }
 
-      // ----- Update the informations
+      // ----- Update the information
       // Only some fields can be modified
       $p_entry['filename'] = $v_local_header['filename'];
@@ -4690 +4690 @@
     }
 
-    // ----- Read the central directory informations
+    // ----- Read the central directory information
     $v_central_dir = array();
     if (($v_result = $this->privReadEndCentralDir($v_central_dir)) != 1)
@@ -4825 +4825 @@
     if ($v_nb_extracted > 0) {
 
-        // ----- Creates a temporay file
+        // ----- Creates a temporary file
         $v_zip_temp_name = PCLZIP_TEMPORARY_DIR.uniqid('pclzip-').'.tmp';
 
@@ -5076 +5076 @@
     }
 
-    // ----- Read the central directory informations
+    // ----- Read the central directory information
     $v_central_dir = array();
     if (($v_result = $this->privReadEndCentralDir($v_central_dir)) != 1)
@@ -5096 +5096 @@
     }
 
-    // ----- Read the central directory informations
+    // ----- Read the central directory information
     $v_central_dir_to_add = array();
     if (($v_result = $p_archive_to_add->privReadEndCentralDir($v_central_dir_to_add)) != 1)
@@ -5109 +5109 @@
     @rewind($p_archive_to_add->zip_fd);
 
-    // ----- Creates a temporay file
+    // ----- Creates a temporary file
     $v_zip_temp_name = PCLZIP_TEMPORARY_DIR.uniqid('pclzip-').'.tmp';