public static function create_regex_validator($new_regex_validator_name, HaddockProjectOrganisation_ModuleDirectory $module_directory)
{
$classes_directory = $module_directory->get_classes_directory();
$input_validators_directory_name = $classes_directory->get_name() . DIRECTORY_SEPARATOR . 'input-validation';
#echo '$input_validators_directory_name: ' . $input_validators_directory_name . PHP_EOL;
FileSystem_DirectoryHelper::mkdir_parents($input_validators_directory_name);
$input_validator_class_name = $module_directory->get_camel_case_root() . '_' . $new_regex_validator_name . 'Validator';
#echo '$input_validator_class_name: ' . $input_validator_class_name . PHP_EOL;
$input_validator_file_name = $input_validators_directory_name . DIRECTORY_SEPARATOR . $input_validator_class_name . '.inc.php';
#echo '$input_validator_file_name: ' . $input_validator_file_name . PHP_EOL;
if (is_file($input_validator_file_name)) {
throw new ErrorHandling_SprintfException('\'%s\' already exists!', array($input_validator_file_name));
} else {
$date = date('Y-m-d');
$copyright_holder = $module_directory->get_copyright_holder();
$file_contents = <<<CNT
<?php
/**
* {$input_validator_class_name}
*
* @copyright {$date}, {$copyright_holder}
*/
class
\t{$input_validator_class_name}
extends
\tInputValidation_RegexValidator
{
\tprotected function
\t\tget_regex()
\t{
\t\t/*
\t\t * Write the regex here.
\t\t */
\t\treturn '/^\$/';
\t}
\t
\tprotected function
\t\tget_exception_message()
\t{
\t\t/*
\t\t * Write a more informative exception message here.
\t\t */
\t\treturn 'Regex validation error!';
\t}
}
?>
CNT;
if ($fh = fopen($input_validator_file_name, 'w')) {
fwrite($fh, $file_contents);
fclose($fh);
HaddockProjectOrganisation_AutoloadFilesHelper::refresh_autoload_file();
}
}
}
public static function create_cli_script($new_script_name, HaddockProjectOrganisation_ModuleDirectory $module_directory)
{
/*
* TODO Make sure that the module directory has a classes directory first.
*
* If there is no classes directory, then such a directory should created.
*/
$module_directory->make_sure_classes_directory_exists();
$classes_directory = $module_directory->get_classes_directory();
$cli_scripts_directory_name = $classes_directory->get_name() . DIRECTORY_SEPARATOR . 'cli-scripts';
#echo '$cli_scripts_directory_name: ' . $cli_scripts_directory_name . PHP_EOL;
FileSystem_DirectoryHelper::mkdir_parents($cli_scripts_directory_name);
$script_class_name = $module_directory->get_camel_case_root() . '_' . $new_script_name . 'CLIScript';
#echo '$script_class_name: ' . $script_class_name . PHP_EOL;
$cli_script_file_name = $cli_scripts_directory_name . DIRECTORY_SEPARATOR . $script_class_name . '.inc.php';
#echo '$cli_script_file_name: ' . $cli_script_file_name . PHP_EOL;
if (is_file($cli_script_file_name)) {
throw new ErrorHandling_SprintfException('\'%s\' already exists!', array($cli_script_file_name));
} else {
$date = date('Y-m-d');
$copyright_holder = $module_directory->get_copyright_holder();
$file_contents = <<<CNT
<?php
/**
* {$script_class_name}
*
* @copyright {$date}, {$copyright_holder}
*/
class
\t{$script_class_name}
extends
\tCLIScripts_CLIScript
{
\tpublic function
\t\tdo_actions()
\t{
\t\t/*
\t\t * Write code here.
\t\t */
\t}
}
?>
CNT;
if ($fh = fopen($cli_script_file_name, 'w')) {
fwrite($fh, $file_contents);
fclose($fh);
CLIScripts_ScriptObjectRunnersHelper::generate_script_object_runners();
}
}
}
public static function create_directory_class($new_directory_class_name, HaddockProjectOrganisation_ModuleDirectory $module_directory)
{
$classes_directory = $module_directory->get_classes_directory();
$directory_classes_directory_name = $classes_directory->get_name() . DIRECTORY_SEPARATOR . 'file-system' . DIRECTORY_SEPARATOR . 'directories';
echo '$directory_classes_directory_name: ' . $directory_classes_directory_name . PHP_EOL;
FileSystem_DirectoryHelper::mkdir_parents($directory_classes_directory_name);
$directory_class_name = $module_directory->get_camel_case_root() . '_' . $new_directory_class_name . 'Directory';
echo '$directory_class_name: ' . $directory_class_name . PHP_EOL;
$directory_class_file_name = $directory_classes_directory_name . DIRECTORY_SEPARATOR . $directory_class_name . '.inc.php';
echo '$directory_class_file_name: ' . $directory_class_file_name . PHP_EOL;
if (is_file($directory_class_file_name)) {
throw new ErrorHandling_SprintfException('\'%s\' already exists!', array($directory_class_file_name));
} else {
$date = date('Y-m-d');
$copyright_holder = $module_directory->get_copyright_holder();
$file_contents = <<<CNT
<?php
/**
* {$directory_class_name}
*
* @copyright {$date}, {$copyright_holder}
*/
class
\t{$directory_class_name}
extends
\tFileSystem_Directory
{
\t/*
\t * Write code here.
\t */
}
?>
CNT;
if ($fh = fopen($directory_class_file_name, 'w')) {
fwrite($fh, $file_contents);
fclose($fh);
HaddockProjectOrganisation_AutoloadFilesHelper::refresh_autoload_file();
}
}
}
public static function create_unit_tests_class($new_unit_tests_class_name, HaddockProjectOrganisation_ModuleDirectory $module_directory)
{
$classes_directory = $module_directory->get_classes_directory();
$unit_tests_directory_name = $classes_directory->get_name() . DIRECTORY_SEPARATOR . 'unit-tests';
#echo '$unit_tests_directory_name: ' . $unit_tests_directory_name . PHP_EOL;
FileSystem_DirectoryHelper::mkdir_parents($unit_tests_directory_name);
$unit_tests_class_name = $module_directory->get_camel_case_root() . '_' . $new_unit_tests_class_name . 'Tests';
#echo '$unit_tests_class_name: ' . $unit_tests_class_name . PHP_EOL;
$unit_tests_class_file_name = $unit_tests_directory_name . DIRECTORY_SEPARATOR . $unit_tests_class_name . '.inc.php';
#echo '$unit_tests_class_file_name: ' . $unit_tests_class_file_name . PHP_EOL;
if (is_file($unit_tests_class_file_name)) {
throw new ErrorHandling_SprintfException('\'%s\' already exists!', array($unit_tests_class_file_name));
} else {
$date = date('Y-m-d');
$copyright_holder = $module_directory->get_copyright_holder();
$file_contents = <<<CNT
<?php
/**
* {$unit_tests_class_name}
*
* @copyright {$date}, {$copyright_holder}
*/
class
\t{$unit_tests_class_name}
extends
\tUnitTests_UnitTests
{
\tpublic static function
\t\tset_up()
\t{
\t\t/*
\t\t * Prepare the environment for each test in this class.
\t\t */
\t}
\t
\tpublic static function
\t\ttear_down()
\t{
\t\t/*
\t\t * Return the environment to a pristine state after
\t\t * each test in this class.
\t\t */
\t}
\t
\t/*
\t * ----------------------------------------
\t * The tests.
\t * ----------------------------------------
\t */
\t
\t/*
\t * Write public static test functions here.
\t */
}
?>
CNT;
if ($fh = fopen($unit_tests_class_file_name, 'w')) {
fwrite($fh, $file_contents);
fclose($fh);
HaddockProjectOrganisation_AutoloadFilesHelper::refresh_autoload_file();
}
}
}
