Renaming Rules

Used to set a new extension for the renamed files (could be a string or an array of file extensions).

Code:

$obj->setRenameRules(array(
    ...
    "newExtension" => "txt" 
    ...
    ));

Result:

Files Before Rename	Files After Rename
source_file.php	source_file.txt
mypage.html	mypage.txt
test_file.ini	test_file.txt
resume.html	resume.txt

Code:

$obj->setRenameRules(array(
    ...
    "newExtension" => array("html" => "txt", "conf" => "ini")
    ...
    ));

Result:

Files Before Rename	Files After Rename
source_file.php	source_file.php
mypage.html	mypage.txt
configurations.conf	configurations.ini
resume.html	resume.txt

Used to append extra extension to the file name of the renamed files.

Code:

$obj->setRenameRules(array(
    ...
    "extraExtension" => "txt" 
    ...
    ));

Result:

Files Before Rename	Files After Rename
source_file.php	source_file.php.txt
mypage.html	mypage.html.txt
test_file.ini	test_file.html.ini
resume.html	resume.html.txt

Used to make the file extension uppercase.

Code:

$obj->setRenameRules(array(
    ...
    "uppercaseExtension" => true
    ...
    ));

Result:

Files Before Rename	Files After Rename
source_file.php	source_file.PHP
test_file.ini	test_file.INI
resume.html	resume.HTML

Used to make the file extension lowercase.

Code:

$obj->setRenameRules(array(
    ...
    "lowercaseExtension" => true
    ...
    ));

Result:

Files Before Rename	Files After Rename
source_file.PHP	source_file.php
test_file.INI	test_file.ini
resume.HTML	resume.html

Used to remove specific characters from the file name.

Code:

$obj->setRenameRules(array(
    ...
    "removeChars" => array("_", "&", "$")
    ...
    ));

Result:

Files Before Rename	Files After Rename
file_name.html	filename.html
track$15.mp3	track15.mp3
&test_page.html	testpage.html

Used to remove specific words from the file name.

Code:

$obj->setRenameRules(array(
    ...
    "removeWords" => array("name", "test_")
    ...
    ));

Result:

Files Before Rename	Files After Rename
filename.html	file.html
track15.mp3	track15.mp3
test_page.html	page.html

Used to remove the first N of characters from the file name.

Code:

$obj->setRenameRules(array(
    ...
    "removeFromLeft" => 5
    ...
    ));

Result:

Files Before Rename	Files After Rename
file_name.html	name.html
track15.mp3	15.mp3
test_page.html	page.html

Used to remove the last N of characters from the file name.

Code:

$obj->setRenameRules(array(
    ...
    "removeFromRight" => 2
    ...
    ));

Result:

Files Before Rename	Files After Rename
file_name_2.html	file_name.html
track15.mp3	track.mp3
page_list.html	page_li.html

Used to remove a specific part from the file name indicated by the starting position and the length that will be removed.

Code:

$obj->setRenameRules(array(
    ...
    "removeLength" => array(3, 5)
    ...
    ));

Result:

Files Before Rename	Files After Rename
idx_name(1).txt	idx(1).txt
idx_test(2).txt	idx(2).txt
idx_file(3).txt	idx(3).txt

Used to add a prefix to the file name.

Code:

$obj->setRenameRules(array(
    ...
    "prefix" => "img_"
    ...
    ));

Result:

Files Before Rename	Files After Rename
dog.jpeg	img_dog.jpeg
cat.png	img_cat.png
fox.png	img_fox.png

Used to add a suffix to the file name.

Code:

$obj->setRenameRules(array(
    ...
    "suffix" => "_img"
    ...
    ));

Result:

Files Before Rename	Files After Rename
dog.jpeg	dog_img.jpeg
cat.png	cat_img.png
fox.png	fox_img.png

Used to insert a text to the file name at specific position.

Code:

$obj->setRenameRules(array(
    ...
    "insert" => array("_own_", 2)
    ...
    ));

