Skip to content

Commit 815cf35

Browse files
committed
Improve Upgrade Instructions
1 parent d04cca2 commit 815cf35

File tree

1 file changed

+26
-18
lines changed

1 file changed

+26
-18
lines changed

README.md

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -69,34 +69,42 @@ $zip->finish();
6969

7070
- Minimum PHP Version: `8.1`
7171
- Only 64bit Architecture is supported.
72-
- The class `ZipStream\Option\Method` has been replaced with the enum `ZipStream\CompressionMethod`.
73-
- Most clases have been flagged as `@internal` and should not be used from the outside.
74-
If you're using internal resources to extend this library, please open an issue so that a clean
75-
interface can be added & published.
72+
- The class `ZipStream\Option\Method` has been replaced with the enum
73+
`ZipStream\CompressionMethod`.
74+
- Most clases have been flagged as `@internal` and should not be used from the
75+
outside.
76+
If you're using internal resources to extend this library, please open an
77+
issue so that a clean interface can be added & published.
7678
The externally available classes & enums are:
7779
- `ZipStream\CompressionMethod`
7880
- `ZipStream\Exception*`
7981
- `ZipStream\ZipStream`
8082

8183
### Archive Options
8284

83-
- The class `ZipStream\Option\Archive` has been replaced in favor of named arguments in the
84-
`ZipStream\ZipStream` constuctor.
85-
- The archive options `largeFileSize` & `largeFileMethod` has been removed. If you want different
86-
`compressionMethods` based on the file size, you'll have to implement this yourself.
87-
- The archive option `httpHeaderCallback` changed the type from `callable` to `Closure`.
88-
- The archive option `zeroHeader` has been replaced with the option `defaultEnableZeroHeader`
89-
and can be overridden for every file.
90-
- The archive option `statFiles` was removed since the library no longer checks filesizes this way.
91-
- The archive option `deflateLevel` has been replaced with the option `defaultDeflateLevel`
92-
and can be overridden for every file.
93-
- The first argument (`name`) of the `ZipStream\ZipStream` constuctor has been replaced with
94-
the named argument `outputName`.
85+
- The class `ZipStream\Option\Archive` has been replaced in favor of named
86+
arguments in the `ZipStream\ZipStream` constuctor.
87+
- The archive options `largeFileSize` & `largeFileMethod` has been removed. If
88+
you want different `compressionMethods` based on the file size, you'll have to
89+
implement this yourself.
90+
- The archive option `httpHeaderCallback` changed the type from `callable` to
91+
`Closure`.
92+
- The archive option `zeroHeader` has been replaced with the option
93+
`defaultEnableZeroHeader` and can be overridden for every file. Its default
94+
value changed from `false` to `true`.
95+
- The archive option `statFiles` was removed since the library no longer checks
96+
filesizes this way.
97+
- The archive option `deflateLevel` has been replaced with the option
98+
`defaultDeflateLevel` and can be overridden for every file.
99+
- The first argument (`name`) of the `ZipStream\ZipStream` constuctor has been
100+
replaced with the named argument `outputName`.
101+
- Headers are now also sent if the `outputName` is empty. If you do not want to
102+
automatically send http headers, set `sendHttpHeaders` to `false`.
95103

96104
### File Options
97105

98-
- The class `ZipStream\Option\File` has been replaced in favor of named arguments in the
99-
`ZipStream\ZipStream->addFile*` functions.
106+
- The class `ZipStream\Option\File` has been replaced in favor of named
107+
arguments in the `ZipStream\ZipStream->addFile*` functions.
100108
- The file option `method` has been renamed to `compressionMethod`.
101109
- The file option `time` has been renamed to `lastModificationDateTime`.
102110
- The file option `size` has been renamed to `maxSize`.

0 commit comments

Comments
 (0)