Docs For Class RSDEngineFile

Description

Helper class for creating source files.

There are two ways of using this class. The first one is to extend it and to overwrite the methods getFilename, and getCode. This is recommendable if the file you want to create is rather complex. You would call the constructor with only one argument:


1     new RSDEngineFileChildClass($config);

The second way to use this class makes only sense if $config is not needed for creating your file. Call the constructor like this:


1     new RSDEngineClass(false, "myFilename.php", $fileCode);

copyright: Lukas Feiler 2003
version: 0.1.9
author: Lukas Feiler <mailto:lukas.feiler@chello.at>

Located in /code/framework/RSDEngine/RSDEngineFile.php (line 47)

Direct descendents

Class	Description
RSDEngineControllerFile	Helper class for creating template files.
RSDEngineDBApplicationConfigFile	Generates the configuration file for database backended applications.
RSDEngineDBApplicationIndexFile	Generates a file called index.php to be put in the code directory.
RSDEngineDBApplicationInitFile	Generates the init file.
RSDEngineDBApplicationLogoutFile	Generates a file called logout.php to be put in the code directory.
RSDEngineDBApplicationPrivateInitFile	Generates the private init file.
RSDEngineDBApplicationPublicInitFile	Generates the public init file.
RSDEngineTemplateFile	Helper class for creating template files.

Variable Summary

String $code

Array $config

String $dir

String $filename

boolean $overwriteExisting

boolean $preventWriting

Array $relatedClasses

Array $relatedFiles

Array $relatedFunctions

Method Summary

RSDEngineFile RSDEngineFile (Array &$config, [String $filename = false], [String $code = false])

String getCode ()

String getFilename ()

void setOutputDirectory (String $dir)

void setRelatedClasses (Array $classes)

void setRelatedFiles (Array $files)

void setRelatedFunctions (Array $functions)

void setWrite (String $write)

void writeToDirectory ([String $dir = false])

Variables

String $code = '' (line 62)

The code of the file to create. Gets set inside the constructor method.

Array $config = array() (line 52)

An associative array containing all configuration options. Gets set inside the constructor method.

String $dir = '' (line 68)

The directory to which to write the file.

see: RSDEngineFile::writeToDirectory()

String $filename = '' (line 57)

The name of the file to create. Gets set inside the constructor method.

boolean $overwriteExisting = true (line 100)

Whether to overwrite an existing file.

Redefined in descendants as:

RSDEngineControllerFileFooter::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineControllerFileHeader::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineDBControllerFileCreate::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineDBControllerFileDelete::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineDBControllerFileGet::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineDBControllerFileGetOne::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineDBControllerFileGetStored::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineDBControllerFileSearch::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineDBControllerFileUpdate::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineDBControllerFileUpdateArea::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineDBControllerFileUpdateGroup::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineDBControllerFileUpdateRight::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineDBApplicationInitFile::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineDBApplicationPrivateInitFile::$overwriteExisting : Whether to overwrite an existing file. The default for this class is not to do so!
RSDEngineDBApplicationPublicInitFile::$overwriteExisting : Whether to overwrite an existing file. The default for this class is not to do so!
RSDEngineDBTemplateFileCreate::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineDBTemplateFileDelete::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineDBTemplateFileGet::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineDBTemplateFileGetOne::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineDBTemplateFileGetRecord::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineDBTemplateFileSearch::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineDBTemplateFileSearchRecord::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineDBTemplateFileUpdate::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineDBTemplateFileUpdateArea::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineDBTemplateFileUpdateGroup::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineDBTemplateFileUpdateRight::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineTemplateFileFatalError::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineTemplateFileFooter::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineTemplateFileHeader::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineTemplateFilePaging::$overwriteExisting : Whether to overwrite an existing file.
RSDEngineTemplateFilePermissionDenied::$overwriteExisting : Whether to overwrite an existing file.

boolean $preventWriting = false (line 105)

Whether to prevent writing this file.

Array $relatedClasses = array() (line 86)

An associative array containing related files. A class that extends RSDEngineFile and overwrites the method getCode might need this to communicate with other classes that are created. Gets set inside the method setRelatedClasses.

see: RSDEngineFile::setRelatedClasses()

Array $relatedFiles = array() (line 77)

An associative array containing related files. A class that extends RSDEngineFile and overwrites the method getCode might need this to communicate with other files that are created. Gets set inside the method setRelatedFiles.

see: RSDEngineFile::setRelatedFiles()

Array $relatedFunctions = array() (line 95)