Result:

Files Before Rename	Files After Rename
myresume.html	my_own_resume.html
mylink.txt	my_own_link.txt
myfile.txt	my_own_file.txt

Used to replace all occurrences of the search string with the replacement string wihthin the file name.

This option takes an array of two values:

• the first value is the value being searched for (can be a string or an array)
• the second value is the replacement value (can be a string or an array)

Code:

$obj->setRenameRules(array(
    ...
    "replace" => array("name", "title")
    ...
    ));

Result:

Files Before Rename	Files After Rename
filename.txt	filetitle.txt
name_12.txt	title_12.txt
pagename.html	pagetitle.html

Used to perform a regular expression search and replace within the file name.

This option takes an array of two values:

• the first value is the pattern to search for (can be a string or an array)
• the second value is the replacement value (can be a string or an array)

Code:

$obj->setRenameRules(array(
    ...
    'regex' => array('/filename(\d+)/i', 'myfile_${1}')
    ...
    ));

Result:

Files Before Rename	Files After Rename
filename1.txt	myfile_1.txt
filename15.txt	myfile_15.txt
filenametest.html	filenametest.html

Used to make the file name to uppercase.

Code:

$obj->setRenameRules(array(
    ...
    "toUppercase" => true
    ...
    ));

Result:

Files Before Rename	Files After Rename
filename.jpeg	FILENAME.JPEG
readme.txt	README.TXT

Used to make the file name to lowercase.

Code:

$obj->setRenameRules(array(
    ...
    "toLowercase" => true
    ...
    ));

Result:

Files Before Rename	Files After Rename
FileName.JPEG	filename.jpeg
README.txt	readme.txt

Used to convert the file name to camelCase.

Code:

$obj->setRenameRules(array(
    ...
    "toCamelCase" => true
    ...
    ));

Result:

Files Before Rename	Files After Rename
the file_name.JPEG	theFileName.jpeg
image-name.txt	imageName.txt

Used to capitalize the first character of the file name.

Code:

$obj->setRenameRules(array(
    ...
    "capitalizeFirst" => true
    ...
    ));

Result:

Files Before Rename	Files After Rename
filename.txt	Filename.txt
dog.jpeg	Dog.jpeg
image.jpeg	Image.jpeg

Used to set the new file name using a user-defined callback, the callback must return a non-empty string value, otherwise the file will not be renamed. .

The callback takes only two paramaters:

• the first is an object contains the original file information.
• the second is an object contains the new file information that was set according the defined renaming rules.

Code:

/**
 * A custom callback for renaming TXT and INC files only.
 *
 * The $fileinfo paramater contains file informations:
 *  $fileinfo->path         The file path
 *  $fileinfo->name         The file name
 *  $fileinfo->basename     The file name without the extension
 *  $fileinfo->extension    The file extension
 *  $fileinfo->size         The file size
 *
 * The $renameinfo paramater contains renamed file informations:
 *  $renameinfo->name       The new file name
 *  $renameinfo->basename   The new file name without the extension
 *  $renameinfo->extension  The new file extension
 *
 * @param   object  $fileinfo   Object containing file information
 * @param   object  $renameinfo Object containing renamed file information
 * @return  mixed   If string, it will be used as the new filname, otherwise the file will not be renamed
 */
function myCustomCallback($fileinfo, $renameinfo){

    if($fileinfo->extension == "txt"){
        return $renameinfo->basename.".html";
    }

    if($fileinfo->extension == "inc"){
        return $renameinfo->basename.".php";
    }
    
    return false;
}

$obj->setRenameRules(array(
    ...
    "callback" => "myCustomCallback"
    ...
    ));

Result:

The callback function will rename only TXT files to HTML files and INC files to PHP files.

Files Before Rename	Files After Rename
notes.inc	notes.html
readme.txt	readme.html
functions.inc	functions.php
cat.jpeg	cat.jpeg
globals.inc	globals.php