Class BatchFileRenameOptionsRenameRules

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

  # Example values function myCustomCallback($fileinfo, $renameinfo){ return $renameinfo->name; }

  # Default value

NULL

Used to capitalize the first character of the file name.

• Example values true will change ex. filename.jpg => Filename.jpg
• Default value

false

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

• Example values txt will change ex. filename.jpg => filename.jpg.txt
• Default value

NULL

Used to set a fixed filename pattern for all renamed files.

• Note This option must be used in combination with fileNameVariables in order not to get the same filename for all files.
• Default value

NULL

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

• Example values array('_test_', 4) will change ex. filename.jpg => file_test_name.jpg array('_', -4) will change ex. filenametest.jpg => filename_test.jpg
• Default value

NULL

Case-insensitive version of the previous option "replace".

• Example values array('test', 'example') will change ex. testfilename_Test.jpeg => examplefilename_example.jpeg
• Default value

NULL

See Also:

http://www.php.net/manual/en/function.str_ireplace.php

Used to make the file extension lowercase.

• Example values true will change ex. filename.JPEG => filename.jpeg
• Default value

false

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

# Example values txt changes the extension of the renamed files to 'txt' array('html' => 'txt', 'png' => 'jpeg') changes the extension of the html files to 'txt' and png files to 'jpeg'

# Default value NULL

Used to add a prefix to the file name.

• Example values test_ will change ex. filename.jpg => test_filename.jpg
• Default value

NULL

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

• Note 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)
• Example values array('/filename(\d+)/i', 'myfile_${1}') will change ex. filename15.jpeg => myfile_15.jpeg
• Default value

NULL

See Also:

http://www.php.net/manual/en/function.preg_replace.php

Used to remove specific characters from the file name.

• Example values array('a') will change ex. filename.jpg => filenme.jpg array('a', 'f') will change ex. filename.jpg => ilenme.jpg array('a', 'f', 'm') will change ex. filename.jpg => ilene.jpg
• Default value

NULL

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

• Example values 3 will change ex. filename.jpg => ename.jpg 5 will change ex. filename.jpg => ame.jpg
• Default value

0

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

• Example values 3 will change ex. filename.jpg => filen.jpg 5 will change ex. filename.jpg => fil.jpg
• Default value

0

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

• Example values array(0, 2) will change ex. filename.jpg => lename.jpg array(1, 3) will change ex. filename.jpg => fname.jpg
• Default value

NULL

Used to remove specific words from the file name.

• Example values array('test') will change ex. filename test.jpg => filename.jpg array('of') will change ex. name of the file.jpg => name the file.jpg array('of', 'file') will change ex. name of the file.jpg => name the.jpg
• Default value

NULL

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

• Note 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)
• Example values array('name', 'title') will change ex. filename.jpeg => filetitle.jpeg array('Test', 'Example') will change ex. Testfilename_test.jpeg => Examplefilename_test.jpeg
• Default value

NULL

See Also:

http://www.php.net/manual/en/function.str_replace.php

Used to add a suffix to the file name.

• Example values _test will change ex. filename.jpg => filename_test.jpg
• Default value

NULL

Used to convert the file name to camelCase.

• Example values true will change ex. the file_name.jpeg => theFileName.jpeg
• Default value

false

Used to make the file name to lowercase.

• Example values true will change ex. FILeNAmE.jPeG => filename.jpeg
• Default value

false

Used to make the file name to uppercase.

• Example values true will change ex. filename.jpeg => FILENAME.JPEG
• Default value

false

Used to make the file extension uppercase.

• Example values true will change ex. filename.jpeg => filename.JPEG
• Default value

false

Validates the 'fixedFileName' option.

Throws:

InvalidArgumentException - if the supplied paramater is not a valid string

Validates the 'newExtension' option.

Throws:

InvalidArgumentException - if the supplied paramater is not a valid string or array

Validates the 'extraExtension' option.

Throws:

InvalidArgumentException - if the supplied paramater is not a valid string

Validates the 'uppercaseExtension' option.

Throws:

InvalidArgumentException - if the supplied paramater is not a valid boolean value

Validates the 'lowercaseExtension' option.

Throws:

InvalidArgumentException - if the supplied paramater is not a valid boolean value

Validates the 'removeChars' option.

Throws:

InvalidArgumentException - if the supplied paramater is not a valid array

Validates the 'removeWords' option.

Throws:

InvalidArgumentException - if the supplied paramater is not a valid array

Validates the 'removeFromLeft' option.

Throws:

InvalidArgumentException - if the supplied paramater is not a number

Validates the 'removeFromRight' option.

Throws:

InvalidArgumentException - if the supplied paramater is not a number

Validates the 'removeLength' option.

Throws:

InvalidArgumentException - if the supplied paramater is not a valid array of two numeric values

Validates the 'prefix' option.

Throws:

InvalidArgumentException - if the supplied paramater is not a valid string

Validates the 'suffix' option.

Throws:

InvalidArgumentException - if the supplied paramater is not a valid string

Validates the 'insert' option.

Throws:

InvalidArgumentException - if the supplied paramater is not a valid array of two values, the first value is a string and the second is a number

Validates the 'replace', 'ireplace' and 'regex' options.

Throws:

InvalidArgumentException - if the supplied paramater is not a valid array of two array or string values

Validates the 'replace' option.

Throws:

InvalidArgumentException

Validates the 'ireplace' option.

Throws:

InvalidArgumentException

Validates the 'regex' option.

Throws:

InvalidArgumentException

Validates the 'toUppercase' option.

Throws:

InvalidArgumentException - if the supplied paramater is not a valid boolean value

Validates the 'toLowercase' option.

Throws:

InvalidArgumentException - if the supplied paramater is not a valid boolean value

Validates the 'toCamelCase' option.

Throws:

InvalidArgumentException - if the supplied paramater is not a valid boolean value

Validates the 'capitalizeFirst' option.

Throws:

InvalidArgumentException - if the supplied paramater is not a valid boolean value