pathutils.php File Reference

Functions
	copyr ($source, $dest)
	Copy a file, or recursively copy a folder and its contents.
	fullPath ($path, $dirsep=DIRECTORY_SEPARATOR)
	Function expands all relative parts of supplied path string thus removing things like ../../ or .
	getCourseDirs ($rootDir, $contains, $excludeitems=null, $startswith=true)
	Function returns array with directories contained in folder (only first level) simmilar to getDirectories but returned items are naturally sorted.
	getDirectories ($rootDir, $contains, $excludeitems=null, $startswith=true)
	Function returns array with directories contained in folder (only first level)
	GetFiles ($startDir, $outfile, $rootDir='', $excludedirs=null, $excludefileext=null)
	GetFilesArray ($startDir, $rootDir='', $excludedirs=null, $excludefileext=null)
	Function to get an array with all files in a directory and subdirectories.
	getFilesOnly ($rootDir, $contains, $excludeitems=null, $startswith=true, $extension=null)
	getRawFiles ($startDir, &$fhandle, $rootDir='', $excludedirs=null, $excludefileext=null)
	Function returns files recursivly with appeneded relative path.
	getRawFiles2 ($startDir, &$arr, $rootDir='', $excludedirs=null, $excludefileext=null)
	pathDiff ($path1, $path2)
	Returns relative path from two directories with full path.
	rmdirr ($dirname)
	Delete a directory recursive with files inside.
	search_ident_by_name ($array, $name)
	Search an identifier in array.
	stripUrl ($path, $rootDir='')
	Function strips url part from css link.
	toNativePath (&$path)
	Converts direcotry separator in given path to / to validate in CC Value is passed byref hence variable itself is changed.
	toNativePath2 (&$path)
	Converts direcotry separator in given path to the one on the server platform Value is passed byref hence variable itself is changed.
	toUrlPath (&$path)
	Converts Directory separator to the / more suitable for URL.

Function Documentation

copyr()

copyr	(		$source,
			$dest )

Copy a file, or recursively copy a folder and its contents.

Author

Aidan Lister aidan.nosp@m.@php.nosp@m..net

Version

1.0.1 @externalurl http://aidanlister.com/repos/v/function.copyr.php

Parameters

string	$source	Source path
string	$dest	Destination path

Return values

bool	Returns TRUE on success, FALSE on failure

fullPath()

fullPath	(		$path,
			$dirsep = DIRECTORY_SEPARATOR )

Function expands all relative parts of supplied path string thus removing things like ../../ or .

/../.

Parameters

string	$path
string	$dirsep	Character that represents directory separator should be specified here. Default is DIRECTORY_SEPARATOR.

Return values

string

getCourseDirs()

getCourseDirs	(		$rootDir,
			$contains,
			$excludeitems = null,
			$startswith = true )

Function returns array with directories contained in folder (only first level) simmilar to getDirectories but returned items are naturally sorted.

Parameters

string	$rootDir
string	$contains
array	$excludeitems
bool	$startswith

Return values

array

getDirectories()

getDirectories	(		$rootDir,
			$contains,
			$excludeitems = null,
			$startswith = true )

Function returns array with directories contained in folder (only first level)

Parameters

string	$rootDir	directory to look into
string	$contains	which string to look for
array	$excludeitems	array of names to be excluded
bool	$startswith	should the $contains value be searched only from beginning

Return values

array

Returns array of sub-directories. In case $rootDir path is invalid it returns FALSE.

GetFilesArray()

GetFilesArray	(		$startDir,
			$rootDir = '',
			$excludedirs = null,
			$excludefileext = null )

Function to get an array with all files in a directory and subdirectories.

Parameters

string	$startDir
string	$rootDir
string	$excludedirs
string	$excludefileext

Return values

array

getRawFiles()

getRawFiles	(		$startDir,
		&	$fhandle,
			$rootDir = '',
			$excludedirs = null,
			$excludefileext = null )

Function returns files recursivly with appeneded relative path.

Parameters

string	$startDir
string	$rootDir
array	$excludedirs
array	$excludefileext

Return values

array

pathDiff()

pathDiff	(		$path1,
			$path2 )

Returns relative path from two directories with full path.

Parameters

string	$path1
string	$path2

Return values

string

rmdirr()

rmdirr

(

$dirname

)

Delete a directory recursive with files inside.

Parameters

string

$dirname

Return values

bool

search_ident_by_name()

search_ident_by_name	(		$array,
			$name )

Search an identifier in array.

Parameters

array	$array
string	$name

stripUrl()

stripUrl	(		$path,
			$rootDir = '' )

Function strips url part from css link.

Parameters

string	$path
string	$rootDir

Return values

string

toNativePath()

toNativePath

(

&

$path

)

Converts direcotry separator in given path to / to validate in CC Value is passed byref hence variable itself is changed.

Parameters

string

$path

toNativePath2()

toNativePath2

(

&

$path

)

Converts direcotry separator in given path to the one on the server platform Value is passed byref hence variable itself is changed.

Parameters

string

$path

toUrlPath()

toUrlPath

(

&

$path

)

Converts Directory separator to the / more suitable for URL.

Parameters

string

$path