View source

class SplFileObject

package php

extends SplFileInfo

implements SeekableIterator<Int, Dynamic>, RecursiveIterator<Int, Dynamic>

@:native("SplFileObject")

Available on php

The SplFileObject class offers an object-oriented interface for a file.

See also:

Static variables

@:phpClassConststaticfinalread onlyDROP_NEW_LINE:Int

@:phpClassConststaticfinalread onlyREAD_AHEAD:Int

@:phpClassConststaticfinalread onlyREAD_CSV:Int

@:phpClassConststaticfinalread onlySKIP_EMPTY:Int

Constructor

@:value({ useIncludePath : false, mode : "r" })new(filename:String, mode:String = "r", useIncludePath:Bool = false, ?context:Resource)

Methods

current():EitherType<String, EitherType<NativeIndexedArray<String>, Bool>>

eof():Bool

fflush():Bool

fgetc():EitherType<String, Bool>

@:value({ escape : "\\", enclosure : "\"", separator : "," })fgetcsv(separator:String = ",", enclosure:String = "\"", escape:String = "\\"):EitherType<NativeIndexedArray<String>, Bool>

fgets():String

fgetss(?allowable_tags:String):String

flock(operation:Int, ?wouldBlock:Ref<Int>):Bool

fpassthru():Int

@:value({ escape : "\\", enclosure : "\"", separator : "," })fputcsv(fields:NativeIndexedArray<String>, separator:String = ",", enclosure:String = "\"", escape:String = "\\"):EitherType<Int, Bool>

fread(length:Int):EitherType<String, Bool>

fscanf(format:String, vars:Rest<Ref<Dynamic>>):EitherType<Int, NativeIndexedArray<Dynamic>>

fseek(offset:Int, ?whence:Int):Int

fstat():NativeArray

ftell():EitherType<Int, Bool>

ftruncate(size:Int):Bool

@:value({ length : 0 })fwrite(data:String, length:Int = 0):EitherType<Int, Bool>

getChildren():Null<RecursiveIterator<Int, Dynamic>>

getCsvControl():NativeIndexedArray<String>

getFlags():Int

getMaxLineLen():Int

hasChildren():Bool

key():Int

next():Void

rewind():Void

seek(line:Int):Void

@:value({ escape : "\\", enclosure : "\"", separator : "," })setCsvControl(separator:String = ",", enclosure:String = "\"", escape:String = "\\"):Void

setFlags(flags:Int):Void

setMaxLineLen(maxLength:Int):Void

valid():Bool

Inherited Variables

Inherited Methods

Defined by SplFileInfo

getATime():EitherType<Int, Bool>

@:value({ suffix : "" })getBasename(suffix:String = ""):String

getCTime():EitherType<Int, Bool>

getExtension():String

getFileInfo(?className:String):SplFileInfo

getFilename():String

getGroup():EitherType<Int, Bool>

getInode():EitherType<Int, Bool>

getLinkTarget():EitherType<String, Bool>

getMTime():EitherType<Int, Bool>

getOwner():EitherType<Int, Bool>

getPath():String

getPathInfo(?className:String):Null<SplFileInfo>

getPathname():String

getPerms():EitherType<Int, Bool>

getRealPath():EitherType<String, Bool>

getSize():EitherType<Int, Bool>

getType():EitherType<SplFileInfoType, Bool>

isDir():Bool

isExecutable():Bool

isFile():Bool

isLink():Bool

isReadable():Bool

isWritable():Bool

@:value({ useIncludePath : false, mode : "r" })openFile(mode:String = "r", useIncludePath:Bool = false, ?context:Resource):SplFileObject

setFileClass(?className:String):Void

setInfoClass(?className:String):Void