Docs For Class WsdlToPhpStruct

WsdlToPhpStruct

Description

Class WsdlToPhpStruct stands for an available struct described in the WSDL

Located in /WsdlToPhpStruct.php (line 12)

WsdlToPhpModel
   |
   --WsdlToPhpStruct

Variable Summary

array $attributes

bool $isRestriction

bool $isStruct

array $values

Method Summary

WsdlToPhpStruct __construct (string $_name, [bool $_isStruct = true])

WsdlToPhpStructAttribute addAttribute (string $_attributeName, string $_attributeType)

void addValue (mixed $_value)

int countOwnAttributes ()

WsdlToPhpStructAttribute|null getAttribute (string $_attributeName)

array getAttributes ([bool $_includeInheritanceAttributes = false], [bool $_requiredFirst = false])

array getClassBody ( &$_body, array $_body)

string getContextualPart ()

array getDocSubPackages ()

bool getIsRestriction ()

bool getIsStruct ()

WsdlToPhpStructValue|null getValue (string $_value)

array getValues ()

bool isArray ()

array setAttributes ([array $_attributes = array()])

bool setIsRestriction ([bool $_isRestriction = true])

bool setIsStruct ([bool $_isStruct = true])

array setValues ([array $_values = array()])

string __toString ()

Variables

array $attributes = array() (line 18)

Attributes of the struct

access: private

bool $isRestriction = false (line 23)

Is the struct a restriction with defined values ?

access: private

bool $isStruct = false (line 33)

Define if the urrent struct is a concrete struct or just a virtual struct to store meta informations

access: private

array $values = array() (line 28)

If the struct is a restriction with values, then store values

access: private

Inherited Variables

Inherited from WsdlToPhpModel

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

Methods

Constructor __construct (line 42)

Main constructor

WsdlToPhpStruct __construct (string $_name, [bool $_isStruct = true])

string $_name: the original name
bool $_isStruct: defines if it's a real sruct or not

Redefinition of:

WsdlToPhpModel::__construct(): Main constructor

addAttribute (line 491)

Adds attribute based on its original name

WsdlToPhpStructAttribute addAttribute (string $_attributeName, string $_attributeType)

string $_attributeName: the attribute name
string $_attributeType: the attribute type

addValue (line 574)

Adds value to values array

access: public
usedby: WsdlToPhpGenerator::addRestrictionValue()
uses: WsdlToPhpStruct::getValues()
uses: WsdlToPhpStruct::getValue()
uses: WsdlToPhpModel::updateModels()

void addValue (mixed $_value)

mixed $_value: the original value

countOwnAttributes (line 471)

Returns the number of own attributes

int countOwnAttributes ()

getAttribute (line 503)

Returns the attribute by its name, otherwise null

access: public
usedby: WsdlToPhpGenerator::getStructAttribute()
uses: WsdlToPhpStruct::getAttributes()

WsdlToPhpStructAttribute|null getAttribute (string $_attributeName)

string $_attributeName: the original attribute name

getAttributes (line 406)

Returns the attributes of the struct and potentially from the parent class

access: public
usedby: WsdlToPhpStruct::countOwnAttributes()
usedby: WsdlToPhpStruct::getAttribute()
usedby: WsdlToPhpFunction::getComment()
usedby: WsdlToPhpFunction::getBody()
usedby: WsdlToPhpStruct::getAttributes()
usedby: WsdlToPhpStruct::getClassBody()
uses: WsdlToPhpModel::getModelByName()
uses: WsdlToPhpStruct::getAttributes()
uses: WsdlToPhpStruct::getIsStruct()
uses: WsdlToPhpModel::getInheritance()

array getAttributes ([bool $_includeInheritanceAttributes = false], [bool $_requiredFirst = false])

bool $_includeInheritanceAttributes: include the attributes of parent class, default parent attributes are not included. If true, then the array is an associative array containing and index "attribute" for the WsdlToPhpStructAttribute object and an index "model" for the WsdlToPhpStruct object.
bool $_requiredFirst: places the required attributes first, then the not required in order to have the _contrust method with the required attribute at first

getClassBody (line 75)

Returns the constructor method

