lib/ezfile/classes/ezgzipcompressionhandler.php

Show:

inherited

Classes
- \eZGZIPCompressionHandler

Table of Contents

File containing the eZGZIPCompressionHandler 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

\eZGZIPCompressionHandler
jump to top

Package: lib

File containing the eZGZIPCompressionHandler class.

Parent(s): \eZForwardCompressionHandler < \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


                 $FileName= ''

inheritedInherited from: \eZFileHandler::$$FileName \eZCompressionHandler::$$FileName \eZForwardCompressionHandler::$$FileName

Details

Type: n/a
Inherited_from: \eZFileHandler::$$FileName
Inherited_from: \eZCompressionHandler::$$FileName
Inherited_from: \eZForwardCompressionHandler::$$FileName


                 $IsBinary= ''

inheritedInherited from: \eZFileHandler::$$IsBinary \eZCompressionHandler::$$IsBinary \eZForwardCompressionHandler::$$IsBinary

Details

Type: n/a
Inherited_from: \eZFileHandler::$$IsBinary
Inherited_from: \eZCompressionHandler::$$IsBinary
Inherited_from: \eZForwardCompressionHandler::$$IsBinary


                 $IsOpen= ''

inheritedInherited from: \eZFileHandler::$$IsOpen \eZCompressionHandler::$$IsOpen \eZForwardCompressionHandler::$$IsOpen

Details

Type: n/a
Inherited_from: \eZFileHandler::$$IsOpen
Inherited_from: \eZCompressionHandler::$$IsOpen
Inherited_from: \eZForwardCompressionHandler::$$IsOpen


                 $Mode= ''

inheritedInherited from: \eZFileHandler::$$Mode \eZCompressionHandler::$$Mode \eZForwardCompressionHandler::$$Mode

Details

Type: n/a
Inherited_from: \eZFileHandler::$$Mode
Inherited_from: \eZCompressionHandler::$$Mode
Inherited_from: \eZForwardCompressionHandler::$$Mode


                 $Name= ''

inheritedInherited from: \eZFileHandler::$$Name \eZCompressionHandler::$$Name \eZForwardCompressionHandler::$$Name

Details

Type: n/a
Inherited_from: \eZFileHandler::$$Name
Inherited_from: \eZCompressionHandler::$$Name
Inherited_from: \eZForwardCompressionHandler::$$Name

Methods

inherited

Inherited from: \eZFileHandler::close()\eZCompressionHandler::close()\eZForwardCompressionHandler::close()

compress(
           $source
          )
        
        :
          void

inherited

Inherited from: \eZForwardCompressionHandler::compress()

Parameters

Name	Type	Description
$source

compressionLevel(
          
          )
        
        :
          void

copy(
           $sourceFilename,  $destinationFilename
          )
        
        :
          void

staticinherited

Inherited from: \eZFileHandler::copy()\eZCompressionHandler::copy()\eZForwardCompressionHandler::copy()

Parameters

Name	Type	Description
$sourceFilename
$destinationFilename

decompress(
           $source
          )
        
        :
          void

inherited

Inherited from: \eZForwardCompressionHandler::decompress()

Parameters

Name	Type	Description
$source

doClose(
          
          )
        
        :
          void

inherited

Inherited from: \eZForwardCompressionHandler::doClose()

inherited

Inherited from: \eZForwardCompressionHandler::doEOF()

doExists(
           $filename
          )
        
        :
          void

staticinherited

Inherited from: \eZFileHandler::doExists()\eZCompressionHandler::doExists()\eZForwardCompressionHandler::doExists()

Parameters

Name	Type	Description
$filename

doFlush(
          
          )
        
        :
          void

inherited

Inherited from: \eZForwardCompressionHandler::doFlush()

doIsDirectory(
           $filename
          )
        
        :
          void

staticinherited

Inherited from: \eZFileHandler::doIsDirectory()\eZCompressionHandler::doIsDirectory()\eZForwardCompressionHandler::doIsDirectory()

Parameters

Name	Type	Description
$filename

doIsExecutable(
           $filename
          )
        
        :
          void

staticinherited

