\Composer\UtilFilesystem

__construct()

__construct(\Composer\Util\ProcessExecutor  $executor = null) 

Parameters

remove()

remove(  $file) 

Parameters

isDirEmpty()

isDirEmpty(string  $dir) : boolean

Checks if a directory is empty

Parameters

Returns

emptyDirectory()

emptyDirectory(  $dir,   $ensureDirectoryExists = true) 

Parameters

removeDirectory()

removeDirectory(string  $directory) : boolean

Recursively remove a directory

Uses the process component if proc_open is enabled on the PHP installation.

Parameters

Throws

\RuntimeException

Returns

removeDirectoryPhp()

removeDirectoryPhp(string  $directory) : boolean

Recursively delete directory using PHP iterators.

Uses a CHILD_FIRST RecursiveIteratorIterator to sort files before directories, creating a single non-recursive loop to delete files/directories in the correct order.

Parameters

Returns

ensureDirectoryExists()

ensureDirectoryExists(  $directory) 

Parameters

unlink()

unlink(string  $path) : boolean

Attempts to unlink a file and in case of failure retries after 350ms on windows

Parameters

Throws

\RuntimeException

Returns

rmdir()

rmdir(string  $path) : boolean

Attempts to rmdir a file and in case of failure retries after 350ms on windows

Parameters

Throws

\RuntimeException

Returns

copyThenRemove()

copyThenRemove(string  $source, string  $target) 

Copy then delete is a non-atomic version of {@link rename}.

Some systems can't rename and also don't have proc_open, which requires this solution.

Parameters

copy()

copy(  $source,   $target) : boolean

Copies a file or directory from $source to $target.

Parameters

Returns

rename()

rename(  $source,   $target) 

Parameters

findShortestPath()

findShortestPath(string  $from, string  $to, boolean  $directories = false) : string

Returns the shortest path from $from to $to

Parameters

Throws

\InvalidArgumentException

Returns

findShortestPathCode()

findShortestPathCode(string  $from, string  $to, boolean  $directories = false, boolean  $staticCode = false) : string

Returns PHP code that, when executed in $from, will return the path to $to

Parameters

Throws

\InvalidArgumentException

Returns

isAbsolutePath()

isAbsolutePath(string  $path) : boolean

Checks if the given path is absolute

Parameters

Returns

size()

size(string  $path) : integer

Returns size of a file or directory specified by path. If a directory is given, it's size will be computed recursively.

Parameters

Throws

\RuntimeException

Returns

normalizePath()

normalizePath(string  $path) : string

Normalize a path. This replaces backslashes with slashes, removes ending slash and collapses redundant separators and up-level references.

Parameters

Returns

isLocalPath()

isLocalPath(string  $path) : boolean

Return if the given path is local

Parameters

Returns

getPlatformPath()

getPlatformPath(  $path) 

Parameters

relativeSymlink()

relativeSymlink(string  $target, string  $link) : boolean

Creates a relative symlink from $link to $target

Parameters

Returns

isSymlinkedDirectory()

isSymlinkedDirectory(string  $directory) : boolean

return true if that directory is a symlink.

Parameters

Returns

junction()

junction(string  $target, string  $junction) 

Creates an NTFS junction.

Parameters

isJunction()

isJunction(string  $junction) : boolean

Returns whether the target directory is a Windows NTFS Junction.

Parameters

Returns

removeJunction()

removeJunction(string  $junction) : boolean

Removes a Windows NTFS junction.

Parameters

Returns

directorySize()

directorySize(  $directory) 

Parameters

getProcess()

getProcess() 

unlinkImplementation()

unlinkImplementation(string  $path) : boolean

delete symbolic link implementation (commonly known as "unlink()")

symbolic links on windows which link to directories need rmdir instead of unlink

Parameters

Returns

unlinkSymlinkedDirectory()

unlinkSymlinkedDirectory(string  $directory) : boolean

Parameters

Returns

resolveSymlinkedDirectorySymlink()

resolveSymlinkedDirectorySymlink(string  $pathname) : string

resolve pathname to symbolic link of a directory

Parameters

Returns

resolved path to symbolic link or original pathname (unresolved)