access: public
uses: WsdlToPhpStructAttribute::getGetterDeclaration()
uses: WsdlToPhpStructAttribute::getDefaultValue()
uses: WsdlToPhpStructAttribute::getComment()
uses: WsdlToPhpStructAttribute::getSetterDeclaration()
uses: WsdlToPhpStructAttribute::getDeclaration()
uses: WsdlToPhpStructAttribute::isRequired()
uses: WsdlToPhpStructValue::getDeclaration()
uses: WsdlToPhpStructValue::getComment()
uses: WsdlToPhpStructValue::getCleanName()
uses: WsdlToPhpStruct::isArray()
uses: WsdlToPhpStructAttribute::getType()
uses: WsdlToPhpStruct::getValues()
uses: WsdlToPhpModel::getInheritance()
uses: WsdlToPhpModel::getGenericWsdlClassName()
uses: WsdlToPhpModel::getCleanName()
uses: WsdlToPhpGenerator::getPackageName()
uses: WsdlToPhpModel::getModelByName()
uses: WsdlToPhpModel::getName()
uses: WsdlToPhpStruct::getIsStruct()
uses: WsdlToPhpStruct::getIsRestriction()
uses: WsdlToPhpStruct::getAttributes()
uses: WsdlToPhpModel::getPackagedName()
uses: WsdlToPhpGenerator::getOptionGenerateWsdlClassFile()

array getClassBody ( &$_body, array $_body)

array $_body: the body which will be populated
&$_body

Redefinition of:

WsdlToPhpModel::getClassBody(): Methods which fills the class body

getContextualPart (line 370)

Returns the contextual part of the class name for the package

see: WsdlToPhpModel::getContextualPart()
access: public
usedby: WsdlToPhpService::getClassBody()
uses: WsdlToPhpStruct::getIsRestriction()

string getContextualPart ()

Redefinition of:

WsdlToPhpModel::getContextualPart(): Allows to define the contextual part of the class name for the package

getDocSubPackages (line 381)

Returns the sub package name which the model belongs to

Must be overridden by sub classes

see: WsdlToPhpModel::getDocSubPackages()
access: public
uses: WsdlToPhpStruct::getIsRestriction()

array getDocSubPackages ()

Redefinition of:

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

getIsRestriction (line 511)

Returns the isRestriction value

access: public
usedby: WsdlToPhpFunction::getComment()
usedby: WsdlToPhpGenerator::manageWsdlNodeUnion()
usedby: WsdlToPhpStruct::getDocSubPackages()
usedby: WsdlToPhpStruct::getContextualPart()
usedby: WsdlToPhpStructAttribute::getSetterDeclaration()
usedby: WsdlToPhpStruct::getClassBody()

bool getIsRestriction ()

getIsStruct (line 531)

Returns the isStruct value

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

bool getIsStruct ()

getValue (line 587)

Gets the value object for the given value

access: public
usedby: WsdlToPhpGenerator::getStructValue()
usedby: WsdlToPhpStruct::addValue()
uses: WsdlToPhpModel::getName()
uses: WsdlToPhpStruct::getValues()

WsdlToPhpStructValue|null getValue (string $_value)

string $_value: Value name

getValues (line 551)

Returns the values for an enumeration

array getValues ()

isArray (line 392)

Returns true if the current struct is a collection of values (like an array)

access: public
usedby: WsdlToPhpStruct::getClassBody()
usedby: WsdlToPhpStructAttribute::getSetterDeclaration()
uses: WsdlToPhpModel::getName()
uses: WsdlToPhpStruct::countOwnAttributes()

bool isArray ()

setAttributes (line 480)

Sets the attributes of the struct

access: public

array setAttributes ([array $_attributes = array()])

array $_attributes

setIsRestriction (line 521)

Sets the isRestriction value

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

bool setIsRestriction ([bool $_isRestriction = true])

bool $_isRestriction

setIsStruct (line 541)

Sets the isStruct value

access: public
usedby: WsdlToPhpGenerator::setStructIsStruct()
usedby: WsdlToPhpStruct::__construct()
uses: WsdlToPhpModel::updateModels()

bool setIsStruct ([bool $_isStruct = true])

bool $_isStruct

setValues (line 561)

Sets the values for an enumeration

access: private
uses: WsdlToPhpModel::updateModels()

array setValues ([array $_values = array()])

array $_values

__toString (line 600)

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()

Class Constants

Inherited Constants

Inherited from WsdlToPhpModel

WsdlToPhpModel::META_DOCUMENTATION
WsdlToPhpModel::META_FROM_SCHEMA

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