ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
ZipStream\Option\Archive Class Reference
+ Collaboration diagram for ZipStream\Option\Archive:

Public Member Functions

 __construct ()
 Options constructor. More...
 
 getComment ()
 
 setComment (string $comment)
 
 getLargeFileSize ()
 
 setLargeFileSize (int $largeFileSize)
 
 getLargeFileMethod ()
 
 setLargeFileMethod (Method $largeFileMethod)
 
 isSendHttpHeaders ()
 
 setSendHttpHeaders (bool $sendHttpHeaders)
 
 getHttpHeaderCallback ()
 
 setHttpHeaderCallback (Callable $httpHeaderCallback)
 
 isEnableZip64 ()
 
 setEnableZip64 (bool $enableZip64)
 
 isZeroHeader ()
 
 setZeroHeader (bool $zeroHeader)
 
 isFlushOutput ()
 
 setFlushOutput (bool $flushOutput)
 
 isStatFiles ()
 
 setStatFiles (bool $statFiles)
 
 getContentDisposition ()
 
 setContentDisposition (string $contentDisposition)
 
 getContentType ()
 
 setContentType (string $contentType)
 
 getOutputStream ()
 
 setOutputStream ($outputStream)
 
 getDeflateLevel ()
 
 setDeflateLevel (int $deflateLevel)
 

Data Fields

const DEFAULT_DEFLATE_LEVEL = 6
 

Private Attributes

 $comment = ''
 
 $largeFileSize = 20 * 1024 * 1024
 
 $largeFileMethod
 
 $sendHttpHeaders = false
 
 $httpHeaderCallback = 'header'
 
 $enableZip64 = true
 
 $zeroHeader = false
 
 $statFiles = true
 
 $flushOutput = false
 
 $contentDisposition = 'attachment'
 
 $contentType = 'application/x-zip'
 
 $deflateLevel = 6
 
 $outputStream
 

Detailed Description

Definition at line 6 of file Archive.php.

Constructor & Destructor Documentation

◆ __construct()

ZipStream\Option\Archive::__construct ( )

Options constructor.

Definition at line 114 of file Archive.php.

References ZipStream\Option\Method\STORE.

115  {
116  $this->largeFileMethod = Method::STORE();
117  $this->outputStream = fopen('php://output', 'wb');
118  }

Member Function Documentation

◆ getComment()

ZipStream\Option\Archive::getComment ( )

Definition at line 120 of file Archive.php.

References ZipStream\Option\Archive\$comment.

120  : string
121  {
122  return $this->comment;
123  }

◆ getContentDisposition()

ZipStream\Option\Archive::getContentDisposition ( )

Definition at line 210 of file Archive.php.

References ZipStream\Option\Archive\$contentDisposition.

210  : string
211  {
213  }

◆ getContentType()

ZipStream\Option\Archive::getContentType ( )

Definition at line 220 of file Archive.php.

References ZipStream\Option\Archive\$contentType.

220  : string
221  {
222  return $this->contentType;
223  }

◆ getDeflateLevel()

ZipStream\Option\Archive::getDeflateLevel ( )
Returns
int

Definition at line 249 of file Archive.php.

References ZipStream\Option\Archive\$deflateLevel.

Referenced by ZipStream\Option\File\defaultTo().

249  : int
250  {
251  return $this->deflateLevel;
252  }
+ Here is the caller graph for this function:

◆ getHttpHeaderCallback()

ZipStream\Option\Archive::getHttpHeaderCallback ( )

Definition at line 160 of file Archive.php.

References ZipStream\Option\Archive\$httpHeaderCallback.

160  : Callable
161  {
163  }

◆ getLargeFileMethod()

ZipStream\Option\Archive::getLargeFileMethod ( )

Definition at line 140 of file Archive.php.

References ZipStream\Option\Archive\$largeFileMethod.

140  : Method
141  {
142  return $this->largeFileMethod;
143  }
$sc Method

◆ getLargeFileSize()

ZipStream\Option\Archive::getLargeFileSize ( )

Definition at line 130 of file Archive.php.

References ZipStream\Option\Archive\$largeFileSize.

130  : int
131  {
132  return $this->largeFileSize;
133  }

◆ getOutputStream()

ZipStream\Option\Archive::getOutputStream ( )
Returns
resource

Definition at line 233 of file Archive.php.

References ZipStream\Option\Archive\$outputStream.

234  {
235  return $this->outputStream;
236  }

◆ isEnableZip64()

ZipStream\Option\Archive::isEnableZip64 ( )

Definition at line 170 of file Archive.php.

References ZipStream\Option\Archive\$enableZip64.

170  : bool
171  {
172  return $this->enableZip64;
173  }

◆ isFlushOutput()

ZipStream\Option\Archive::isFlushOutput ( )

Definition at line 190 of file Archive.php.

References ZipStream\Option\Archive\$flushOutput.

190  : bool
191  {
192  return $this->flushOutput;
193  }

◆ isSendHttpHeaders()

ZipStream\Option\Archive::isSendHttpHeaders ( )

Definition at line 150 of file Archive.php.

References ZipStream\Option\Archive\$sendHttpHeaders.

150  : bool
151  {
152  return $this->sendHttpHeaders;
153  }

◆ isStatFiles()

ZipStream\Option\Archive::isStatFiles ( )

Definition at line 200 of file Archive.php.

References ZipStream\Option\Archive\$statFiles.

200  : bool
201  {
202  return $this->statFiles;
203  }

◆ isZeroHeader()

ZipStream\Option\Archive::isZeroHeader ( )

Definition at line 180 of file Archive.php.

References ZipStream\Option\Archive\$zeroHeader.

