McNetic · rivimey · Jul 14, 2016 · Jul 14, 2016 · Jul 14, 2016 · Jul 14, 2016
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,6 @@
+.idea/atlassian-ide-plugin.xml
+.idea/workspace.xml
+.idea/vcs.xml
+.idea/tasks.xml
+.idea/inspectionProfiles/Project_Default.xml
+/vendor
diff --git a/.idea/PHPZipStreamer.iml b/.idea/PHPZipStreamer.iml
diff --git a/.idea/composerJson.xml b/.idea/composerJson.xml
diff --git a/.idea/copyright/profiles_settings.xml b/.idea/copyright/profiles_settings.xml
diff --git a/.idea/encodings.xml b/.idea/encodings.xml
diff --git a/.idea/inspectionProfiles/profiles_settings.xml b/.idea/inspectionProfiles/profiles_settings.xml
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/.idea/modules.xml b/.idea/modules.xml
diff --git a/.idea/php.xml b/.idea/php.xml
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
diff --git a/.travis.yml b/.travis.yml
@@ -17,10 +17,10 @@ before_install:
   - sh -c "mkdir -p ${TRAVIS_BUILD_DIR}/travis/module-cache/`php-config --vernum`"
 
 before_script:
- - ./test/travis/php-modules-install.sh
+ - ./tests/travis/php-modules-install.sh
 
 script:
- - phpunit --configuration test/phpunit.xml
+ - phpunit --configuration phpunit.xml
 
 cache:
   directories:

diff --git a/MANUAL.md b/MANUAL.md
@@ -39,6 +39,39 @@ $zip->finalize();
 
 ```
 
+Add a single file (here, html text) in immediate mode:
+```php
+require("src/ZipStreamer.php");
+
+# initialize ZipStreamer object (ZipStreamer has it's own namespace)
+$zip = new ZipStreamer\ZipStreamer();
+
+$data = "<html><head><title>Hello World</title></head><body><h1>Hello World</h1></body></html>";
+$zip->addFileFromString($data, 'test1.htm');
+
+# finalize zip file. Nothing can be added any more. 
+$zip->finalize();
+
+```
+
+Add a single file (here, html text) using the chunk interface, to enable
+in-flight file streaming:
+```php
+require("src/ZipStreamer.php");
+
+# initialize ZipStreamer object (ZipStreamer has it's own namespace)
+$zip = new ZipStreamer\ZipStreamer();
+
+$zip->addFileOpen('test1.htm');
+$data = "<html><head><title>Hello World</title></head><body><h1>Hello World</h1></body></html>";
+$zip->addFileWrite($data);
+$zip->addFileClose();
+
+# finalize zip file. Nothing can be added any more. 
+$zip->finalize();
+
+```
+
 Characteristics
 ---------------
 
@@ -64,6 +97,10 @@ deflate (the zip standard) compression can be enabled and/or disabled globally
 and per file. Without pecl_http extension, it is still possible to enable
 deflate compression, but with compression level 0, so there is no actual 
 compression.
+Note: The pecl_http extension is also available in some OS repos as 'php-http'.
+* addFileFromString sets the data length and CRC in the file header while
+addFileFromStream and addFileOpen/addFileWrite/addFileClose both create a
+blank file header and fill in the length afterwards, as allowed by the zip spec.
 
 API Documentation
 -----------------
@@ -125,6 +162,68 @@ Add a file to the archive at the specified location and file name.
 ######Returns
 bool Success
 
+```
+addFileFromString(string $data, string $filePath, array $options) : bool
+```
+
+Add a file to the archive at the specified location and file name.
+
+######Parameters
+* string *$data* The file contents to store.
+* string *$filePath* Filepath and name to be used in the archive.
+* array *options* (optional) additional options. Valid options are:
+    * int *$timestamp* Timestamp for the file (default: current time)
+    * string *$comment* comment to be added for this file (default: none)
+    * int *compress*: compression method (override global option for this
+    file)
+    * int *level*: compression level (override global option for this file)
+
+######Returns
+bool Success
+
+```
+addFileOpen(string $filePath, array $options) : bool
+```
+
+Start the process of adding a file chunk by chunk.
+
+This call must be followed by 0 or more calls to addFileWrite(), and then one 
+call to addFileClose(). There is no support for multiple simultaneously active
+files.
+
+######Parameters
+* string *$filePath* Filepath and name to be used in the archive.
+* array *options* (optional) additional options. Valid options are:
+    * int *$timestamp* Timestamp for the file (default: current time)
+    * string *$comment* comment to be added for this file (default: none)
+    * int *compress*: compression method (override global option for this
+    file)
+    * int *level*: compression level (override global option for this file)
+
+######Returns
+bool Success
+
+```
+addFileWrite(string $data) : bool
+```
+
+Append more data to a file being written by addFileOpen().
+
+######Parameters
+* string *$data* The file contents to store.
+
+######Returns
+bool Success
+
+```
+addFileClose() : bool
+```
+
+Close a file being written by addFileOpen() and append relevant metadata.
+
+######Returns
+bool Success
+
 ```
 addEmptyDir(string $directoryPath, array $options) : bool
 ```
@@ -150,4 +249,3 @@ A closed archive can no longer have new files added to it. After closing, the zi
 
 ######Returns
 bool Success
-
diff --git a/composer.json b/composer.json
@@ -1,5 +1,5 @@
 {
-  "name": "mcnetic/zipstreamer",
+  "name": "rivimey/zipstreamer",
   "type": "library",
   "description": "Stream zip files without i/o overhead",
   "keywords": ["zip", "stream"],
@@ -17,19 +17,29 @@
       "name": "Lukas Reschke",
       "email": "[email protected]",
       "role": "Contributor"
+    },{
+      "name": "Ruth Ivimey-Cook",
+      "email": "[email protected]",
+      "role": "Contributor"
     }
   ],
   "repositories": [ {
       "type": "vcs",
-      "url": "https://github.com/McNetic/PHPZipStreamer"
+      "url": "https://github.com/rivimey/PHPZipStreamer.git"
     }
-  ],                                                
+  ],
   "require": {
-    "php": ">=5.3.0"
+    "php": ">=5.3.0",
+    "ext-mbstring": "*",
+    "ext-http": "~2.0"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "^4.8.30",
+    "ext-xdebug": "*"
   },
   "autoload": {
     "psr-4": {
-      "ZipStreamer\\": "src/"
+      "Rivimey\\ZipStreamer\\": "src/"
     }
   }
 }