GZFile
extends AbstractFile
in package
Class to manipulate GZ files
Table of Contents
Properties
Methods
- __construct() : mixed
- __destruct() : mixed
- close() : bool
- copyTo() : static|null
- create() : void
- ensureClosed() : void
- ensureOpen() : void
- exists() : bool
- fromSameType() : static
- getContents() : string|false
- getHandle() : mixed
- getMode() : string|null
- getNextLine() : string|false
- getPath() : string|null
- guessFileFormat() : string
- isCompressible() : bool
- isFormatSupported() : bool
- isOpen() : bool
- isReadable() : bool
- isWritable() : bool
- moveTo() : bool
- open() : void
- remove() : void
- resolveFile() : AbstractFile
- setPath() : AbstractFile
- write() : void
- setMode() : AbstractFile
Properties
$handle
protected
mixed
$handle
= null
$mode
protected
string|null
$mode
= null
$path
protected
string|null
$path
= null
Methods
__construct()
public
__construct([string|null $path = null ]) : mixed
Parameters
- $path : string|null = null
__destruct()
public
__destruct() : mixed
close()
public
close() : bool
Return values
boolcopyTo()
public
copyTo(AbstractFile|string $otherFile) : static|null
Parameters
- $otherFile : AbstractFile|string
Return values
static|nullcreate()
public
create() : void
ensureClosed()
public
ensureClosed() : void
ensureOpen()
public
ensureOpen([string|null $mode = null ]) : void
Parameters
- $mode : string|null = null
exists()
public
exists() : bool
Return values
boolfromSameType()
public
static fromSameType(string $path) : static
Parameters
- $path : string
Return values
staticgetContents()
public
getContents() : string|false
Return values
string|falsegetHandle()
public
getHandle() : mixed
getMode()
public
getMode() : string|null
Return values
string|nullgetNextLine()
public
getNextLine() : string|false
Return values
string|falsegetPath()
public
getPath() : string|null
Return values
string|nullguessFileFormat()
public
static guessFileFormat(string $path) : string
Parameters
- $path : string
Return values
stringisCompressible()
public
isCompressible() : bool
Return values
boolisFormatSupported()
public
isFormatSupported() : bool
Return values
boolisOpen()
public
isOpen() : bool
Return values
boolisReadable()
public
isReadable() : bool
Return values
boolisWritable()
public
isWritable() : bool
Return values
boolmoveTo()
public
moveTo(string|AbstractFile $otherFile) : bool
Parameters
- $otherFile : string|AbstractFile
Return values
boolopen()
public
open() : void
remove()
public
remove() : void
resolveFile()
public
static resolveFile(string $path[, string|null $format = null ]) : AbstractFile
Parameters
- $path : string
- $format : string|null = null
Return values
AbstractFilesetPath()
public
setPath(string $path) : AbstractFile
Parameters
- $path : string
Return values
AbstractFilewrite()
public
write(mixed $data) : void
Parameters
- $data : mixed
setMode()
protected
setMode(string|null $mode) : AbstractFile
Parameters
- $mode : string|null