Class PhpSettings

This class manages settings concerning PHP, configured through
the 'Generation settings' dialog.

This class may be defined as a 'singleton', but I prefer to use static
members allowing to just write 'PhpSettings::member' rather than
'PhpSettings::instance()->member' or other long sentence like this.

Declaration :

Artifact : PhpSettings

Operation useDefaults

returns TRUE when the created Php objects are initialized
with the default declaration/definition

Declaration :

Operation set_UseDefaults

if y is TRUE the future created Php objects will be initialized
with the default declaration/definition

On error : return FALSE in C++, produce a RuntimeException in Java

Declaration :

Operation classStereotype

returns the PHP stereotype corresponding to the 'UML' stereotype given
in argument

Declaration :

Operation set_ClassStereotype

set the PHP stereotype corresponding to the 'UML' stereotype given
in argument

On error : return FALSE in C++, produce a RuntimeException in Java

Declaration :

Operation classUmlStereotype

reverse of the ClassStereotype() operation, returns the 'UML'
stereotype corresponding to the PHP one given in argument

Declaration :

Operation rootDir

return the 'root' directory

Declaration :

Operation set_RootDir

set the 'root' directory

On error : return FALSE in C++, produce a RuntimeException in Java

Declaration :

Operation sourceContent

returns the default source file content

Declaration :

Operation set_SourceContent

set the default source file content

On error : return FALSE in C++, produce a RuntimeException in Java

Declaration :

Operation sourceExtension

returns the extension of the file produced by the PHP code generator

Declaration :

Operation set_SourceExtension

set the extension of the file produced by the PHP code generator

On error : return FALSE in C++, produce a RuntimeException in Java

Declaration :

Operation reverseRoundtripDirRegExp

return the regular expression used to bypass
dir s on reverse/roundtrip

Declaration :

Operation isReverseRoundtripDirRegExpCaseSensitive

return if the regular expression used to bypass
dir s on reverse/roundtrip is case sensitive

Declaration :

Operation set_ReverseRoundtripDirRegExp

set the regular expression used to bypass
dir s on reverse/roundtrip
On error : return FALSE in C++, produce a RuntimeException in Java

Declaration :

Operation reverseRoundtripFileRegExp

return the regular expression used to bypass
file s on reverse/roundtrip

Declaration :

Operation isReverseRoundtripFileRegExpCaseSensitive

return if the regular expression used to bypass
file s on reverse/roundtrip is case sensitive

Declaration :

Operation set_ReverseRoundtripFileRegExp

set the regular expression used to bypass
file s on reverse/roundtrip
On error : return FALSE in C++, produce a RuntimeException in Java

Declaration :

Operation requireOnceWithPath

indicates to the code generator if the require_once may specify
the path of just the file's name

Declaration :

Operation set_RequireOnceWithPath

to indicates to the code generator if the require_once may specify
the path of just the file's name

On error : return FALSE in C++, produce a RuntimeException in Java

Declaration :

Operation isRelativePath

return if a relative path must be used when the path
must be generated in the produced require_once

Declaration :

Operation set_IsRelativePath

set if a relative path must be used when the path
must be generated in the produced require_once

On error : return FALSE in C++, produce a RuntimeException in Java

Declaration :

Operation isRootRelativePath

return if a path relative to the project root must be used
when the path must be generated in the produced require_once

Declaration :

Operation set_IsRootRelativePath

set if a relative to the project root path must be used
when the path must be generated in the produced require_once

On error : return FALSE in C++, produce a RuntimeException in Java

Declaration :

Operation isForceNamespacePrefixGeneration

return if the namespace prefix must be
always generated before class's names

Declaration :

Operation set_IsForceNamespacePrefixGeneration

set if the namespace prefix must be always generated before class's names

On error : return FALSE in C++, produce a RuntimeException in Java

Declaration :

Operation isGenerateJavadocStyleComment

return if generate Javadoc style comment

Declaration :

Operation set_IsGenerateJavadocStyleComment

set if generate Javadoc style comment

On error : return FALSE in C++, produce a RuntimeException in Java

Declaration :

Operation classDecl

returns the default definition of a class

Declaration :

Operation set_ClassDecl

set the default definition of a class

On error : return FALSE in C++, produce a RuntimeException in Java

Declaration :

Operation externalClassDecl

returns the default specification for an 'external' class

Declaration :

Operation set_ExternalClassDecl

set the default specification for an 'external' class

On error : return FALSE in C++, produce a RuntimeException in Java

Declaration :

Operation enumDecl

returns the default definition of an enumeration

Declaration :

Operation set_EnumDecl

set the default definition of an enumeration

On error : return FALSE in C++, produce a RuntimeException in Java

Declaration :

Operation interfaceDecl

returns the default definition of an interface

Declaration :

Operation set_InterfaceDecl

set the default definition of an interface

On error : return FALSE in C++, produce a RuntimeException in Java

Declaration :

Operation attributeDecl

returns the default definition of an attribute

Declaration :

Operation set_AttributeDecl

set the default definition of an attribute

On error : return FALSE in C++, produce a RuntimeException in Java

Declaration :

Operation enumItemDecl

returns the default definition of an enumeration item

Declaration :

Operation set_EnumItemDecl

set the default definition of an enumeration item

On error : return FALSE in C++, produce a RuntimeException in Java

Declaration :

Operation relationDecl

returns the default definition of an relation

Declaration :

Operation set_RelationDecl

set the default definition of an relation

On error : return FALSE in C++, produce a RuntimeException in Java

Declaration :

Operation operationDef

returns the default definition of an operation

Declaration :

Operation set_OperationDef

set the default definition of an operation

On error : return FALSE in C++, produce a RuntimeException in Java

Declaration :

Operation getVisibility

returns the default visibility of a 'get' operation generated
through the attribute and relation 'add get operation'

note : visibility shared with Java

Declaration :

Operation set_GetVisibility

set the default visibility of a 'get' operation generated
through the attribute and relation 'add get operation'

On error : return FALSE in C++, produce a RuntimeException in Java

note : visibility shared with Java

Declaration :

Operation getName

returns the default name of a 'get' operation generated
through the attribute and relation 'add get operation' menu

Declaration :

Operation set_GetName

set the default name of a 'get' operation generated
through the attribute and relation 'add get operation' menu

On error : return FALSE in C++, produce a RuntimeException in Java

Declaration :

Operation setName

returns the default name of a 'set' operation generated
through the attribute and relation 'add set operation' menu

Declaration :

Operation set_SetName

set the default name of a 'set' operation generated
through the attribute and relation 'add set operation' menu

On error : return FALSE in C++, produce a RuntimeException in Java

Declaration :

Operation isGetFinal

return if a 'get' operation generated through the attribute
and relation 'add get operation' menu is final by default

Declaration :

Operation set_IsGetFinal

set if a 'get' operation generated through the attribute
and relation 'add get operation' menu is final by default

On error : return FALSE in C++, produce a RuntimeException in Java

Declaration :

Operation isSetFinal

returns if a 'set' operation generated through the attribute
and relation 'add set operation' menu is final by default

Declaration :

Operation set_IsSetFinal

set if a 'set' operation generated through the attribute
and relation 'add set operation' menu is final by default

On error : return FALSE in C++, produce a RuntimeException in Java

Declaration :

Operation setVisibility

returns the default visibility of a 'set' operation generated
through the attribute and relation 'add set operation'

note : visibility shared with Java

Declaration :

Operation set_SetVisibility

set the default visibility of a 'set' operation generated
through the attribute and relation 'add set operation'

On error : return FALSE in C++, produce a RuntimeException in Java

note : visibility shared with Java

Declaration :

Operation PhpSettings

never called !

Declaration :

Attribute _defined

Declaration :

Attribute _root

Declaration :

Attribute _class_decl

Declaration :

Attribute _external_class_decl

Declaration :

Attribute _enum_decl

Declaration :

Attribute _interface_decl

Declaration :

Attribute _attr_decl

Declaration :

Attribute _enum_item_decl

Declaration :

Attribute _rel_decl

Declaration :

Attribute _oper_def

Declaration :

Relation _get_visibility (<directional composition>)

Declaration :

Attribute _get_name

Declaration :

Attribute _is_get_final

Declaration :

Relation _set_visibility (<directional composition>)

Declaration :

Attribute _set_name

Declaration :

Attribute _is_set_final

Declaration :

Attribute _src_content

Declaration :

Attribute _ext

Declaration :

Attribute _dir_regexp

Declaration :

Attribute _dir_regexp_case_sensitive

Declaration :

Attribute _file_regexp

Declaration :

Attribute _file_regexp_case_sensitive

Declaration :

Attribute _is_generate_javadoc_comment

Declaration :

Attribute _req_with_path

Declaration :

Attribute _is_relative_path

Declaration :

Attribute _is_root_relative_path

Declaration :

Attribute _is_force_namespace_gen

Declaration :

Operation read_

Declaration :

Operation read_if_needed_

Declaration :

All public operations : artifactDescription , attributeDecl , attributeDescription , classDecl , classDescription , classStereotype , classUmlStereotype , enumDecl , enumItemDecl , externalClassDecl , getName , getVisibility , interfaceDecl , isForceNamespacePrefixGeneration , isGenerateJavadocStyleComment , isGetFinal , isRelativePath , isReverseRoundtripDirRegExpCaseSensitive , isReverseRoundtripFileRegExpCaseSensitive , isRootRelativePath , isSetFinal , operationDef , operationDescription , relationDecl , relationDescription , requireOnceWithPath , reverseRoundtripDirRegExp , reverseRoundtripFileRegExp , rootDir , set_ArtifactDescription , set_AttributeDecl , set_AttributeDescription , set_ClassDecl , set_ClassDescription , set_ClassStereotype , set_EnumDecl , set_EnumItemDecl , set_ExternalClassDecl , set_GetName , set_GetVisibility , set_InterfaceDecl , set_IsForceNamespacePrefixGeneration , set_IsGenerateJavadocStyleComment , set_IsGetFinal , set_IsRelativePath , set_IsRootRelativePath , set_IsSetFinal , set_OperationDef , set_OperationDescription , set_RelationDecl , set_RelationDescription , set_RequireOnceWithPath , set_ReverseRoundtripDirRegExp , set_ReverseRoundtripFileRegExp , set_RootDir , set_SetName , set_SetVisibility , set_SourceContent , set_SourceExtension , set_UmlGetName , set_UmlSetName , set_UseDefaults , setName , setVisibility , sourceContent , sourceExtension , umlGetName , umlSetName , useDefaults