Docs For Class WsdlToPhpModel

WsdlToPhpModel

Description

Class WsdlToPhpModel defines the basic properties and methods to operations and structs extracted from the WSDL

Located in /WsdlToPhpModel.php (line 12)

Direct descendents

Class	Description
WsdlToPhpStructValue	Class WsdlToPhpStructValue stands for an enumeration value
WsdlToPhpService	Class WsdlToPhpService stands for an available service containing the functions/operations described in the WSDL
WsdlToPhpStructAttribute	Class WsdlToPhpStructAttribute stands for an available struct attribute described in the WSDL
WsdlToPhpStruct	Class WsdlToPhpStruct stands for an available struct described in the WSDL
WsdlToPhpFunction	Class WsdlToPhpFunction stands for an available operation described in the WSDL

Class Constant Summary

META_DOCUMENTATION = 'documentation'

META_FROM_SCHEMA = 'from schema'

Variable Summary

static array $models

static string $phpReserverKeywords

static array $replacedReservedPhpKeywords

static array $uniqueNames

string $inheritance

array $meta

string $name

WsdlToPhpModel $owner

Method Summary

static string cleanComment (string $_comment, [string $_glueSeparator = ','], [bool $_uniqueValues = true])

static string cleanString (string $_string, [bool $_keepMultipleUnderscores = true])

static string getGenericWsdlClassName ()

static WsdlToPhpStruct|null getModelByName (string $_modelName)

static array getModels ()

static mixed getValueWithinItsType (mixed $_value, [ $_knownType = null])

static string replaceReservedPhpKeyword (string $_keyword, string $_context)

static string uniqueName (string $_name, string $_context)

static WsdlToPhpStruct|bool updateModels (WsdlToPhpModel $_model)

mixed addMeta (string $_metaName, mixed $_metaValue)

void addMetaComment ([array &$_comments = array()], [bool $_addStars = false], [bool $_ignoreDocumentation = false], array $_comments)

void getClassBody (array &$_class)

array getClassComment ()

string getClassDeclaration ()

string getCleanName ([bool $_keepMultipleUnderscores = true])

array getComment ()

string getContextualPart ()

array getDocSubPackages ()

string getDocumentation ()

array getFileComment ()

string getFromSchema ()

string getInheritance ()

array getMeta ()

mixed getMetaValue (string $_metaName, [string $_fallback = null])

mixed getMetaValueFirstSet (array $_names, [string $_fallback = null])

string getName ()

WsdlToPhpModel getOwner ()

string getPackagedName ()

WsdlToPhpModel __construct (string $_name)

bool nameIsClean ()

string setDocumentation (string $_documentation)

string setFromSchema (string $_fromSchema)

void setInheritance ([string $_inheritance = ''])

array setMeta ([array $_meta = array()])

string setName (string $_name)

WsdlToPhpModel setOwner (WsdlToPhpModel $_owner)

string __toString ()

Variables

static array $models = array() (line 48)

Store all the models generated

access: private

Reserved PHP keywords

Plus {PackageName}WsdlClass specific/common methods

access: private

static array $replacedReservedPhpKeywords = array() (line 59)

Replaced keywords time in order to generate unique new keyword

access: private

static array $uniqueNames = array() (line 64)

Unique name generated in order to ensure unique naming (for struct constructor and setters/getters even for different case attribute name whith same value)

access: private

string $inheritance = '' (line 38)

Define the inheritance of a struct by the name of the parent struct or type

access: private

array $meta = array() (line 33)

Values associated to the operation

access: private

string $name = '' (line 28)

Original name od the element

access: private

WsdlToPhpModel $owner = null (line 43)

Store the object which owns the current model

access: private

Methods

static cleanComment (line 614)

Clean comment

access: public
usedby: WsdlToPhpGenerator::generateWsdlClassFile()
usedby: WsdlToPhpGenerator::populateFile()
usedby: WsdlToPhpModel::addMetaComment()
usedby: WsdlToPhpModel::getDocumentation()