Inherited from: \eZFileHandler::doIsExecutable()\eZCompressionHandler::doIsExecutable()\eZForwardCompressionHandler::doIsExecutable()

Parameters

Name	Type	Description
$filename

doIsFile(
           $filename
          )
        
        :
          void

staticinherited

Inherited from: \eZFileHandler::doIsFile()\eZCompressionHandler::doIsFile()\eZForwardCompressionHandler::doIsFile()

Parameters

Name	Type	Description
$filename

doIsLink(
           $filename
          )
        
        :
          void

staticinherited

Inherited from: \eZFileHandler::doIsLink()\eZCompressionHandler::doIsLink()\eZForwardCompressionHandler::doIsLink()

Parameters

Name	Type	Description
$filename

doIsReadable(
           $filename
          )
        
        :
          void

staticinherited

Inherited from: \eZFileHandler::doIsReadable()\eZCompressionHandler::doIsReadable()\eZForwardCompressionHandler::doIsReadable()

Parameters

Name	Type	Description
$filename

doIsWriteable(
           $filename
          )
        
        :
          void

staticinherited

Inherited from: \eZFileHandler::doIsWriteable()\eZCompressionHandler::doIsWriteable()\eZForwardCompressionHandler::doIsWriteable()

Parameters

Name	Type	Description
$filename

doOpen(
           $filename,  $mode
          )
        
        :
          void

inherited

Inherited from: \eZForwardCompressionHandler::doOpen()

Parameters

Name	Type	Description
$filename
$mode

doPasstrough(
           $closeFile
              =
              true
          )
        
        :
          void

inherited

Inherited from: \eZForwardCompressionHandler::doPasstrough()

Parameters

Name	Type	Description
$closeFile

doRead(
           $uncompressedLength
              =
              false
          )
        
        :
          void

inherited

Inherited from: \eZForwardCompressionHandler::doRead()

Parameters

Name	Type	Description
$uncompressedLength

doRename(
           $destinationFilename,  $sourceFilename
          )
        
        :
          void

staticinherited

Inherited from: \eZFileHandler::doRename()\eZCompressionHandler::doRename()\eZForwardCompressionHandler::doRename()

Parameters

Name	Type	Description
$destinationFilename
$sourceFilename

doRewind(
          
          )
        
        :
          void

inherited

Inherited from: \eZForwardCompressionHandler::doRewind()

doSeek(
           $offset,  $whence
          )
        
        :
          void

inherited

Inherited from: \eZForwardCompressionHandler::doSeek()

Parameters

Name	Type	Description
$offset
$whence

doStatistics(
           $filename
          )
        
        :
          void

staticinherited

Inherited from: \eZFileHandler::doStatistics()\eZCompressionHandler::doStatistics()\eZForwardCompressionHandler::doStatistics()

Parameters

Name	Type	Description
$filename

doTell(
          
          )
        
        :
          void

inherited

Inherited from: \eZForwardCompressionHandler::doTell()

doUnlink(
           $filename
          )
        
        :
          void

staticinherited

Inherited from: \eZFileHandler::doUnlink()\eZCompressionHandler::doUnlink()\eZForwardCompressionHandler::doUnlink()

Parameters

Name	Type	Description
$filename

doWrite(
           $data,  $uncompressedLength
              =
              false
          )
        
        :
          void

inherited

Inherited from: \eZForwardCompressionHandler::doWrite()

Parameters

Name	Type	Description
$data
$uncompressedLength

duplicate(
          
          )
        
        :
          void

inherited

Inherited from: \eZForwardCompressionHandler::duplicate()

eZCompressionHandler(
           $handlerIdentifier,  $handlerName
          )
        
        :
          void

inherited

Inherited from: \eZCompressionHandler::eZCompressionHandler()\eZForwardCompressionHandler::eZCompressionHandler()

Parameters

Name	Type	Description
$handlerIdentifier
$handlerName

eZFileHandler(
           $handlerIdentifier
              =
              false,  $handlerName
              =
              false
          )
        
        :
          void

inherited

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

Parameters

Name	Type	Description
$handlerIdentifier
$handlerName

eZForwardCompressionHandler(
           $handler,  $name,  $identifier
          )
        
        :
          void

