Php5Writer Class Reference

#include <php5writer.h>

Inheritance diagram for Php5Writer:

Collaboration diagram for Php5Writer:

Public Member Functions
	Php5Writer ()
virtual	~Php5Writer ()
virtual void	writeClass (UMLClassifier *c)
virtual Uml::ProgrammingLanguage::Enum	language () const
virtual QStringList	reservedKeywords () const
Public Member Functions inherited from SimpleCodeGenerator
	SimpleCodeGenerator (bool createDirHierarchyForPackages=true)
virtual	~SimpleCodeGenerator ()
void	writeCodeToFile (UMLClassifierList &concepts)
void	writeCodeToFile ()
Public Member Functions inherited from CodeGenerator
	CodeGenerator ()
virtual	~CodeGenerator ()
bool	addCodeDocument (CodeDocument *add_object)
bool	removeCodeDocument (CodeDocument *remove_object)
CodeDocumentList *	getCodeDocumentList ()
QString	getUniqueID (CodeDocument *codeDoc)
virtual void	saveToXMI (QXmlStreamWriter &writer)
CodeDocument *	findCodeDocumentByID (const QString &id)
void	setIncludeHeadings (bool i)
bool	includeHeadings () const
void	setHeadingFileDir (const QString &)
QString	headingFileDir () const
void	setForceDoc (bool f)
bool	forceDoc () const
void	setForceSections (bool f)
bool	forceSections () const
virtual QString	getHeadingFile (const QString &file)
QString	findFileName (CodeDocument *codeDocument)
virtual void	loadFromXMI (QDomElement &element)
CodeDocument *	findCodeDocumentByClassifier (UMLClassifier *classifier)
virtual QStringList	defaultDatatypes () const
virtual bool	isReservedKeyword (const QString &keyword)
virtual void	createDefaultStereotypes ()

Private Member Functions
void	writeOperations (UMLClassifier *c, QTextStream &php)
void	writeOperations (const QString &classname, UMLOperationList &opList, QTextStream &php, bool interface=false, bool generateErrorStub=false)
void	writeAttributes (UMLClassifier *c, QTextStream &php)
void	writeAttributes (UMLAttributeList &atList, QTextStream &php)

Additional Inherited Members
Public Types inherited from CodeGenerator
enum	GenerationState { Generated , Failed , Skipped }
Public Slots inherited from SimpleCodeGenerator
virtual void	syncCodeToDocument ()
Public Slots inherited from CodeGenerator
virtual void	syncCodeToDocument ()
Signals inherited from CodeGenerator
void	codeGenerated (UMLClassifier *concept, bool generated)
void	codeGenerated (UMLClassifier *concept, CodeGenerator::GenerationState result)
void	showGeneratedFile (const QString &filename)
Static Public Member Functions inherited from CodeGenerator
static QString	cleanName (const QString &name)
static QString	formatDoc (const QString &text, const QString &linePrefix=QLatin1String(" *"), int lineWidth=80)
static QString	formatSourceCode (const QString &code, const QString &indentation)
static void	findObjectsRelated (UMLClassifier *c, UMLPackageList &cList)
Protected Member Functions inherited from SimpleCodeGenerator
QString	findFileName (UMLPackage *concept, const QString &ext)
QString	overwritableName (UMLPackage *concept, const QString &name, const QString &ext)
bool	hasDefaultValueAttr (UMLClassifier *c)
bool	hasAbstractOps (UMLClassifier *c)
QString	indent ()
virtual void	initFromParentDocument ()
Protected Member Functions inherited from CodeGenerator
QString	overwritableName (const QString &name, const QString &extension)
bool	openFile (QFile &file, const QString &name)
void	writeListedCodeDocsToFile (CodeDocumentList *docs)
virtual void	finalizeRun ()
Protected Attributes inherited from SimpleCodeGenerator
QString	className_
QString	fileName_
QMap< UMLPackage *, QString >	m_fileMap
bool	m_createDirHierarchyForPackages
QString	m_indentation
int	m_indentLevel
QString	m_endl
Protected Attributes inherited from CodeGenerator
QHash< QString, CodeDocument * >	m_codeDocumentDictionary
bool	m_applyToAllRemaining
UMLDoc *	m_document

Detailed Description

Class Php5Writer is a PHP code generator for UMLClassifier objects. Just call writeClass and feed it a UMLClassifier.

Constructor & Destructor Documentation

Php5Writer()

Php5Writer::Php5Writer

(

)

~Php5Writer()

Php5Writer::~Php5Writer ( )

virtual

Member Function Documentation

language()

Uml::ProgrammingLanguage::Enum Php5Writer::language ( ) const

virtual

Returns "PHP".

Returns

the programming language identifier

Implements CodeGenerator.

reservedKeywords()

QStringList Php5Writer::reservedKeywords ( ) const

virtual

Get list of reserved keywords.

Returns

the list of reserved keywords

Reimplemented from CodeGenerator.

writeAttributes() [1/2]

void Php5Writer::writeAttributes ( UMLAttributeList &  atList, QTextStream &  php  )

private

Write a list of class attributes.

Parameters

atList	the list of attributes
php	output stream for the PHP file

Here is the call graph for this function:

writeAttributes() [2/2]

void Php5Writer::writeAttributes ( UMLClassifier *  c, QTextStream &  php  )

private

Write all the attributes of a class.

Parameters

c	the class we are generating code for
php	output stream for the PHP file

Here is the call graph for this function:

writeClass()

void Php5Writer::writeClass ( UMLClassifier *  c )

virtual

Call this method to generate Php code for a UMLClassifier.

Parameters

c	the class you want to generate code for.

Implements SimpleCodeGenerator.

Here is the call graph for this function:

writeOperations() [1/2]

void Php5Writer::writeOperations ( const QString &  classname, UMLOperationList &  opList, QTextStream &  php, bool  isInterface = false, bool  generateErrorStub = false  )

private

Write a list of class operations.

Parameters

classname	the name of the class
opList	the list of operations
php	output stream for the PHP file
isInterface	indicates if the operation is an interface member
generateErrorStub	true generates trigger_error("Implement " . __FUNCTION__)

Here is the call graph for this function:

writeOperations() [2/2]

void Php5Writer::writeOperations ( UMLClassifier *  c, QTextStream &  php  )

private

Write all operations for a given class.

Parameters

c	the concept we are generating code for
php	output stream for the PHP file

Here is the call graph for this function:

---

The documentation for this class was generated from the following files:

• umbrello/codegenerators/php/php5writer.h
• umbrello/codegenerators/php/php5writer.cpp