lib/ezfile/classes/ezgzipzlibcompressionhandler.php

Show: inherited
Table of Contents

File containing the eZGZIPZLIBCompressionHandler class.

Copyright
Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.  
License
eZ Business Use License Agreement Version 2.0  
Package
lib  
Version
4.6.0  

\eZGZIPZLIBCompressionHandler

Package: lib

File containing the eZGZIPZLIBCompressionHandler class.

Parent(s)
\eZCompressionHandler < \eZFileHandler
Copyright
Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.  
License
eZ Business Use License Agreement Version 2.0  
Version
4.6.0  

Properties

Propertypublic  $File= ''
Details
Type
n/a
Propertypublic  $FileName= ''
Details
Type
n/a
Inherited_from
\eZFileHandler::$$FileName  
Inherited_from
\eZCompressionHandler::$$FileName  
Propertypublic  $IsBinary= ''
Details
Type
n/a
Inherited_from
\eZFileHandler::$$IsBinary  
Inherited_from
\eZCompressionHandler::$$IsBinary  
Propertypublic  $IsOpen= ''
Details
Type
n/a
Inherited_from
\eZFileHandler::$$IsOpen  
Inherited_from
\eZCompressionHandler::$$IsOpen  
Propertypublic  $Level= ''
Details
Type
n/a
Propertypublic  $Mode= ''
Details
Type
n/a
Inherited_from
\eZFileHandler::$$Mode  
Inherited_from
\eZCompressionHandler::$$Mode  
Propertypublic  $Name= ''
Details
Type
n/a
Inherited_from
\eZFileHandler::$$Name  
Inherited_from
\eZCompressionHandler::$$Name  

Methods

methodpublicclose( ) : void
methodpubliccompress(  $source ) : void

Parameters
Name Type Description
$source
methodpubliccompressionLevel( ) : void

methodpubliccopy(  $sourceFilename,  $destinationFilename ) : void
staticinherited

Inherited from: \eZFileHandler::copy()\eZCompressionHandler::copy()
Parameters
Name Type Description
$sourceFilename
$destinationFilename
methodpublicdecompress(  $source ) : void

Parameters
Name Type Description
$source
methodpublicdoClose( ) : void

methodpublicdoEOF( ) : void

methodpublicdoExists(  $filename ) : void
Parameters
Name Type Description
$filename
methodpublicdoFlush( ) : void

methodpublicdoIsDirectory(  $filename ) : void
Parameters
Name Type Description
$filename
methodpublicdoIsExecutable(  $filename ) : void
Parameters
Name Type Description
$filename
methodpublicdoIsFile(  $filename ) : void
Parameters
Name Type Description
$filename
methodpublicdoIsLink(  $filename ) : void
Parameters
Name Type Description
$filename
methodpublicdoIsReadable(  $filename ) : void
Parameters
Name Type Description
$filename
methodpublicdoIsWriteable(  $filename ) : void
Parameters
Name Type Description
$filename
methodpublicdoOpen(  $filename,  $mode ) : void

Parameters
Name Type Description
$filename
$mode
methodpublicdoPasstrough(  $closeFile = true ) : void

Parameters
Name Type Description
$closeFile
methodpublicdoRead(  $uncompressedLength = false ) : void

Parameters
Name Type Description
$uncompressedLength
methodpublicdoRename(  $destinationFilename,  $sourceFilename ) : void
Parameters
Name Type Description
$destinationFilename
$sourceFilename
methodpublicdoRewind( ) : void

methodpublicdoSeek(  $offset,  $whence ) : void

Parameters
Name Type Description
$offset
$whence
methodpublicdoStatistics(  $filename ) : void
Parameters
Name Type Description
$filename
methodpublicdoTell( ) : void

methodpublicdoUnlink(  $filename ) : void
Parameters
Name Type Description
$filename
methodpublicdoWrite(  $data,  $uncompressedLength = false ) : void