An associative array containing related files. A class that extends RSDEngineFile and overwrites the method getCode might need this to communicate with other functions that are created. Gets set inside the method setRelatedFunctions.

see: RSDEngineFile::setRelatedFunctions()

Methods

Constructor RSDEngineFile (line 122)

Constructor that does the initialization.

RSDEngineFile RSDEngineFile (Array &$config, [String $filename = false], [String $code = false])

Array $config: An associative array containing all configuration options.
String $filename: The name of the file to create. Passing this argument makes only sense if the method getFilename does not get overwritten. This argument is optional. The default is false.
String $code: The code of the file to create. Passing this argument makes only sense if the method getCode does not get overwritten. This argument is optional. The default is false.

getCode (line 193)

Returns the code for this file.

return: is returned.
see: RSDEngineFile::$code

String getCode ()

Redefined in descendants as:

RSDEngineControllerFileFooter::getCode() : Returns the code for the file that is included by the template file footer.tpl (created by RSDEngineTemplateFileFooter).
RSDEngineControllerFileHeader::getCode() : Returns the code for the file that is included by the template file header.tpl (created by RSDEngineTemplateFileHeader).
RSDEngineDBControllerFileCreate::getCode() : Returns the code for the controller file for inserting records into a table.
RSDEngineDBControllerFileDelete::getCode() : Returns the code for the controller file for deleting records from a table.
RSDEngineDBControllerFileGet::getCode() : Returns the code for the controller file for selecting records from a table.
RSDEngineDBControllerFileGetOne::getCode() : Returns the code for the controller file for selecting one record from a table.
RSDEngineDBControllerFileGetStored::getCode() : Returns the code for the controller file for viewing the contents of the one column of a singel record of a table.
RSDEngineDBControllerFileSearch::getCode() : Returns the code for the controller file for searching records in a table.
RSDEngineDBControllerFileUpdate::getCode() : Returns the code for the controller file for inserting records into a table.
RSDEngineDBControllerFileUpdateArea::getCode() : Returns the code for the controller file for updating a LiveUser area.
RSDEngineDBControllerFileUpdateGroup::getCode() : Returns the code for the controller file for updating a LiveUser group.
RSDEngineDBControllerFileUpdateRight::getCode() : Returns the code for the controller file for updating a LiveUser right.
RSDEngineDBApplicationConfigFile::getCode() : Returns the code for the configuratin file.
RSDEngineDBApplicationIndexFile::getCode() : Returns the code for the file index.php.
RSDEngineDBApplicationInitFile::getCode() : Returns the code for the configuratin file of the application (for a database backended application).
RSDEngineDBApplicationLogoutFile::getCode() : Returns the code for the file logut.php.
RSDEngineDBApplicationPrivateInitFile::getCode() : Returns the code of the private initialization file of the application.
RSDEngineDBApplicationPublicInitFile::getCode() : Returns the code of the public initialization file.
RSDEngineDBTemplateFileCreate::getCode() : Returns the code for the template file for inserting records into a table.
RSDEngineDBTemplateFileDelete::getCode() : Returns the code for the template file for deleting records from a table.
RSDEngineDBTemplateFileGet::getCode() : Returns the code for the template file for selecting all records from a table.
RSDEngineDBTemplateFileGetOne::getCode() : Returns the code for the template file for selecting a single record from a table.
RSDEngineDBTemplateFileGetRecord::getCode() : Returns the code for smarty template file to be included by the get-template to display the records.
RSDEngineDBTemplateFileSearch::getCode() : Returns the code for the template file for searching records in a table.
RSDEngineDBTemplateFileSearchRecord::getCode() : Returns the code for smarty template file to be included by the get-template to display the records.
RSDEngineDBTemplateFileUpdate::getCode() : Returns the code for the template file for updating records in a table.
RSDEngineDBTemplateFileUpdateArea::getCode() : Returns the code for the template file for updating a LiveUser area.
RSDEngineDBTemplateFileUpdateGroup::getCode() : Returns the code for the template file for updating a LiveUser group.
RSDEngineDBTemplateFileUpdateRight::getCode() : Returns the code for the template file for updating a LiveUser right.
RSDEngineTemplateFileFatalError::getCode() : Returns the code for the template file for viewing an occurred error.
RSDEngineTemplateFileFooter::getCode() : Returns the code for the footer template file.
RSDEngineTemplateFileHeader::getCode() : Returns the code for the header template file.
RSDEngineTemplateFilePaging::getCode() : Returns the code for the template file for the paging feature.
RSDEngineTemplateFilePermissionDenied::getCode() : Returns the code for the template file for informig the user about a denied permission.