inherited

Inherited from: \eZForwardCompressionHandler::eZForwardCompressionHandler()

Parameters

Name	Type	Description
$handler
$name
$identifier

eZGZIPCompressionHandler(
          
          )
        
        :
          void

inherited

Inherited from: \eZFileHandler::eof()\eZCompressionHandler::eof()\eZForwardCompressionHandler::eof()

inherited

Inherited from: \eZForwardCompressionHandler::error()

errorNumber(
          
          )
        
        :
          void

inherited

Inherited from: \eZForwardCompressionHandler::errorNumber()

errorString(
          
          )
        
        :
          void

inherited

Inherited from: \eZForwardCompressionHandler::errorString()

exists(
           $filename
              =
              false
          )
        
        :
          void

inherited

Inherited from: \eZFileHandler::exists()\eZCompressionHandler::exists()\eZForwardCompressionHandler::exists()

Parameters

Name	Type	Description
$filename

filename(
          
          )
        
        :
          void

inherited

Inherited from: \eZFileHandler::filename()\eZCompressionHandler::filename()\eZForwardCompressionHandler::filename()

inherited

Inherited from: \eZFileHandler::flush()\eZCompressionHandler::flush()\eZForwardCompressionHandler::flush()

forwardHandler(
          
          )
        
        :
          void

inherited

Inherited from: \eZForwardCompressionHandler::forwardHandler()

identifier(
          
          )
        
        :
          void

inherited

Inherited from: \eZFileHandler::identifier()\eZCompressionHandler::identifier()\eZForwardCompressionHandler::identifier()