static string cleanComment (string $_comment, [string $_glueSeparator = ','], [bool $_uniqueValues = true])

string $_comment: the comment to clean
string $_glueSeparator: ths string to use when gathering values
bool $_uniqueValues: indicates if comment values must be unique or not

static cleanString (line 486)

Clean a string to make it valid as PHP variable

access: public
usedby: WsdlToPhpFunction::getBody()
usedby: WsdlToPhpFunction::getComment()
usedby: WsdlToPhpModel::getCleanName()
usedby: WsdlToPhpService::getClassBody()

static string cleanString (string $_string, [bool $_keepMultipleUnderscores = true])

string $_string: the string to clean
bool $_keepMultipleUnderscores: optional, allows to keep the multiple consecutive underscores

static getGenericWsdlClassName (line 625)

Returns the generic name of the WsdlClass

access: public
usedby: WsdlToPhpFunction::getComment()
usedby: WsdlToPhpStruct::getClassBody()
usedby: WsdlToPhpModel::getClassDeclaration()
uses: WsdlToPhpGenerator::getPackageName()
usedby: WsdlToPhpService::getClassBody()

static string getGenericWsdlClassName ()

static getModelByName (line 507)

Returns the model by its name

access: public
usedby: WsdlToPhpFunction::getBody()
usedby: WsdlToPhpGenerator::generateStructsClasses()
usedby: WsdlToPhpFunction::getComment()
usedby: WsdlToPhpGenerator::manageWsdlNodeUnion()
usedby: WsdlToPhpStruct::getAttributes()
usedby: WsdlToPhpGenerator::manageWsdlNodeAttribute()
usedby: WsdlToPhpStructAttribute::getSetterDeclaration()
usedby: WsdlToPhpService::getClassBody()
usedby: WsdlToPhpModel::getClassDeclaration()
usedby: WsdlToPhpStructAttribute::getComment()
usedby: WsdlToPhpStructAttribute::getGetterDeclaration()
uses: WsdlToPhpModel::getModels()
usedby: WsdlToPhpStruct::getClassBody()

static WsdlToPhpStruct|null getModelByName (string $_modelName)

string $_modelName: the original WsdlToPhpStruct name

static getModels (line 497)

Get models

access: public
usedby: WsdlToPhpModel::getModelByName()

static array getModels ()

static getValueWithinItsType (line 581)

Returns the value with good type

access: public
usedby: WsdlToPhpStructAttribute::getDefaultValue()
usedby: WsdlToPhpStructValue::getValue()

static mixed getValueWithinItsType (mixed $_value, [ $_knownType = null])

mixed $_value: the value
$_knownType

static replaceReservedPhpKeyword (line 532)

Returns a usable keyword for a original keyword

access: public
usedby: WsdlToPhpFunction::getMethodName()

static string replaceReservedPhpKeyword (string $_keyword, string $_context)

string $_keyword: the keyword
string $_context: the context

static uniqueName (line 562)

Static method wich returns a unique name case sensitively

Useful to name methods case sensitively distinct, see http://the-echoplex.net/log/php-case-sensitivity

access: protected
usedby: WsdlToPhpFunction::getBody()
usedby: WsdlToPhpFunction::getMethodName()
usedby: WsdlToPhpModel::getPackagedName() - to ensure unique naming of struct case sensitively
usedby: WsdlToPhpStructAttribute::getUniqueName()

static string uniqueName (string $_name, string $_context)

string $_name: the original name
string $_context: the context where the name is needed unique

static updateModels (line 520)

Updates models with model

access: protected
usedby: WsdlToPhpStruct::setIsRestriction()
usedby: WsdlToPhpStruct::setIsStruct()
usedby: WsdlToPhpStruct::addAttribute()
usedby: WsdlToPhpStruct::addValue()
usedby: WsdlToPhpStruct::setValues()
usedby: WsdlToPhpModel::addMeta()
uses: WsdlToPhpModel::__toString()
usedby: WsdlToPhpModel::__construct()
usedby: WsdlToPhpModel::setInheritance()
uses: WsdlToPhpModel::getName()
usedby: WsdlToPhpModel::setOwner()

static WsdlToPhpStruct|bool updateModels (WsdlToPhpModel $_model)

WsdlToPhpModel $_model: a WsdlToPhpModel object

addMeta (line 303)

Add meta information to the operation

access: public
usedby: WsdlToPhpGenerator::addStructAttributeMeta()
usedby: WsdlToPhpGenerator::addServiceFunctionMeta()
usedby: WsdlToPhpGenerator::addStructMeta()
usedby: WsdlToPhpModel::setDocumentation()
uses: WsdlToPhpModel::updateModels()
uses: WsdlToPhpModel::getMeta()
usedby: WsdlToPhpModel::setFromSchema()

mixed addMeta (string $_metaName, mixed $_metaValue)

string $_metaName
mixed $_metaValue

addMetaComment (line 256)

Add meta informations to comment array

access: protected
usedby: WsdlToPhpStructAttribute::getComment()
usedby: WsdlToPhpFunction::getComment()
usedby: WsdlToPhpStructValue::getComment()
usedby: WsdlToPhpModel::getClassComment()
uses: WsdlToPhpModel::META_DOCUMENTATION
uses: WsdlToPhpModel::cleanComment()
uses: WsdlToPhpModel::getMeta()

void addMetaComment ([array &$_comments = array()], [bool $_addStars = false], [bool $_ignoreDocumentation = false], array $_comments)

array $_comments: array which meta are added to
bool $_addStars: add comments tags
bool $_ignoreDocumentation: ignore documentation info or not
array &$_comments

getClassBody (line 225)

Methods which fills the class body

Must be overridden in classes

access: public
usedby: WsdlToPhpModel::getClassDeclaration()

void getClassBody (array &$_class)

array &$_class

Redefined in descendants as:

WsdlToPhpService::getClassBody() : Returns the comment lines for this service
WsdlToPhpStruct::getClassBody() : Returns the constructor method

getClassComment (line 118)

Returns the comments for the class

access: private
uses: WsdlToPhpModel::getPackagedName()
uses: WsdlToPhpStruct::getIsStruct()
uses: WsdlToPhpModel::getDocumentation()
uses: WsdlToPhpModel::getDocSubPackages()
uses: WsdlToPhpGenerator::getPackageName()
uses: WsdlToPhpModel::addMetaComment()
uses: WsdlToPhpGenerator::getOptionAddComments()

array getClassComment ()

getClassDeclaration (line 159)

Method to override in sub class

Must return a string in order to declare the function, attribute or the value

access: public
uses: WsdlToPhpStruct::getIsStruct()
uses: WsdlToPhpModel::getPackagedName()
usedby: WsdlToPhpGenerator::generateStructsClasses()
usedby: WsdlToPhpGenerator::generateServicesClasses()
uses: WsdlToPhpModel::getModelByName()
uses: WsdlToPhpModel::getInheritance()
uses: WsdlToPhpGenerator::getOptionInheritsClassIdentifier()
uses: WsdlToPhpModel::getClassBody()
uses: WsdlToPhpModel::getComment()
uses: WsdlToPhpModel::getGenericWsdlClassName()
uses: WsdlToPhpGenerator::getOptionGenerateWsdlClassFile()

string getClassDeclaration ()

getCleanName (line 417)

Returns a valid clean name for PHP

access: public
usedby: WsdlToPhpFunction::getMethodName()
usedby: WsdlToPhpStruct::getClassBody()
usedby: WsdlToPhpGenerator::generateStructsClasses()
usedby: WsdlToPhpGenerator::generateClassMap()
usedby: WsdlToPhpGenerator::getPart()
usedby: WsdlToPhpStructAttribute::getSetterDeclaration()
usedby: WsdlToPhpGenerator::generateServicesClasses()
usedby: WsdlToPhpStructAttribute::getDeclaration()
usedby: WsdlToPhpModel::nameIsClean()
uses: WsdlToPhpModel::getName()
usedby: WsdlToPhpModel::getPackagedName()
usedby: WsdlToPhpStructValue::getCleanName()
uses: WsdlToPhpModel::cleanString()
usedby: WsdlToPhpStructAttribute::getUniqueName()
usedby: WsdlToPhpStructAttribute::getGetterDeclaration()

string getCleanName ([bool $_keepMultipleUnderscores = true])

bool $_keepMultipleUnderscores: optional, allows to keep the multiple consecutive underscores

Redefined in descendants as:

WsdlToPhpStructValue::getCleanName() : Returns the name of the value as constant

getComment (line 81)

Returns comments for the element

access: public
usedby: WsdlToPhpModel::getClassDeclaration()

array getComment ()

Redefined in descendants as:

WsdlToPhpStructValue::getComment() : Returns the comment lines for this value
WsdlToPhpStructAttribute::getComment() : Returns the comment lines for this attribute
WsdlToPhpFunction::getComment() : Returns the comment lines for this function

getContextualPart (line 467)

Allows to define the contextual part of the class name for the package

access: public
usedby: WsdlToPhpGenerator::getPart()
usedby: WsdlToPhpModel::getPackagedName()

string getContextualPart ()

Redefined in descendants as:

WsdlToPhpService::getContextualPart() : Returns the contextual part of the class name for the package
WsdlToPhpStruct::getContextualPart() : Returns the contextual part of the class name for the package

getDocSubPackages (line 476)

Returns the sub package name which the model belongs to

Must be overridden by sub classes

access: public
usedby: WsdlToPhpModel::getClassComment()
usedby: WsdlToPhpModel::getFileComment()

array getDocSubPackages ()

Redefined in descendants as:

WsdlToPhpService::getDocSubPackages() : Returns the sub package name which the model belongs to
WsdlToPhpStruct::getDocSubPackages() : Returns the sub package name which the model belongs to

getDocumentation (line 342)

Get the documentation meta value

return: the documentation from the WSDL
access: public
usedby: WsdlToPhpModel::getClassComment()
usedby: WsdlToPhpFunction::getComment()
uses: WsdlToPhpModel::META_DOCUMENTATION
uses: WsdlToPhpModel::getMetaValue()
uses: WsdlToPhpModel::cleanComment()

string getDocumentation ()

getFileComment (line 93)

Returns the comments for the file

access: private
uses: WsdlToPhpModel::getPackagedName()
uses: WsdlToPhpModel::getDocSubPackages()
uses: WsdlToPhpGenerator::getPackageName()
uses: WsdlToPhpGenerator::getOptionAddComments()

array getFileComment ()

getFromSchema (line 363)

Get the from schema meta value

return: the from schema meta value
access: public
uses: WsdlToPhpModel::META_FROM_SCHEMA
uses: WsdlToPhpModel::getMetaValue()

string getFromSchema ()

getInheritance (line 231)

Returns the name of the class the current class inherits from

access: public
usedby: WsdlToPhpGenerator::generateStructsClasses()
usedby: WsdlToPhpGenerator::manageWsdlNodeAttribute()
usedby: WsdlToPhpGenerator::manageWsdlNodeUnion()
usedby: WsdlToPhpStruct::getAttributes()
usedby: WsdlToPhpStruct::getClassBody()
usedby: WsdlToPhpModel::getClassDeclaration()
usedby: WsdlToPhpStructAttribute::getComment()
usedby: WsdlToPhpStructAttribute::getSetterDeclaration()

string getInheritance ()

getMeta (line 282)

Returns the meta

access: public
usedby: WsdlToPhpModel::getMetaValue()
usedby: WsdlToPhpModel::addMetaComment()
usedby: WsdlToPhpModel::addMeta()

array getMeta ()

getMetaValue (line 374)

Returns a meta value according to its name

return: the meta information value
access: public
usedby: WsdlToPhpGenerator::manageWsdlNodeEnumeration()
usedby: WsdlToPhpGenerator::manageWsdlNodeHeader()
usedby: WsdlToPhpGenerator::manageWsdlNodeAttribute()
usedby: WsdlToPhpStructAttribute::isRequired()
usedby: WsdlToPhpService::getClassBody()
usedby: WsdlToPhpModel::getDocumentation()
usedby: WsdlToPhpModel::getFromSchema()
uses: WsdlToPhpModel::getMeta()

mixed getMetaValue (string $_metaName, [string $_fallback = null])

string $_metaName: the meta information name
string $_fallback: the fallback value if unset

getMetaValueFirstSet (line 384)

Returns the value of the first meta value assigned to the name

return: the meta information value
access: public
usedby: WsdlToPhpStructAttribute::getPattern()
usedby: WsdlToPhpStructAttribute::getDefaultValue()
usedby: WsdlToPhpStructAttribute::isRequired()

mixed getMetaValueFirstSet (array $_names, [string $_fallback = null])

array $_names: the meta names to check
string $_fallback: the fallback value if anyone is set

getName (line 397)

Returns the original name extracted from the WSDL

access: public
usedby: WsdlToPhpStruct::getValue()
usedby: WsdlToPhpStruct::isArray()
usedby: WsdlToPhpStruct::getClassBody()
usedby: WsdlToPhpFunction::getBody()
usedby: WsdlToPhpGenerator::generateStructsClasses()
usedby: WsdlToPhpGenerator::manageWsdlNodeList()
usedby: WsdlToPhpGenerator::manageWsdlNodeUnion()
usedby: WsdlToPhpGenerator::generateClassMap()
usedby: WsdlToPhpStructAttribute::getSetterDeclaration()
usedby: WsdlToPhpStructAttribute::getGetterDeclaration()
usedby: WsdlToPhpModel::updateModels()
usedby: WsdlToPhpModel::nameIsClean()
usedby: WsdlToPhpModel::getCleanName()
usedby: WsdlToPhpStructValue::getCleanName()
usedby: WsdlToPhpStructValue::getValue()
usedby: WsdlToPhpStructAttribute::getComment()
usedby: WsdlToPhpService::getFunction()
usedby: WsdlToPhpStructAttribute::getUniqueName()

string getName ()

getOwner (line 425)

Returns the owner model object

access: public
usedby: WsdlToPhpFunction::getOwner()
usedby: WsdlToPhpFunction::getMethodName()
usedby: WsdlToPhpStructValue::getOwner()
usedby: WsdlToPhpStructValue::getCleanName()
usedby: WsdlToPhpStructAttribute::getOwner()

WsdlToPhpModel getOwner ()

Redefined in descendants as:

WsdlToPhpStructValue::getOwner() : Returns the owner model object, meaning a WsdlToPhpStruct object
WsdlToPhpStructAttribute::getOwner() : Returns the owner model object, meaning a WsdlToPhpStruct object
WsdlToPhpFunction::getOwner() : Returns the owner model object, meaning a WsdlToPhpService object

getPackagedName (line 459)

Returns the packaged name

access: public
usedby: WsdlToPhpFunction::getMethodName()
usedby: WsdlToPhpStruct::getClassBody()
usedby: WsdlToPhpStructAttribute::getSetterDeclaration()
usedby: WsdlToPhpFunction::getComment()
usedby: WsdlToPhpFunction::getBody()
usedby: WsdlToPhpGenerator::generateServicesClasses()
usedby: WsdlToPhpGenerator::generateStructsClasses()
usedby: WsdlToPhpStructAttribute::getGetterDeclaration()
usedby: WsdlToPhpGenerator::manageWsdlNodeHeader()
usedby: WsdlToPhpStructAttribute::getComment()
uses: WsdlToPhpModel::uniqueName() - to ensure unique naming of struct case sensitively
uses: WsdlToPhpModel::getContextualPart()
uses: WsdlToPhpModel::getCleanName()
usedby: WsdlToPhpModel::getFileComment()
usedby: WsdlToPhpModel::getClassComment()
usedby: WsdlToPhpService::getClassBody()
usedby: WsdlToPhpModel::getClassDeclaration()
uses: WsdlToPhpGenerator::getPackageName()

