Create Under_Score_File_Names in PHP

This simple php class generates under_score_file_names from a given string and with a given extension. In addition, it filters the name for allowed characters, replaces characters (e.g. ö -> oe) and removes unwanted characters (like -,_,...) from the end. It also converts the files extension to lowercase.

Requirements:

PHP Version > 5.4 (Feel free to replace the short array syntax to make it compatible with lowerearlier versions of PHP)

Usage:

This class is very simple to use:

require 'helpers/UnderScoreName.php'; // or autoload
$underscorename = new UnderScoreName('This is a very Long me$ssed up)( Name','jPg');
echo $underscorename;  // Output: This_is_a_very_Long_messed_up_Name.jpg

$underscorename->setExtension('png');
echo $underscorename;  // Output: This_is_a_very_Long_messed_up_Name.png

Extend:

Feel free to use this class as blueprint for your own, custom classes. For example: Generate a special filename with multiple parameters:

Class UniqueName extends UnderScoreName{
  // lots of code
}

$obj = new UniqueName(now(), 'Author Name','This is my Filename','jpg');
echo $obj  // Output might be: 2014_So_Author_Name_This_is_my_Filename.jpg

There are many more ways to extend the functionality. Some examples are implemented in the custom-directory with examples in the examples-directory.

API:

$obj = new UnderScoreName('API');

$obj->render($filename = null, $extension = null);

// Add-Functions
$obj->addReplace($search, $replace);
$obj->addAllow($char);
$obj->addForbidAtEnd($char);

// Setter-Functions
$obj->setFilename($filename);
$obj->setExtension($extension);

// Getter-Functions
$obj->getFilename();
$obj->getReplace($search = null);  // returns complete array if no parameter given
$obj->getAllow($search = null); // returns complete array if no parameter given
$obj->getForbidAtEnd($search = null); // returns complete array if no parameter given
$obj->getExtension();

Laravel 4 Installation

To include this Class into laravel simply add the helpers/-Folder to the app/-Directory and add the following line to the composer.json-File.

	"autoload": {
		"classmap": [
			"app/commands",
			"app/controllers",
			"app/models",
			"app/database/migrations",
			"app/database/seeds",
			"app/tests/TestCase.php",
			
			// Add this line:
			"app/helpers"
		]
	},

You might need to run php artisan dump-autoload to regenerate the autoloader.