Documentation

Path
in package

Path utils.

Tags
author

Kitamura Satoshi with.no.parachute@gmail.com

Table of Contents

Methods

getRealDir()  : false|string
Return real directory path.
getRealPath()  : false|string
Return real file path.
getRealWritingFilePath()  : false|string
Return real file path to write.
isRealDirExist()  : bool
Return whether the real directory exists.
isRealDirWritable()  : bool
Return whether the real directory is writable.
isRealFileExist()  : bool
Return whether the real file path exists.
isRealFileReadable()  : bool
Return whether the real file path is readable.
isRealFileWritable()  : bool
Return whether the real file path is writable.
isRealPathExist()  : bool
Return whether the real path exists.
isRelativePath()  : bool
Return whether the path is relative path.
toAbsolutePath()  : false|string
Cat file path.

Methods

getRealDir()

Return real directory path.

public getRealDir(string $path, string $rootDir) : false|string
Parameters
$path : string

path

$rootDir : string

absolute path to project root directory

Return values
false|string

real directory path string if the path string is passed and real directory exists, false otherwise

getRealPath()

Return real file path.

public getRealPath(string $path, string $rootDir) : false|string
Parameters
$path : string

file path

$rootDir : string

absolute path to project root directory

Return values
false|string

real path string if the path string is passed and real path exists, false otherwise

getRealWritingFilePath()

Return real file path to write.

public getRealWritingFilePath(string $path, string $rootDir) : false|string
Parameters
$path : string

file path

$rootDir : string

absolute path to project root directory

Return values
false|string

real file path string if the parent directory exists, false otherwise

isRealDirExist()

Return whether the real directory exists.

public isRealDirExist(bool|string $realpath) : bool
Parameters
$realpath : bool|string

real directory path

Return values
bool

true if the real directory exists, false otherwise

isRealDirWritable()

Return whether the real directory is writable.

public isRealDirWritable(bool|string $realpath) : bool
Parameters
$realpath : bool|string

real directory path

Return values
bool

true if the real directory is writable, false otherwise

isRealFileExist()

Return whether the real file path exists.

public isRealFileExist(bool|string $realpath) : bool
Parameters
$realpath : bool|string

real file path

Return values
bool

true if the real file path exists, false otherwise

isRealFileReadable()

Return whether the real file path is readable.

public isRealFileReadable(bool|string $realpath) : bool
Parameters
$realpath : bool|string

real file path

Return values
bool

true if the real file path is readable, false otherwise

isRealFileWritable()

Return whether the real file path is writable.

public isRealFileWritable(bool|string $realpath) : bool
Parameters
$realpath : bool|string

real file path

Return values
bool

true if the real file path is writable, false otherwise

isRealPathExist()

Return whether the real path exists.

public isRealPathExist(bool|string $realpath) : bool
Parameters
$realpath : bool|string

real path

Return values
bool

true if the real path exists, false otherwise

isRelativePath()

Return whether the path is relative path.

public isRelativePath(string $path) : bool
Parameters
$path : string

path

Return values
bool

true if the path is relative path, false otherwise

toAbsolutePath()

Cat file path.

public toAbsolutePath(string $path, string $rootDir) : false|string
Parameters
$path : string

file path

$rootDir : string

absolute path to project root directory

Return values
false|string

absolute path


        
On this page

Search results