lib/ezfile/classes/ezfilehandler.php
Show:
inherited
inherited
Classes
\eZFileHandler
Package:
Parameters
Returns
- Children
- \eZCompressionHandler
Properties
$FileName= ''
Details
- Type
- n/a
$IsBinary= ''
Details
- Type
- n/a
$IsOpen= ''
Details
- Type
- n/a
$Mode= ''
Details
- Type
- n/a
$Name= ''
Details
- Type
- n/a
Methods
close(
)
:
voidcopy(
$sourceFilename, $destinationFilename
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $sourceFilename | ||
| $destinationFilename |
doClose(
)
:
voiddoEOF(
)
:
voiddoExists(
$filename
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $filename |
doFlush(
)
:
voiddoIsDirectory(
$filename
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $filename |
doIsExecutable(
$filename
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $filename |
doIsFile(
$filename
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $filename |
doIsLink(
$filename
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $filename |
doIsReadable(
$filename
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $filename |
doIsWriteable(
$filename
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $filename |
doOpen(
$filename, $mode
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $filename | ||
| $mode |
doPasstrough(
$closeFile
=
true
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $closeFile |
doRead(
$length
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $length |
doRename(
$destinationFilename, $sourceFilename
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $destinationFilename | ||
| $sourceFilename |
doRewind(
)
:
voiddoSeek(
$offset, $whence
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $offset | ||
| $whence |
doStatistics(
$filename
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $filename |
doTell(
)
:
voiddoUnlink(
$filename
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $filename |
doWrite(
$data, $length
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $data | ||
| $length |
duplicate(
)
:
voideZFileHandler(
$handlerIdentifier
=
false, $handlerName
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $handlerIdentifier | ||
| $handlerName |
eof(
)
:
voiderror(
)
:
voiderrorNumber(
)
:
voiderrorString(
)
:
voidexists(
$filename
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $filename |
filename(
)
:
voidflush(
)
:
voididentifier(
)
:
voidinstance(
\$identifier $identifier, \$filename $filename
=
false, \$mode $mode
=
false, \$binaryFile $binaryFile
=
true
)
:
\eZFileHandler | false
static
Returns a shared instance of the eZFileHandler class.
$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 |
isAvailable(
)
:
void
static
isBinaryMode(
)
:
voidisDirectory(
$filename
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $filename |
isExecutable(
$filename
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $filename |
isFile(
$filename
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $filename |
isLink(
$filename
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $filename |
isOpen(
)
:
voidisReadable(
$filename
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $filename |
isWriteable(
$filename
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $filename |
link(
$sourceFilename, $destinationFilename
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $sourceFilename | ||
| $destinationFilename |
linkCopy(
$sourceFilename, $destinationFilename, $symbolicLink
=
true
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $sourceFilename | ||
| $destinationFilename | ||
| $symbolicLink |
mode(
)
:
voidmove(
$sourceFilename, $destinationFilename
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $sourceFilename | ||
| $destinationFilename |
name(
)
:
voidopen(
$filename, $mode, $binaryFile
=
true
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $filename | ||
| $mode | ||
| $binaryFile |
passtrough(
$closeFile
=
true
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $closeFile |
read(
$length
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $length |
rename(
$destinationFilename, $sourceFilename
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $destinationFilename | ||
| $sourceFilename |
rewind(
)
:
voidseek(
$offset, $whence
=
SEEK_SET
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $offset | ||
| $whence |
statistics(
$filename
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $filename |
symlink(
$sourceFilename, $destinationFilename
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $sourceFilename | ||
| $destinationFilename |
tell(
)
:
voidunlink(
$filename
=
false
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $filename |
write(
$data, $length
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $data | ||
| $length |