Parameters
Name Type Description
$data
$uncompressedLength
methodpublicduplicate( ) : void
methodpubliceZCompressionHandler(  $handlerIdentifier,  $handlerName ) : void
Parameters
Name Type Description
$handlerIdentifier
$handlerName
methodpubliceZFileHandler(  $handlerIdentifier = false,  $handlerName = false ) : void
Parameters
Name Type Description
$handlerIdentifier
$handlerName
methodpubliceZGZIPZLIBCompressionHandler( ) : void

methodpubliceof( ) : void
methodpublicerror( ) : void
methodpublicerrorNumber( ) : void

methodpublicerrorString( ) : void

methodpublicexists(  $filename = false ) : void
Parameters
Name Type Description
$filename
methodpublicfilename( ) : void
methodpublicflush( ) : void
methodpublicidentifier( ) : void
methodpublicinstance( string | false $identifier, string | false $filename = false, string | false $mode = false, bool $binaryFile = true ) : \eZFileHandler | false
staticinherited

Returns a shared instance of the eZFileHandler class.

Inherited from: \eZFileHandler::instance()\eZCompressionHandler::instance()

$identifier if set is used to specify specific file handlers as defined in file.ini [FileSettings]Handlers. If $filename and later params are set, then file is opened straigt away.

Parameters
Name Type Description
$identifier string | false

Global eZFileHandler used if false

$filename string | false
$mode string | false

set to 'r' if false

$binaryFile bool

Binary or text mode, default true.

Returns
Type Description
\eZFileHandler | false
methodpublicisAvailable( ) : void
static

methodpublicisBinaryMode( ) : void
methodpublicisDirectory(  $filename = false ) : void
Parameters
Name Type Description
$filename
methodpublicisExecutable(  $filename = false ) : void
Parameters
Name Type Description
$filename
methodpublicisFile(  $filename = false ) : void
Parameters
Name Type Description
$filename
methodpublicisLink(  $filename = false ) : void
Parameters
Name Type Description
$filename
methodpublicisOpen( ) : void
methodpublicisReadable(  $filename = false ) : void
Parameters
Name Type Description
$filename
methodpublicisWriteable(  $filename = false ) : void
Parameters
Name Type Description
$filename
methodpubliclink(  $sourceFilename,  $destinationFilename ) : void
staticinherited

Inherited from: \eZFileHandler::link()\eZCompressionHandler::link()
Parameters
Name Type Description
$sourceFilename
$destinationFilename
methodpubliclinkCopy(  $sourceFilename,  $destinationFilename,  $symbolicLink = true ) : void
Parameters
Name Type Description
$sourceFilename
$destinationFilename
$symbolicLink
methodpublicmode( ) : void
methodpublicmove(  $sourceFilename,  $destinationFilename ) : void
staticinherited

Inherited from: \eZFileHandler::move()\eZCompressionHandler::move()
Parameters
Name Type Description
$sourceFilename
$destinationFilename
methodpublicname( ) : void
methodpublicopen(  $filename,  $mode,  $binaryFile = true ) : void
Parameters
Name Type Description
$filename
$mode
$binaryFile
methodpublicpasstrough(  $closeFile = true ) : void
Parameters
Name Type Description
$closeFile
methodpublicread(  $length = false ) : void
Parameters
Name Type Description
$length
methodpublicrename(  $destinationFilename,  $sourceFilename = false ) : void
Parameters
Name Type Description
$destinationFilename
$sourceFilename
methodpublicrewind( ) : void
methodpublicseek(  $offset,  $whence = SEEK_SET ) : void
Parameters
Name Type Description
$offset
$whence
methodpublicsetCompressionLevel(  $level ) : void

Parameters
Name Type Description
$level
methodpublicstatistics(  $filename = false ) : void
Parameters
Name Type Description
$filename
methodpublicsymlink(  $sourceFilename,  $destinationFilename ) : void
Parameters
Name Type Description
$sourceFilename
$destinationFilename
methodpublictell( ) : void
methodpublicunlink(  $filename = false ) : void
Parameters
Name Type Description
$filename
methodpublicwrite(  $data,  $length = false ) : void
Parameters
Name Type Description
$data
$length
Documentation was generated by DocBlox 0.18.1.