importImages.inc File Reference

Support functions for the importImages.php script. More...

Go to the source code of this file.

Functions
	findAuxFile ( $file, $auxExtension, $maxStrip=1)
	Find an auxilliary file with the given extension, matching the give base file path.
	findFiles ( $dir, $exts, $recurse=false)
	Search a directory for files with one of a set of extensions.
	getFileCommentFromSourceWiki ( $wiki_host, $file)
	getFileUserFromSourceWiki ( $wiki_host, $file)
	splitFilename ( $filename)
	Split a filename into filename and extension.

Detailed Description

Support functions for the importImages.php script.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html

Author

Rob Church robch.nosp@m.ur@g.nosp@m.mail..nosp@m.com

Mij mij@b.nosp@m.itch.nosp@m.x.it

Definition in file importImages.inc.

Function Documentation

findAuxFile()

findAuxFile	(		$file,
			$auxExtension,
			$maxStrip = 1
	)

Find an auxilliary file with the given extension, matching the give base file path.

$maxStrip determines how many extensions may be stripped from the original file name before appending the new extension. For example, with $maxStrip = 1 (the default), file files acme.foo.bar.txt and acme.foo.txt would be auxilliary files for acme.foo.bar and the extension ".txt". With $maxStrip = 2, acme.txt would also be acceptable.

Parameters

string	$file	Base path
string	$auxExtension	The extension to be appended to the base path
int	$maxStrip	The maximum number of extensions to strip from the base path (default: 1)

Returns

string|bool

Definition at line 88 of file importImages.inc.

findFiles()

findFiles	(		$dir,
			$exts,
			$recurse = false
	)

Search a directory for files with one of a set of extensions.

Parameters

string	$dir	Path to directory to search
array	$exts	Array of extensions to search for
bool	$recurse	Search subdirectories recursively

Returns

array|bool Array of filenames on success, or false on failure

Definition at line 34 of file importImages.inc.

References $dir, $ext, $files, findFiles(), list, and splitFilename().

Referenced by findFiles().

getFileCommentFromSourceWiki()

getFileCommentFromSourceWiki	(		$wiki_host,
			$file
	)

Definition at line 117 of file importImages.inc.

References $matches.

getFileUserFromSourceWiki()

getFileUserFromSourceWiki	(		$wiki_host,
			$file
	)

Definition at line 128 of file importImages.inc.

References $matches.

splitFilename()

splitFilename

(

$filename

)

Split a filename into filename and extension.

Parameters

string

$filename

Filename

Returns

array

Definition at line 65 of file importImages.inc.

References $ext, and $fname.

Referenced by findFiles().