classref: Sync with current master branch (aa8d9b8)

classes/class_zipreader.rst

@@ -12,25 +12,52 @@ ZIPReader
 
 **Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
 
-Allows reading the content of a zip file.
+Allows reading the content of a ZIP file.
 
 .. rst-class:: classref-introduction-group
 
 Description
 -----------
 
-This class implements a reader that can extract the content of individual files inside a zip archive.
+This class implements a reader that can extract the content of individual files inside a ZIP archive. See also :ref:`ZIPPacker<class_ZIPPacker>`.
 
 ::
 
+    # Read a single file from a ZIP archive.
     func read_zip_file():
-        var reader := ZIPReader.new()
-        var err := reader.open("user://archive.zip")
+        var reader = ZIPReader.new()
+        var err = reader.open("user://archive.zip")
         if err != OK:
             return PackedByteArray()
-        var res := reader.read_file("hello.txt")
+        var res = reader.read_file("hello.txt")
         reader.close()
         return res
+    
+    # Extract all files from a ZIP archive, preserving the directories within.
+    # This acts like the "Extract all" functionality from most archive managers.
+    func extract_all_from_zip():
+        var reader = ZIPReader.new()
+        reader.open("res://archive.zip")
+    
+        # Destination directory for the extracted files (this folder must exist before extraction).
+        # Not all ZIP archives put everything in a single root folder,
+        # which means several files/folders may be created in `root_dir` after extraction.
+        var root_dir = DirAccess.open("user://")
+    
+        var files = reader.get_files()
+        for file_path in files:
+            # If the current entry is a directory.
+            if file_path.ends_with("/"):
+                root_dir.make_dir_recursive(file_path)
+                continue
+    
+            # Write file contents, creating folders automatically when needed.
+            # Not all ZIP archives are strictly ordered, so we need to do this in case
+            # the file entry comes before the folder entry.
+            root_dir.make_dir_recursive(root_dir.get_current_dir().path_join(file_path).get_base_dir())
+            var file = FileAccess.open(root_dir.get_current_dir().path_join(file_path), FileAccess.WRITE)
+            var buffer = reader.read_file(file_path)
+            file.store_buffer(buffer)
 
 .. rst-class:: classref-reftable-group