lib/ezfile/classes/ezfilehandler.php

Show: inherited

• Classes
  • \eZFileHandler

Table of Contents

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  

\eZFileHandler

jump to top

Package: lib

File containing the eZFileHandler class.

Children

\eZCompressionHandler

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= ''

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( ) : void

copy(  $sourceFilename,  $destinationFilename ) : void

static

Parameters

Name	Type	Description
$sourceFilename
$destinationFilename

doClose( ) : void

doEOF( ) : void

doExists(  $filename ) : void

static

Parameters

Name	Type	Description
$filename

doFlush( ) : void

doIsDirectory(  $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( ) : void

doSeek(  $offset,  $whence ) : void

Parameters

Name	Type	Description
$offset
$whence

doStatistics(  $filename ) : void

static

Parameters

Name	Type	Description
$filename

doTell( ) : void

doUnlink(  $filename ) : void

static

Parameters

Name	Type	Description
$filename

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

Parameters

Name	Type	Description
$data
$length

duplicate( ) : void

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

Parameters

Name	Type	Description
$handlerIdentifier
$handlerName

eof( ) : void

error( ) : void

errorNumber( ) : void

errorString( ) : void

exists(  $filename = false ) : void

Parameters

Name	Type	Description
$filename

filename( ) : void

flush( ) : void

identifier( ) : void

instance( string | false $identifier, string | false $filename = false, string | false $mode = false, bool $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.

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

static

isBinaryMode( ) : void

isDirectory(  $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( ) : void

isReadable(  $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( ) : void

move(  $sourceFilename,  $destinationFilename ) : void

static

Parameters

Name	Type	Description
$sourceFilename
$destinationFilename

name( ) : void

open(  $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( ) : void

seek(  $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( ) : void

unlink(  $filename = false ) : void

static

Parameters

Name	Type	Description
$filename

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

Parameters

Name	Type	Description
$data
$length