phkmgr
\
PHK
Build
PSF
CLI
Stream
Tools
UnitTest
Virtual
Web

\PHK\ToolsUtil

Summary

Methods
Properties
Constants
msg()
varType()
envIsWeb()
envIsWindows()
fileSuffix()
combinePath()
trailingSepar()
isAbsolutePath()
mkAbsolutePath()
loadExtension()
loadExtensions()
substr()
disableMQR()
restoreMQR()
timeString()
httpBaseURL()
http301Redirect()
http404Fail()
http403Fail()
bool2str()
readFile()
scandir()
trace()
deltaMS()
mkArray()
displaySlowPath()
slowPath()
formatError()
getMinVersion()
getOptions()
getBuildInfo()
callMethod()
runWebInfo()
atomicWrite()
pathUniqueID()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$verbose
$mqr_exists
$mqr_level
$mqr_save
$simul_inode_array
$simul_inode_index
N/A

Properties

$verbose

$verbose :

Type

$mqr_exists

$mqr_exists :

Type

$mqr_level

$mqr_level :

Type

$mqr_save

$mqr_save :

Type

$simul_inode_array

$simul_inode_array :

Computes a string uniquely identifying a given path on this host.

Mount point unicity is based on a combination of device+inode+mtime.

On systems which don't supply a valid inode number (eg Windows), we maintain a fake inode table, whose unicity is based on the path filtered through realpath(). It is not perfect because I am not sure that realpath really returns a unique 'canonical' path, but this is best solution I have found so far.

Type

$simul_inode_index

$simul_inode_index :

Type

Methods

msg()

msg(  $msg)

Parameters

$msg

varType()

varType(  $var)

Parameters

$var

envIsWeb()

envIsWeb()

envIsWindows()

envIsWindows()

fileSuffix()

fileSuffix(  $filename)

Parameters

$filename

combinePath()

combinePath(  $dir,   $rpath)

Parameters

$dir
$rpath

trailingSepar()

trailingSepar(string  $path,   $separ) : boolean

Adds or removes a trailing separator in a path

Parameters

string $path

Input
$separ

Returns

boolean —

The result path

isAbsolutePath()

isAbsolutePath(string  $path) : boolean

Determines if a given path is absolute or relative

Parameters

string $path

The path to check

Returns

boolean —

True if the path is absolute, false if relative

mkAbsolutePath()

mkAbsolutePath(string  $path, boolean  $separ = false) : string

Build an absolute path from a given (absolute or relative) path

If the input path is relative, it is combined with the current working directory.

Parameters

string $path

The path to make absolute
boolean $separ

True if the resulting path must contain a trailing separator

Returns

string —

The resulting absolute path

loadExtension()

loadExtension(  $ext)

Parameters

$ext

loadExtensions()

loadExtensions(  $ext_list)

Parameters

$ext_list

substr()

substr(  $buf,   $position,   $len = NULL)

Parameters

$buf
$position
$len

disableMQR()

disableMQR()

restoreMQR()

restoreMQR()

timeString()

timeString(  $time = null)

Parameters

$time

httpBaseURL()

httpBaseURL()

http301Redirect()

http301Redirect(  $path)

Parameters

$path

http404Fail()

http404Fail()

http403Fail()

http403Fail()

bool2str()

bool2str(  $cond)

Parameters

$cond

readFile()

readFile(  $path)

Parameters

$path

scandir()

scandir(  $path)

Parameters

$path

trace()

trace(  $msg)

Parameters

$msg

deltaMS()

deltaMS(  $start)

Parameters

$start

mkArray()

mkArray(  $data)

Parameters

$data

displaySlowPath()

displaySlowPath()

slowPath()

slowPath()

formatError()

formatError(string  $msg) : void

Sends an \Exception with a message starting with 'Format error'

Parameters

string $msg

Message to send

Throws

\Exception

getMinVersion()

getMinVersion(  $mnt,   $caching)

Parameters

$mnt
$caching

getOptions()

getOptions(  $mnt,   $caching)

Parameters

$mnt
$caching

getBuildInfo()

getBuildInfo(  $mnt,   $caching)

Parameters

$mnt
$caching

callMethod()

callMethod(  $object,   $method,   $args)

Parameters

$object
$method
$args

runWebInfo()

runWebInfo(  $phk)

Parameters

$phk

atomicWrite()

atomicWrite(  $path,   $data)

Parameters

$path
$data

pathUniqueID()

pathUniqueID(  $prefix,   $path,   $mtime)

Parameters

$prefix
$path
$mtime