Class WsdlToPhpStructValue stands for an enumeration value

Located in /WsdlToPhpStructValue.php (line 12)

WsdlToPhpModel
   |
   --WsdlToPhpStructValue

static array $uniqueConstants = array() (line 18)

Store the constants generated per structName

• access: private

int $index = 0 (line 23)

The index of the value in the enumeration struct

• access: private

Inherited Variables

Inherited from WsdlToPhpModel

WsdlToPhpModel::$inheritance
WsdlToPhpModel::$meta
WsdlToPhpModel::$models
WsdlToPhpModel::$name
WsdlToPhpModel::$owner
WsdlToPhpModel::$phpReserverKeywords
WsdlToPhpModel::$replacedReservedPhpKeywords
WsdlToPhpModel::$uniqueNames

static constantSuffix (line 126)

Returns the index which has to be added at the end of natural constant name defined with the value cleaned

Allows to avoid multiple constant name to be indentic

• access: private
• usedby: WsdlToPhpStructValue::getCleanName()

static int constantSuffix (string $_structName, mixed $_value, int $_index)

• string $_structName: the struct name
• mixed $_value: the value
• int $_index: the position of the value

Constructor __construct (line 34)

Main constructor

• see: WsdlToPhpModel::__construct()
• access: public
• uses: WsdlToPhpModel::setOwner()
• uses: WsdlToPhpStructValue::setIndex()

WsdlToPhpStructValue __construct (string $_name, string $_index, WsdlToPhpStruct $_wsdlToPhpStruct)

• string $_name: the original name
• string $_index: the index of the value in the enumeration struct
• WsdlToPhpStruct $_wsdlToPhpStruct: defines the struct which owns this value

---

Redefinition of:

WsdlToPhpModel::__construct()

Main constructor

getCleanName (line 53)

Returns the name of the value as constant

• see: WsdlToPhpModel::getCleanName()
• access: public
• usedby: WsdlToPhpStruct::getClassBody()
• uses: WsdlToPhpStructValue::getOwner()
• uses: WsdlToPhpStructValue::getIndex()
• uses: WsdlToPhpModel::getOwner()
• uses: WsdlToPhpGenerator::getOptionGenericConstantsNames()
• uses: WsdlToPhpModel::getCleanName()
• uses: WsdlToPhpModel::getName()
• uses: WsdlToPhpStructValue::constantSuffix()

string getCleanName ([bool $_keepMultipleUnderscores = false])

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

---

Redefinition of:

WsdlToPhpModel::getCleanName()

Returns a valid clean name for PHP

getComment (line 97)

Returns the comment lines for this value

• see: WsdlToPhpModel::getComment()
• access: public
• usedby: WsdlToPhpStruct::getClassBody()
• uses: WsdlToPhpStructValue::getValue()
• uses: WsdlToPhpModel::addMetaComment()

array getComment ()

---

Redefinition of:

WsdlToPhpModel::getComment()

Returns comments for the element

getDeclaration (line 114)

Returns the declaration of the value

• see: WsdlToPhpStructValue::getCleanName()
• see: WsdlToPhpStructValue::getValue()
• access: public
• usedby: WsdlToPhpStruct::getClassBody()

string getDeclaration (string $_structName, [int $_index = -1])

• string $_structName: the name of the struct which the value belongs to
• int $_index: the index of the constant contained by the struct class

getIndex (line 77)

Gets the index attribute value

• access: public
• usedby: WsdlToPhpStructValue::getCleanName()

int getIndex ()

getOwner (line 145)

Returns the owner model object, meaning a WsdlToPhpStruct object

• see: WsdlToPhpModel::getOwner()
• access: public
• usedby: WsdlToPhpStructValue::getCleanName()
• uses: WsdlToPhpModel::getOwner()

WsdlToPhpStruct getOwner ()

---

Redefinition of:

WsdlToPhpModel::getOwner()

Returns the owner model object

getValue (line 69)

Returns the value with good type

• access: public
• usedby: WsdlToPhpStructValue::getComment()
• uses: WsdlToPhpModel::getValueWithinItsType()
• uses: WsdlToPhpModel::getName()

mixed getValue ()

setIndex (line 86)

Sets the index attribute value

• access: public
• usedby: WsdlToPhpStructValue::__construct()

int setIndex (int $_index)

• int $_index

__toString (line 153)

Returns class name

• return: __CLASS__
• access: public

string __toString ()

---

Redefinition of:

WsdlToPhpModel::__toString()

Returns class name

Inherited Methods

Inherited From WsdlToPhpModel

WsdlToPhpModel::__construct()
WsdlToPhpModel::addMeta()
WsdlToPhpModel::addMetaComment()
WsdlToPhpModel::cleanComment()
WsdlToPhpModel::cleanString()
WsdlToPhpModel::getClassBody()
WsdlToPhpModel::getClassComment()
WsdlToPhpModel::getClassDeclaration()
WsdlToPhpModel::getCleanName()
WsdlToPhpModel::getComment()
WsdlToPhpModel::getContextualPart()
WsdlToPhpModel::getDocSubPackages()
WsdlToPhpModel::getDocumentation()
WsdlToPhpModel::getFileComment()
WsdlToPhpModel::getFromSchema()
WsdlToPhpModel::getGenericWsdlClassName()
WsdlToPhpModel::getInheritance()
WsdlToPhpModel::getMeta()
WsdlToPhpModel::getMetaValue()
WsdlToPhpModel::getMetaValueFirstSet()
WsdlToPhpModel::getModelByName()
WsdlToPhpModel::getModels()
WsdlToPhpModel::getName()
WsdlToPhpModel::getOwner()
WsdlToPhpModel::getPackagedName()
WsdlToPhpModel::getValueWithinItsType()
WsdlToPhpModel::nameIsClean()
WsdlToPhpModel::replaceReservedPhpKeyword()
WsdlToPhpModel::setDocumentation()
WsdlToPhpModel::setFromSchema()
WsdlToPhpModel::setInheritance()
WsdlToPhpModel::setMeta()
WsdlToPhpModel::setName()
WsdlToPhpModel::setOwner()
WsdlToPhpModel::uniqueName()
WsdlToPhpModel::updateModels()
WsdlToPhpModel::__toString()

Inherited Constants

Inherited from WsdlToPhpModel

WsdlToPhpModel::META_DOCUMENTATION
WsdlToPhpModel::META_FROM_SCHEMA