View source

class Phar

package php

extends RecursiveDirectoryIterator › FilesystemIterator › DirectoryIterator › SplFileInfo

implements ArrayAccess<String, PharFileInfo>, Countable

@:native("Phar")

Available on php

The Phar class provides a high-level interface to accessing and creating PHAR archives.

See also:

Static variables

@:phpClassConststaticfinalread onlyBZ2:Int

@:phpClassConststaticfinalread onlyCOMPRESSED:Int

@:phpClassConststaticfinalread onlyGZ:Int

@:phpClassConststaticfinalread onlyMD5:Int

@:phpClassConststaticfinalread onlyNONE:Int

@:phpClassConststaticfinalread onlyOPENSSL:Int

@:phpClassConststaticfinalread onlyPHAR:Int

@:phpClassConststaticfinalread onlyPHP:Int

@:phpClassConststaticfinalread onlyPHPS:Int

@:phpClassConststaticfinalread onlySHA1:Int

@:phpClassConststaticfinalread onlySHA256:Int

@:phpClassConststaticfinalread onlySHA512:Int

@:phpClassConststaticfinalread onlyTAR:Int

@:phpClassConststaticfinalread onlyZIP:Int

Static methods

staticfinalapiVersion():String

@:value({ type : 0 })staticfinalcanCompress(type:Int = 0):Bool

staticfinalcanWrite():Bool

staticfinalcreateDefaultStub(?index:String, ?webIndex:String):String

staticfinalgetSupportedCompression():NativeIndexedArray<String>

staticfinalgetSupportedSignatures():NativeIndexedArray<String>

@:value({ executable : true })staticfinalisValidPharFilename(filename:String, executable:Bool = true):Bool

staticfinalloadPhar(filename:String, ?alias:String):Bool

@:value({ dataoffset : 0 })staticfinalmapPhar(?alias:String, dataoffset:Int = 0):Bool

staticfinalmount(pharpath:String, externalpath:String):Void

staticfinalmungServer(munglist:NativeIndexedArray<String>):Void

@:value({ retphar : true })staticfinalrunning(retphar:Bool = true):String

staticfinalunlinkArchive(archive:String):Bool

@:value({ index : "index.php" })staticfinalwebPhar(?alias:String, index:String = "index.php", ?f404:String, ?mimetypes:NativeAssocArray<String>, ?callable:String ‑> EitherType<String, Bool>):Void

Constructor

new(fname:String, ?flags:Int, ?alias:String)

Methods

addEmptyDir(dirname:String):Void

addFile(file:String, ?localname:String):Void

addFromString(localname:String, contents:String):Void

buildFromDirectory(base_dir:String, ?regex:String):NativeAssocArray<String>

buildFromIterator(iter:EitherType<NativeIterator<String, String>, NativeIterator<Int, SplFileInfo>>, ?base_directory:String):NativeAssocArray<String>

compress(compression:Int, ?extension:String):Phar

compressFiles(compression:Int):Void

convertToData(?format:Int, ?compression:Int, ?extension:String):PharData

convertToExecutable(?format:Int, ?compression:Int, ?extension:String):Phar

copy(oldfile:String, newfile:String):Bool

count():Int

decompress(?extension:String):PharData

decompressFiles():Void

delMetadata():Bool

delete(entry:String):Bool

@:value({ overwrite : false })extractTo(pathto:String, ?files:EitherType<String, NativeIndexedArray<String>>, overwrite:Bool = false):Bool

getAlias():String

getMetadata():Dynamic

getModified():Bool

getSignature():NativeAssocArray<String>

getStub():String

getVersion():String

hasMetadata():Bool

isBuffering():Bool

isCompressed():EitherType<Int, Bool>

isFileFormat(format:Int):Bool

offsetExists(offset:String):Bool

offsetGet(offset:String):PharFileInfo

offsetSet(offset:String, value:Dynamic):Void

offsetUnset(offset:String):Void

setAlias(alias:String):Bool

setDefaultStub(?index:String, ?webindex:String):Bool

setMetadata(metadata:Any):Void

setSignatureAlgorithm(sigtype:Int, ?privatekey:String):Void

@:value({ len : -1 })setStub(stub:String, len:Int = -1):Bool

startBuffering():Void

stopBuffering():Void

Inherited Variables

Inherited Methods

Defined by RecursiveDirectoryIterator

Defined by FilesystemIterator

Defined by DirectoryIterator

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>

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

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

setFileClass(?className:String):Void

setInfoClass(?className:String):Void