180  : bool
181  {
182  return $this->zeroHeader;
183  }

◆ setComment()

ZipStream\Option\Archive::setComment ( string  $comment)

Definition at line 125 of file Archive.php.

References ZipStream\Option\Archive\$comment, and comment().

125  : void
126  {
127  $this->comment = $comment;
128  }
comment()
Definition: comment.php:2
+ Here is the call graph for this function:

◆ setContentDisposition()

ZipStream\Option\Archive::setContentDisposition ( string  $contentDisposition)

Definition at line 215 of file Archive.php.

References ZipStream\Option\Archive\$contentDisposition.

215  : void
216  {
217  $this->contentDisposition = $contentDisposition;
218  }

◆ setContentType()

ZipStream\Option\Archive::setContentType ( string  $contentType)

Definition at line 225 of file Archive.php.

References ZipStream\Option\Archive\$contentType.

225  : void
226  {
227  $this->contentType = $contentType;
228  }

◆ setDeflateLevel()

ZipStream\Option\Archive::setDeflateLevel ( int  $deflateLevel)
Parameters
int$deflateLevel

Definition at line 257 of file Archive.php.

References ZipStream\Option\Archive\$deflateLevel.

257  : void
258  {
259  $this->deflateLevel = $deflateLevel;
260  }

◆ setEnableZip64()

ZipStream\Option\Archive::setEnableZip64 ( bool  $enableZip64)

Definition at line 175 of file Archive.php.

References ZipStream\Option\Archive\$enableZip64.

175  : void
176  {
177  $this->enableZip64 = $enableZip64;
178  }

◆ setFlushOutput()

ZipStream\Option\Archive::setFlushOutput ( bool  $flushOutput)

Definition at line 195 of file Archive.php.

References ZipStream\Option\Archive\$flushOutput.

195  : void
196  {
197  $this->flushOutput = $flushOutput;
198  }

◆ setHttpHeaderCallback()

ZipStream\Option\Archive::setHttpHeaderCallback ( Callable  $httpHeaderCallback)

Definition at line 165 of file Archive.php.

References ZipStream\Option\Archive\$httpHeaderCallback.

165  : void
166  {
167  $this->httpHeaderCallback = $httpHeaderCallback;
168  }

◆ setLargeFileMethod()

ZipStream\Option\Archive::setLargeFileMethod ( Method  $largeFileMethod)

Definition at line 145 of file Archive.php.

References ZipStream\Option\Archive\$largeFileMethod.

145  : void
146  {
147  $this->largeFileMethod = $largeFileMethod;
148  }

◆ setLargeFileSize()

ZipStream\Option\Archive::setLargeFileSize ( int  $largeFileSize)

Definition at line 135 of file Archive.php.

References ZipStream\Option\Archive\$largeFileSize.

135  : void
136  {
137  $this->largeFileSize = $largeFileSize;
138  }

◆ setOutputStream()

ZipStream\Option\Archive::setOutputStream (   $outputStream)
Parameters
resource$outputStream

Definition at line 241 of file Archive.php.

References ZipStream\Option\Archive\$outputStream.

241  : void
242  {
243  $this->outputStream = $outputStream;
244  }

◆ setSendHttpHeaders()

ZipStream\Option\Archive::setSendHttpHeaders ( bool  $sendHttpHeaders)

Definition at line 155 of file Archive.php.

References ZipStream\Option\Archive\$sendHttpHeaders.

155  : void
156  {
157  $this->sendHttpHeaders = $sendHttpHeaders;
158  }

◆ setStatFiles()

ZipStream\Option\Archive::setStatFiles ( bool  $statFiles)

Definition at line 205 of file Archive.php.

References ZipStream\Option\Archive\$statFiles.

205  : void
206  {
207  $this->statFiles = $statFiles;
208  }

◆ setZeroHeader()

ZipStream\Option\Archive::setZeroHeader ( bool  $zeroHeader)

Definition at line 185 of file Archive.php.

References ZipStream\Option\Archive\$zeroHeader.

185  : void
186  {
187  $this->zeroHeader = $zeroHeader;
188  }

Field Documentation

◆ $comment

ZipStream\Option\Archive::$comment = ''
private

◆ $contentDisposition

ZipStream\Option\Archive::$contentDisposition = 'attachment'
private

◆ $contentType

ZipStream\Option\Archive::$contentType = 'application/x-zip'
private

◆ $deflateLevel

ZipStream\Option\Archive::$deflateLevel = 6
private

◆ $enableZip64

ZipStream\Option\Archive::$enableZip64 = true
private

◆ $flushOutput

ZipStream\Option\Archive::$flushOutput = false
private

◆ $httpHeaderCallback

ZipStream\Option\Archive::$httpHeaderCallback = 'header'
private

◆ $largeFileMethod

ZipStream\Option\Archive::$largeFileMethod
private

◆ $largeFileSize

ZipStream\Option\Archive::$largeFileSize = 20 * 1024 * 1024
private

◆ $outputStream

ZipStream\Option\Archive::$outputStream
private

◆ $sendHttpHeaders

ZipStream\Option\Archive::$sendHttpHeaders = false
private

◆ $statFiles

ZipStream\Option\Archive::$statFiles = true
private

◆ $zeroHeader

ZipStream\Option\Archive::$zeroHeader = false
private

◆ DEFAULT_DEFLATE_LEVEL

const ZipStream\Option\Archive::DEFAULT_DEFLATE_LEVEL = 6

Definition at line 8 of file Archive.php.

Referenced by ZipStream\Option\File\getDeflateLevel().


The documentation for this class was generated from the following file: