• Home
• Piwik
• Filesystem

PHP Class Piwik\Filesystem

Show file Open project: piwik/piwik Class Usage Examples

Public Methods

Method	Description
checkIfFileSystemIsNFS ( ) : boolean	Checks if the filesystem Piwik stores sessions in is NFS or not. This check is done in order to avoid using file based sessions on NFS system, since on such a filesystem file locking can make file based sessions incredibly slow.
clearPhpCaches ( )
copy ( string $source, string $dest, boolean $excludePhp = false ) : true	Copies a file from $source to $dest.
copyRecursive ( string $source, string $target, boolean $excludePhp = false )	Copies the contents of a directory recursively from $source to $target.
deleteAllCacheOnUpdate ( $pluginName = false )	Called on Core install, update, plugin enable/disable Will clear all cache that could be affected by the change in configuration being made
deleteFileIfExists ( string $pathToFile ) : boolean	Deletes the given file if it exists.
directoryDiff ( $source, $target ) : string[]	Computes the difference of directories. Compares $target against $source and returns a relative path to all files and directories in $target that are not present in $source.
getFileSize ( string $pathToFile, string $unit = 'B' ) : float | null	Get the size of a file in the specified unit.
getPathToPiwikRoot ( ) : string	ending WITHOUT slash
globr ( string $sDir, string $sPattern, integer $nFlags = null ) : array	Recursively find pathnames that match a pattern.
isValidFilename ( string $filename ) : boolean	Returns true if the string is a valid filename File names that start with a-Z or 0-9 and contain a-Z, 0-9, underscore(_), dash(-), and dot(.) will be accepted.
mkdir ( string $path )	Attempts to create a new directory. All errors are silenced.
realpath ( string $path ) : string	Get canonicalized absolute path See http://php.net/realpath
remove ( string $file, boolean $silenceErrors = false )	Remove a file.
sortFilesDescByPathLength ( string[] $files ) : string[]	Sort all given paths/filenames by its path length. Long path names will be listed first. This method can be useful if you have for instance a bunch of files/directories to delete. By sorting them by lengh you can make sure to delete all files within the folders before deleting the actual folder.
unlinkRecursive ( string $dir, boolean $deleteRootToo, Closure $beforeUnlink = null )	Recursively deletes a directory.
unlinkTargetFilesNotPresentInSource ( string $source, string $target )	Removes all files and directories that are present in the target directory but are not in the source directory.

Private Methods

Method	Description
createIndexFilesToPreventDirectoryListing ( $path )	in tmp/ (sub-)folder(s) we create empty index.htm|php files
getChmodForPath ( $path ) : integer
hasPHPExtension ( $file )
havePhpFilesSameContent ( $file1, $file2 )
isPathWithinTmpFolder ( $path ) : boolean
tryToCopyFileAndVerifyItWasCopied ( $source, $dest )

Method Details