instance(
          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()\eZForwardCompressionHandler::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

isAvailable(
          
          )
        
        :
          void

staticinherited

Inherited from: \eZFileHandler::isAvailable()\eZCompressionHandler::isAvailable()\eZForwardCompressionHandler::isAvailable()

isBinaryMode(
          
          )
        
        :
          void

inherited

Inherited from: \eZFileHandler::isBinaryMode()\eZCompressionHandler::isBinaryMode()\eZForwardCompressionHandler::isBinaryMode()

isDirectory(
           $filename
              =
              false
          )
        
        :
          void

inherited

Inherited from: \eZFileHandler::isDirectory()\eZCompressionHandler::isDirectory()\eZForwardCompressionHandler::isDirectory()

Parameters

Name	Type	Description
$filename

isExecutable(
           $filename
              =
              false
          )
        
        :
          void

inherited

Inherited from: \eZFileHandler::isExecutable()\eZCompressionHandler::isExecutable()\eZForwardCompressionHandler::isExecutable()

Parameters

Name	Type	Description
$filename

isFile(
           $filename
              =
              false
          )
        
        :
          void

inherited

Inherited from: \eZFileHandler::isFile()\eZCompressionHandler::isFile()\eZForwardCompressionHandler::isFile()

Parameters

Name	Type	Description
$filename

isLink(
           $filename
              =
              false
          )
        
        :
          void

inherited

Inherited from: \eZFileHandler::isLink()\eZCompressionHandler::isLink()\eZForwardCompressionHandler::isLink()

Parameters

Name	Type	Description
$filename

isOpen(
          
          )
        
        :
          void

inherited

Inherited from: \eZFileHandler::isOpen()\eZCompressionHandler::isOpen()\eZForwardCompressionHandler::isOpen()

isReadable(
           $filename
              =
              false
          )
        
        :
          void

inherited

Inherited from: \eZFileHandler::isReadable()\eZCompressionHandler::isReadable()\eZForwardCompressionHandler::isReadable()

Parameters

Name	Type	Description
$filename

isWriteable(
           $filename
              =
              false
          )
        
        :
          void

inherited

Inherited from: \eZFileHandler::isWriteable()\eZCompressionHandler::isWriteable()\eZForwardCompressionHandler::isWriteable()

Parameters

Name	Type	Description
$filename

link(
           $sourceFilename,  $destinationFilename
          )
        
        :
          void

staticinherited

Inherited from: \eZFileHandler::link()\eZCompressionHandler::link()\eZForwardCompressionHandler::link()

Parameters

Name	Type	Description
$sourceFilename
$destinationFilename

linkCopy(
           $sourceFilename,  $destinationFilename,  $symbolicLink
              =
              true
          )
        
        :
          void

staticinherited

Inherited from: \eZFileHandler::linkCopy()\eZCompressionHandler::linkCopy()\eZForwardCompressionHandler::linkCopy()

Parameters

Name	Type	Description
$sourceFilename
$destinationFilename
$symbolicLink

inherited

Inherited from: \eZFileHandler::mode()\eZCompressionHandler::mode()\eZForwardCompressionHandler::mode()

move(
           $sourceFilename,  $destinationFilename
          )
        
        :
          void

staticinherited

Inherited from: \eZFileHandler::move()\eZCompressionHandler::move()\eZForwardCompressionHandler::move()

Parameters

Name	Type	Description
$sourceFilename
$destinationFilename

inherited

Inherited from: \eZFileHandler::name()\eZCompressionHandler::name()\eZForwardCompressionHandler::name()

open(
           $filename,  $mode,  $binaryFile
              =
              true
          )
        
        :
          void

inherited

Inherited from: \eZFileHandler::open()\eZCompressionHandler::open()\eZForwardCompressionHandler::open()

Parameters

Name	Type	Description
$filename
$mode
$binaryFile

passtrough(
           $closeFile
              =
              true
          )
        
        :
          void

inherited

Inherited from: \eZFileHandler::passtrough()\eZCompressionHandler::passtrough()\eZForwardCompressionHandler::passtrough()

Parameters

Name	Type	Description
$closeFile

read(
           $length
              =
              false
          )
        
        :
          void

inherited

Inherited from: \eZFileHandler::read()\eZCompressionHandler::read()\eZForwardCompressionHandler::read()

Parameters

Name	Type	Description
$length

rename(
           $destinationFilename,  $sourceFilename
              =
              false
          )
        
        :
          void

inherited

Inherited from: \eZFileHandler::rename()\eZCompressionHandler::rename()\eZForwardCompressionHandler::rename()

Parameters

Name	Type	Description
$destinationFilename
$sourceFilename

rewind(
          
          )
        
        :
          void

inherited

Inherited from: \eZFileHandler::rewind()\eZCompressionHandler::rewind()\eZForwardCompressionHandler::rewind()

seek(
           $offset,  $whence
              =
              SEEK_SET
          )
        
        :
          void

inherited

Inherited from: \eZFileHandler::seek()\eZCompressionHandler::seek()\eZForwardCompressionHandler::seek()

Parameters

Name	Type	Description
$offset
$whence

setCompressionLevel(
           $level
          )
        
        :
          void

Parameters

Name	Type	Description
$level

statistics(
           $filename
              =
              false
          )
        
        :
          void

inherited

Inherited from: \eZFileHandler::statistics()\eZCompressionHandler::statistics()\eZForwardCompressionHandler::statistics()

Parameters

Name	Type	Description
$filename

symlink(
           $sourceFilename,  $destinationFilename
          )
        
        :
          void

staticinherited

Inherited from: \eZFileHandler::symlink()\eZCompressionHandler::symlink()\eZForwardCompressionHandler::symlink()

Parameters

Name	Type	Description
$sourceFilename
$destinationFilename

inherited

Inherited from: \eZFileHandler::tell()\eZCompressionHandler::tell()\eZForwardCompressionHandler::tell()

unlink(
           $filename
              =
              false
          )
        
        :
          void

staticinherited

Inherited from: \eZFileHandler::unlink()\eZCompressionHandler::unlink()\eZForwardCompressionHandler::unlink()

Parameters

Name	Type	Description
$filename

write(
           $data,  $length
              =
              false
          )
        
        :
          void

inherited

Inherited from: \eZFileHandler::write()\eZCompressionHandler::write()\eZForwardCompressionHandler::write()

Parameters

Name	Type	Description
$data
$length

lib/ezfile/classes/ezgzipcompressionhandler.php

\eZGZIPCompressionHandlerjump to top

Properties

Methods

\eZGZIPCompressionHandler
jump to top