getFilename (line 184)

Returns the filename.

return: is returned.
see: RSDEngineFile::$filename

String getFilename ()

Redefined in descendants as:

RSDEngineControllerFileFooter::getFilename()
RSDEngineControllerFileHeader::getFilename()
RSDEngineDBControllerFileCreate::getFilename() : Returns the filename.
RSDEngineDBControllerFileDelete::getFilename() : Returns the filename.
RSDEngineDBControllerFileGet::getFilename() : Returns the filename.
RSDEngineDBControllerFileGetOne::getFilename() : Returns the filename.
RSDEngineDBControllerFileGetStored::getFilename() : Returns the filename.
RSDEngineDBControllerFileSearch::getFilename() : Returns the filename.
RSDEngineDBControllerFileUpdate::getFilename() : Returns the filename.
RSDEngineDBControllerFileUpdateArea::getFilename() : Returns the filename.
RSDEngineDBControllerFileUpdateGroup::getFilename() : Returns the filename.
RSDEngineDBControllerFileUpdateRight::getFilename() : Returns the filename.
RSDEngineDBApplicationConfigFile::getFilename() : Returns the name of the configuration file of the application class.
RSDEngineDBApplicationIndexFile::getFilename() : Returns the filename of this index file.
RSDEngineDBApplicationInitFile::getFilename() : Returns the name of the initialization file of the application class.
RSDEngineDBApplicationLogoutFile::getFilename() : Returns the filename of this logout file.
RSDEngineDBApplicationPrivateInitFile::getFilename() : Returns the name of the private initialization file.
RSDEngineDBApplicationPublicInitFile::getFilename() : Returns the name of the public initialization file.
RSDEngineDBTemplateFileCreate::getFilename() : Returns the filename.
RSDEngineDBTemplateFileDelete::getFilename() : Returns the filename.
RSDEngineDBTemplateFileGet::getFilename() : Returns the filename.
RSDEngineDBTemplateFileGetOne::getFilename() : Returns the filename.
RSDEngineDBTemplateFileGetRecord::getFilename() : Returns the filename.
RSDEngineDBTemplateFileSearch::getFilename() : Returns the filename.
RSDEngineDBTemplateFileSearchRecord::getFilename() : Returns the filename.
RSDEngineDBTemplateFileUpdate::getFilename() : Returns the filename.
RSDEngineDBTemplateFileUpdateArea::getFilename() : Returns the filename.
RSDEngineDBTemplateFileUpdateGroup::getFilename() : Returns the filename.
RSDEngineDBTemplateFileUpdateRight::getFilename() : Returns the filename.
RSDEngineTemplateFileFatalError::getFilename()
RSDEngineTemplateFileFooter::getFilename()
RSDEngineTemplateFileHeader::getFilename()
RSDEngineTemplateFilePaging::getFilename()
RSDEngineTemplateFilePermissionDenied::getFilename()

setOutputDirectory (line 174)

Sets the output direcotry.

$this->dir is set to the value passed as argument.

see: RSDEngineFile::$dir
see: RSDEngineFile::writeToDirectory()

void setOutputDirectory (String $dir)

String $dir: The output directory.

setRelatedClasses (line 215)

Sets the related classes.

$this->relatedClasses is set to the array passed as argument.

see: RSDEngineFile::$relatedClasses

void setRelatedClasses (Array $classes)

Array $classes: An associative array containing related classes.

setRelatedFiles (line 204)

Sets the related files.

$this->relatedFiles is set to the array passed as argument.

see: RSDEngineFile::$relatedFiles

void setRelatedFiles (Array $files)

Array $files: An associative array containing related files.

setRelatedFunctions (line 226)

Sets the related functions.

$this->relatedFunctions is set to the array passed as argument.

see: RSDEngineFile::$relatedFunctions

void setRelatedFunctions (Array $functions)

Array $functions: An associative array containing related functions.

setWrite (line 234)

Sets the properties preventWriting and overwriteExisting based on the string passed as argument

void setWrite (String $write)

String $write: 'true', 'false' or 'overwrite.

writeToDirectory (line 139)

Writes the file to a directory.

If this method is called without arguments or $dir === false the file will be written to $this->dir. Otherwise the file will be written to the directory passed as argument.

see: RSDEngineFile::setOutputDirectory()

void writeToDirectory ([String $dir = false])

String $dir: The directory to which to write the file. If this argument is false the file will be written to $this->dir. This argument is optional. The default is false.