BatchFileRename Libraryv1.0
B C G H I R S

B

BatchFileRename() - Class
The main BatchFileRename class.
BatchFileRenameFileNameVariables() - Class
Contains the callbacks for the core filename variables.
BatchFileRenameOptions() - Class
The base class of all BatchFileRename options classes.
BatchFileRenameOptionsBase() - Class
Controles the main BatchFileRename configuration options.
BatchFileRenameOptionsFileSet() - Class
Controles the configuration options of the fileSet according wich the files will be selected.
BatchFileRenameOptionsRenameRules() - Class
Controles the renaming rules according wich the files will be renamed.

C

count() - Method in class BatchFileRenameFileNameVariables
The callback of the <#> filename variable wich represents the file number with no leading zeros eg. 1, 3, 15.
count2() - Method in class BatchFileRenameFileNameVariables
The callback of the <##> filename variable wich represents the file number with one leading zero eg. 01, 03, 15.
count3() - Method in class BatchFileRenameFileNameVariables
The callback of the <###> filename variable wich represents the file number with two leading zeros eg. 001, 012, 025, 108, 245, 915.
count4() - Method in class BatchFileRenameFileNameVariables
The callback of the <####> filename variable wich represents the file number with three leading zeros eg. 0001, 0035, 0125, 0548, 1215, 1500.
createLogFile() - Method in class BatchFileRename
Creates a log file contains the successfully renamed files and their original names, the log file may be used later to restore the renamed files to their original names by passing the log file back to the renameFromLogFile() method.

G

getErrorsArray() - Method in class BatchFileRename
Returns an array containing the files that were not ranamed and the error message.
getOption() - Method in class BatchFileRenameOptions
Gets the value of an option.
getOptions() - Method in class BatchFileRenameOptions
Gets a list of all options defined in the class and their values.
getResultArray() - Method in class BatchFileRename
Returns an array containing the successfully renamed files.

H

hasValue() - Method in class BatchFileRenameOptions
Checks if an option has a value.

I

isError() - Method in class BatchFileRename
Checks if some files were not renamed during the renaming process as a result of such error.

R

rename() - Method in class BatchFileRename
Used to execute the renaming process.
renameFromLogFile() - Method in class BatchFileRename
Used to rename files based on a previusly created log file.

S

setFileNameVariable() - Method in class BatchFileRename
Sets a filename Variable.
setFileSetOptions() - Method in class BatchFileRename
Sets the FileSet configuration options.
setOption() - Method in class BatchFileRenameOptions
Updates a single option value.
setOptions() - Method in class BatchFileRenameOptions
Updates options.
setOptions() - Method in class BatchFileRename
Sets the main configuration options.
setRenameRules() - Method in class BatchFileRename
Sets the RenameRules configuration options.