string getPackagedName ()

Constructor __construct (line 72)

Main constructor

WsdlToPhpModel __construct (string $_name)

string $_name: the original name

Redefined in descendants as:

WsdlToPhpStructValue::__construct() : Main constructor
WsdlToPhpService::__construct() : Main constructor
WsdlToPhpStructAttribute::__construct() : Main constructor
WsdlToPhpStruct::__construct() : Main constructor
WsdlToPhpFunction::__construct() : Main constructor

nameIsClean (line 447)

Returns true if the original name is safe to use as a PHP property, variable name or class name

access: public
usedby: WsdlToPhpFunction::getBody()
usedby: WsdlToPhpStructAttribute::getSetterDeclaration()
usedby: WsdlToPhpStructAttribute::getGetterDeclaration()
uses: WsdlToPhpModel::getCleanName()
uses: WsdlToPhpModel::getName()

bool nameIsClean ()

setDocumentation (line 330)

Sets the documentation meta value.

Documentation is set as an array so if multiple documentation nodes are set for an unique element, it will gather them.

return: the documentation from the WSDL
access: public
usedby: WsdlToPhpGenerator::setStructValueDocumentation()
usedby: WsdlToPhpGenerator::setServiceFunctionDocumentation()
usedby: WsdlToPhpGenerator::setStructAttributeDocumentation()
usedby: WsdlToPhpGenerator::setStructDocumentation()
uses: WsdlToPhpModel::META_DOCUMENTATION
uses: WsdlToPhpModel::addMeta()

string setDocumentation (string $_documentation)

string $_documentation: the documentation from the WSDL

setFromSchema (line 353)

Sets the from schema meta value.

return: the url from which the element comes from
access: public
uses: WsdlToPhpModel::META_FROM_SCHEMA
uses: WsdlToPhpModel::addMeta()

string setFromSchema (string $_fromSchema)

string $_fromSchema: the url from which the element comes from

setInheritance (line 240)

Sets the name of the class the current class inherits from

access: public
usedby: WsdlToPhpGenerator::setStructInheritance()
uses: WsdlToPhpModel::updateModels()

void setInheritance ([string $_inheritance = ''])

string $_inheritance

setMeta (line 291)

Sets the meta

access: public

array setMeta ([array $_meta = array()])

array $_meta

setName (line 406)

Sets the original name extracted from the WSDL

access: public
usedby: WsdlToPhpModel::__construct()

string setName (string $_name)

string $_name

setOwner (line 435)

Sets the owner model object

access: public
usedby: WsdlToPhpFunction::__construct()
usedby: WsdlToPhpStructAttribute::__construct()
usedby: WsdlToPhpStructValue::__construct()
uses: WsdlToPhpModel::updateModels()

WsdlToPhpModel setOwner (WsdlToPhpModel $_owner)

WsdlToPhpModel $_owner: object the owner of the current model

__toString (line 633)

Returns class name

return: __CLASS__
access: public
usedby: WsdlToPhpModel::updateModels()

string __toString ()

Redefined in descendants as:

WsdlToPhpStructValue::__toString() : Returns class name
WsdlToPhpService::__toString() : Returns class name
WsdlToPhpStructAttribute::__toString() : Returns class name
WsdlToPhpStruct::__toString() : Returns class name
WsdlToPhpFunction::__toString() : Return class name

Class Constants

META_DOCUMENTATION = 'documentation' (line 18)

Constant used to define the key to store documentation value in meta

usedby: WsdlToPhpModel::getDocumentation()
usedby: WsdlToPhpModel::setDocumentation()
usedby: WsdlToPhpModel::addMetaComment()

META_FROM_SCHEMA = 'from schema' (line 23)

Constant used to define the key to store from schema value in meta

usedby: WsdlToPhpModel::getFromSchema()
usedby: WsdlToPhpModel::setFromSchema()

Documentation generated on Thu, 20 Feb 2014 22:48:29 +0100 by phpDocumentor 1.4.4