lib/ezfile/classes/ezcompressionhandler.php
\eZCompressionHandler
Package:
Parameters
Returns
- Parent(s)
- \eZFileHandler
- Children
- \eZGZIPZLIBCompressionHandler
- \eZNoCompressionHandler
- \eZBZIP2Handler
- \eZForwardCompressionHandler
- \eZGZIPShellCompressionHandler
Properties

$FileName= ''
inheritedInherited from:
\eZFileHandler::$$FileName
Details
- Type
- n/a
- Inherited_from
- \eZFileHandler::$$FileName

$IsBinary= ''
inheritedInherited from:
\eZFileHandler::$$IsBinary
Details
- Type
- n/a
- Inherited_from
- \eZFileHandler::$$IsBinary

$IsOpen= ''
inheritedInherited from:
\eZFileHandler::$$IsOpen
Details
- Type
- n/a
- Inherited_from
- \eZFileHandler::$$IsOpen

$Mode= ''
inheritedInherited from:
\eZFileHandler::$$Mode
Details
- Type
- n/a
- Inherited_from
- \eZFileHandler::$$Mode

$Name= ''
inheritedInherited from:
\eZFileHandler::$$Name
Details
- Type
- n/a
- Inherited_from
- \eZFileHandler::$$Name
Methods

copy(
$sourceFilename, $destinationFilename
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $sourceFilename | ||
| $destinationFilename |

doOpen(
$filename, $mode
)
:
void
inherited
Inherited from:
\eZFileHandler::doOpen()
Parameters
| Name | Type | Description |
|---|---|---|
| $filename | ||
| $mode |

doPasstrough(
$closeFile
=
true
)
:
void
inherited
Inherited from:
\eZFileHandler::doPasstrough()
Parameters
| Name | Type | Description |
|---|---|---|
| $closeFile |

doRead(
$length
=
false
)
:
void
inherited
Inherited from:
\eZFileHandler::doRead()
Parameters
| Name | Type | Description |
|---|---|---|
| $length |

doRename(
$destinationFilename, $sourceFilename
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $destinationFilename | ||
| $sourceFilename |

doSeek(
$offset, $whence
)
:
void
inherited
Inherited from:
\eZFileHandler::doSeek()
Parameters
| Name | Type | Description |
|---|---|---|
| $offset | ||
| $whence |

doWrite(
$data, $length
=
false
)
:
void
inherited
Inherited from:
\eZFileHandler::doWrite()
Parameters
| Name | Type | Description |
|---|---|---|
| $data | ||
| $length |

eZCompressionHandler(
$handlerIdentifier, $handlerName
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $handlerIdentifier | ||
| $handlerName |

eZFileHandler(
$handlerIdentifier
=
false, $handlerName
=
false
)
:
void
inherited
Inherited from:
\eZFileHandler::eZFileHandler()
Parameters
| Name | Type | Description |
|---|---|---|
| $handlerIdentifier | ||
| $handlerName |

exists(
$filename
=
false
)
:
void
inherited
Inherited from:
\eZFileHandler::exists()
Parameters
| Name | Type | Description |
|---|---|---|
| $filename |

instance(
\$identifier $identifier, \$filename $filename
=
false, \$mode $mode
=
false, \$binaryFile $binaryFile
=
true
)
:
\eZFileHandler | false
staticinherited
Returns a shared instance of the eZFileHandler class.
Inherited from: \eZFileHandler::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.
| Name | Type | Description |
|---|---|---|
| $identifier | \$identifier | string|false Global eZFileHandler used if false |
| $filename | \$filename | string|false |
| $mode | \$mode | string|false set to 'r' if false |
| $binaryFile | \$binaryFile | bool binary or text mode, default true. |
| Type | Description |
|---|---|
| \eZFileHandler | false |

isDirectory(
$filename
=
false
)
:
void
inherited
Inherited from:
\eZFileHandler::isDirectory()
Parameters
| Name | Type | Description |
|---|---|---|
| $filename |

isExecutable(
$filename
=
false
)
:
void
inherited
Inherited from:
\eZFileHandler::isExecutable()
Parameters
| Name | Type | Description |
|---|---|---|
| $filename |

isFile(
$filename
=
false
)
:
void
inherited
Inherited from:
\eZFileHandler::isFile()
Parameters
| Name | Type | Description |
|---|---|---|
| $filename |

isLink(
$filename
=
false
)
:
void
inherited
Inherited from:
\eZFileHandler::isLink()
Parameters
| Name | Type | Description |
|---|---|---|
| $filename |

isReadable(
$filename
=
false
)
:
void
inherited
Inherited from:
\eZFileHandler::isReadable()
Parameters
| Name | Type | Description |
|---|---|---|
| $filename |

isWriteable(
$filename
=
false
)
:
void
inherited
Inherited from:
\eZFileHandler::isWriteable()
Parameters
| Name | Type | Description |
|---|---|---|
| $filename |

link(
$sourceFilename, $destinationFilename
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $sourceFilename | ||
| $destinationFilename |

linkCopy(
$sourceFilename, $destinationFilename, $symbolicLink
=
true
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $sourceFilename | ||
| $destinationFilename | ||
| $symbolicLink |

move(
$sourceFilename, $destinationFilename
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $sourceFilename | ||
| $destinationFilename |

open(
$filename, $mode, $binaryFile
=
true
)
:
void
inherited
Inherited from:
\eZFileHandler::open()
Parameters
| Name | Type | Description |
|---|---|---|
| $filename | ||
| $mode | ||
| $binaryFile |

passtrough(
$closeFile
=
true
)
:
void
inherited
Inherited from:
\eZFileHandler::passtrough()
Parameters
| Name | Type | Description |
|---|---|---|
| $closeFile |

read(
$length
=
false
)
:
void
inherited
Inherited from:
\eZFileHandler::read()
Parameters
| Name | Type | Description |
|---|---|---|
| $length |

rename(
$destinationFilename, $sourceFilename
=
false
)
:
void
inherited
Inherited from:
\eZFileHandler::rename()
Parameters
| Name | Type | Description |
|---|---|---|
| $destinationFilename | ||
| $sourceFilename |

seek(
$offset, $whence
=
SEEK_SET
)
:
void
inherited
Inherited from:
\eZFileHandler::seek()
Parameters
| Name | Type | Description |
|---|---|---|
| $offset | ||
| $whence |

statistics(
$filename
=
false
)
:
void
inherited
Inherited from:
\eZFileHandler::statistics()
Parameters
| Name | Type | Description |
|---|---|---|
| $filename |

symlink(
$sourceFilename, $destinationFilename
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $sourceFilename | ||
| $destinationFilename |

write(
$data, $length
=
false
)
:
void
inherited
Inherited from:
\eZFileHandler::write()
Parameters
| Name | Type | Description |
|---|---|---|
| $data | ||
| $length |