1. class
  2. WsdlToPhp
  3. \
  4. PackageGenerator
  5. \
  6. File
  7. \
  8. Struct

Struct

class Struct extends AbstractModelFile (View source)

Constants

PHP_FILE_EXTENSION

ANNOTATION_META_LENGTH

ANNOTATION_LONG_LENGTH

ANNOTATION_PACKAGE

ANNOTATION_SUB_PACKAGE

ANNOTATION_RETURN

ANNOTATION_USES

ANNOTATION_PARAM

ANNOTATION_VAR

ANNOTATION_SEE

ANNOTATION_THROWS

METHOD_CONSTRUCT

METHOD_SET_STATE

TYPE_STRING

TYPE_ARRAY

Properties

protected Generator $generator from AbstractFile
protected PhpFile $file from AbstractFile
protected Method $methods from AbstractModelFile

Methods

__construct(Generator $generator, string $name)

No description

from AbstractFile
AbstractFile
setGenerator(Generator $generator)

No description

from AbstractFile
Generator
getGenerator()

No description

from AbstractFile
void
write()

No description

from AbstractFile
int|bool
writeFile(bool $withSrc = true)

No description

from AbstractModelFile
string
getFileName()

No description

from AbstractFile
string
getFileDestination(bool $withSrc = true)

No description

from AbstractModelFile
string
getFileExtension()

No description

from AbstractFile
AbstractFile
setFile(PhpFile $file)

No description

from AbstractFile
PhpFile
getFile()

No description

from AbstractFile
string
getDestinationFolder(bool $withSrc = true)

No description

from AbstractModelFile
AbstractModelFile
addAnnotationBlock()

No description

from AbstractModelFile
AbstractModelFile
setModel(AbstractModel $model)

No description

AbstractModel
getModel()

No description

Struct|null
getModelByName(string $name)

No description

from AbstractModelFile
AbstractModelFile
definePackageAnnotations(PhpAnnotationBlock $block)

No description

from AbstractModelFile
string
getPackageName()

No description

from AbstractModelFile
AbstractModelFile
defineGeneralAnnotations(PhpAnnotationBlock $block)

No description

from AbstractModelFile
PhpAnnotationBlock
getClassAnnotationBlock()

No description

from AbstractModelFile
string
getClassDeclarationLine()

No description

from AbstractModelFile
string
getClassDeclarationLineText()

No description

from AbstractModelFile
AbstractModelFile
defineModelAnnotationsFromWsdl(PhpAnnotationBlock $block, AbstractModel $model = null)

No description

from AbstractModelFile
AbstractModelFile
addClassElement()

No description

from AbstractModelFile
AbstractModelFile
defineNamespace()

No description

from AbstractModelFile
AbstractModelFile
defineUseStatement()

No description

from AbstractModelFile
AbstractModelFile
defineConstants(PhpClass $class)

No description

from AbstractModelFile
AbstractModelFile
defineProperties(PhpClass $class)

No description

from AbstractModelFile
AbstractModelFile
defineMethods(PhpClass $class)

No description

from AbstractModelFile
getClassConstants(Constant $constants)

No description

PhpAnnotationBlock|null
getConstantAnnotationBlock(PhpConstant $constant)

No description

getClassProperties(Property $properties)

No description

PhpAnnotationBlock|null
getPropertyAnnotationBlock(PhpProperty $property)

No description

void
fillClassMethods()

This method is responsible for filling in the $methods property with appropriate methods for the current model

PhpAnnotationBlock|null
getMethodAnnotationBlock(PhpMethod $method)

No description

AbstractModelFile
defineStringMethod(PhpClass $class)

No description

from AbstractModelFile
PhpAnnotationBlock
getToStringMethodAnnotationBlock()

No description

from AbstractModelFile
PhpMethod
getToStringMethod()

No description

from AbstractModelFile
StructAttribute
getStructAttribute(StructAttribute $attribute = null)

No description

from AbstractModelFile
Struct|null
getModelFromStructAttribute(StructAttribute $attribute = null)

No description

from AbstractModelFile
Struct|null
getRestrictionFromStructAttribute(StructAttribute $attribute = null)

No description

from AbstractModelFile
bool
isAttributeAList(StructAttribute $attribute = null)

No description

from AbstractModelFile
string
getStructAttributeType(StructAttribute $attribute = null, bool $namespaced = false)

No description

from AbstractModelFile
string
getStructAttributeTypeGetAnnotation(StructAttribute $attribute = null, bool $returnArrayType = true)

No description

from AbstractModelFile
string
getStructAttributeTypeSetAnnotation(StructAttribute $attribute = null, bool $returnArrayType = true)

No description

from AbstractModelFile
bool
useBrackets(StructAttribute $attribute, bool $returnArrayType = true)

No description

from AbstractModelFile
string
getStructAttributeTypeHint(StructAttribute $attribute = null, bool $returnArrayType = true)

No description

from AbstractModelFile
string
getStructAttributeTypeAsPhpType(StructAttribute $attribute = null)

No description

from AbstractModelFile
static mixed
getValidType($type, $xsdTypesPath = null, $fallback = null)

See http://php.net/manual/fr/language.oop5.typehinting.php for these cases Also see http://www.w3schools.com/schema/schema_dtypes_numeric.asp

from AbstractModelFile
static mixed
getPhpType($type, $xsdTypesPath = null, $fallback = self::TYPE_STRING)

See http://php.net/manual/fr/language.oop5.typehinting.php for these cases Also see http://www.w3schools.com/schema/schema_dtypes_numeric.asp

from AbstractModelFile
StructAttribute
getModelAttributes(bool $includeInheritanceAttributes = false, bool $requiredFirst = true)

No description

Struct
addStructMethodConstruct()

No description

Struct
addStructMethodConstructBody(PhpMethod $method)

No description

Struct
addStructMethodConstructBodyForAttribute(PhpMethod $method, StructAttribute $attribute, bool $isLast)

No description

PhpFunctionParameter[]
getStructMethodParametersValues()

No description

PhpFunctionParameter
getStructMethodParameter(StructAttribute $attribute, bool $lowCaseFirstLetter = false, mixed $defaultValue = null)

No description

string|null
getStructMethodParameterType(StructAttribute $attribute, bool $returnArrayType = true)

No description

Struct
addStructMethodsSetAndGet()

No description

Struct
addStructMethodAddTo(StructAttribute $attribute)

No description

Struct
addStructMethodAddToBody(PhpMethod $method, StructAttribute $attribute)

No description

Struct
addStructMethodSet(StructAttribute $attribute)

No description

Struct
addStructMethodSetBody(PhpMethod $method, StructAttribute $attribute)

No description

Struct
addStructMethodSetBodyAssignment(PhpMethod $method, StructAttribute $attribute)

No description

Struct
addStructMethodSetBodyReturn(PhpMethod $method)

No description

string
getStructMethodSetBodyAssignment(StructAttribute $attribute, string $parameterName)

No description

Struct
addStructMethodGetBody(PhpMethod $method, StructAttribute $attribute, string $thisAccess)

No description

Struct
addStructMethodGetBodyReturn(PhpMethod $method, StructAttribute $attribute, string $thisAccess)

No description

Struct
addStructMethodGet(StructAttribute $attribute)

No description

PhpFunctionParameter[]
getStructMethodGetParameters(StructAttribute $attribute)

No description

Struct
addStructMethodSetState()

No description

PhpAnnotationBlock|null
getStructMethodAnnotationBlock(PhpMethod $method)

No description

PhpAnnotationBlock
getStructMethodConstructAnnotationBlock()

No description

PhpAnnotationBlock
getStructMethodSetStateAnnotationBlock()

No description

PhpAnnotationBlock
getStructMethodsSetAndGetAnnotationBlock(PhpMethod $method)

No description

Struct
addStructMethodsSetAndGetAnnotationBlockFromStructAttribute(string $setOrGet, PhpAnnotationBlock $annotationBlock, StructAttribute $attribute)

No description

Struct
addStructMethodsSetAndGetAnnotationBlockFromScalar(string $setOrGet, PhpAnnotationBlock $annotationBlock, string $attributeName)

No description

Struct
addStructMethodsSetAnnotationBlock(PhpAnnotationBlock $annotationBlock, string $type, string $name)

No description

Struct
addStructMethodsGetAnnotationBlock(PhpAnnotationBlock $annotationBlock, string $attributeType)

No description

Struct
addStructMethodsGetAnnotationBlockFromXmlAttribute(PhpAnnotationBlock $annotationBlock, StructAttribute $attribute)

No description

Struct
addStructPropertiesToAnnotationBlock(PhpAnnotationBlock $annotationBlock)

No description

Struct
addStructPropertiesToAnnotationBlockUses(PhpAnnotationBlock $annotationBlock)

No description

Struct
addStructPropertiesToAnnotationBlockParams(PhpAnnotationBlock $annotationBlock)

No description

PhpAnnotationBlock
getStructMethodsAddToAnnotationBlock(PhpMethod $method)

No description

PhpAnnotationBlock
getStructMethodsValidateArrayAnnotationBlock(PhpMethod $method)

No description

PhpAnnotationBlock
getStructMethodsValidateUnionAnnotationBlock(PhpMethod $method)

No description

PhpAnnotationBlock
getStructMethodsValidateChoiceAnnotationBlock(PhpMethod $method)

No description

PhpAnnotationBlock
getStructMethodsValidateLengthAnnotationBlock(PhpMethod $method, string $type = '')

No description

applyRules(PhpMethod $method, StructAttribute $attribute, $parameterName, bool $itemType = false)

No description

Details

in AbstractFile at line 26
__construct(Generator $generator, string $name)

Parameters

Generator $generator
string $name

in AbstractFile at line 34
AbstractFile setGenerator(Generator $generator)

Parameters

Generator $generator

Return Value

AbstractFile

in AbstractFile at line 42
Generator getGenerator()

Return Value

Generator

in AbstractFile at line 49
void write()

Return Value

void

in AbstractModelFile at line 109
int|bool writeFile(bool $withSrc = true)

Parameters

bool $withSrc

Return Value

int|bool

See also

\WsdlToPhp\PackageGenerator\File\AbstractFile::writeFile()

in AbstractFile at line 63
string getFileName()

Return Value

string

in AbstractModelFile at line 91
string getFileDestination(bool $withSrc = true)

Parameters

bool $withSrc

Return Value

string

in AbstractFile at line 77
string getFileExtension()

Return Value

string

in AbstractFile at line 85
protected AbstractFile setFile(PhpFile $file)

Parameters

PhpFile $file

Return Value

AbstractFile

in AbstractFile at line 93
PhpFile getFile()

Return Value

PhpFile

in AbstractModelFile at line 99
string getDestinationFolder(bool $withSrc = true)

Parameters

bool $withSrc

Return Value

string

in AbstractModelFile at line 121
protected AbstractModelFile addAnnotationBlock()

Return Value

AbstractModelFile

at line 692
AbstractModelFile setModel(AbstractModel $model)

Parameters

AbstractModel $model

Return Value

AbstractModelFile

Exceptions

InvalidArgumentException

See also

\WsdlToPhp\PackageGenerator\File\AbstractModelFile::setModel()

at line 682
AbstractModel getModel()

Return Value

AbstractModel

See also

\WsdlToPhp\PackageGenerator\File\AbstractModelFile::getModel()

in AbstractModelFile at line 147
protected Struct|null getModelByName(string $name)

Parameters

string $name

Return Value

Struct|null

in AbstractModelFile at line 155
protected AbstractModelFile definePackageAnnotations(PhpAnnotationBlock $block)

Parameters

PhpAnnotationBlock $block

Return Value

AbstractModelFile

in AbstractModelFile at line 169
protected string getPackageName()

Return Value

string

in AbstractModelFile at line 183
protected AbstractModelFile defineGeneralAnnotations(PhpAnnotationBlock $block)

Parameters

PhpAnnotationBlock $block

Return Value

AbstractModelFile

in AbstractModelFile at line 193
protected PhpAnnotationBlock getClassAnnotationBlock()

Return Value

PhpAnnotationBlock

in AbstractModelFile at line 203
protected string getClassDeclarationLine()

Return Value

string

in AbstractModelFile at line 210
protected string getClassDeclarationLineText()

Return Value

string

in AbstractModelFile at line 219
protected AbstractModelFile defineModelAnnotationsFromWsdl(PhpAnnotationBlock $block, AbstractModel $model = null)

Parameters

PhpAnnotationBlock $block
AbstractModel $model

Return Value

AbstractModelFile

in AbstractModelFile at line 227
protected AbstractModelFile addClassElement()

Return Value

AbstractModelFile

in AbstractModelFile at line 241
protected AbstractModelFile defineNamespace()

Return Value

AbstractModelFile

in AbstractModelFile at line 251
protected AbstractModelFile defineUseStatement()

Return Value

AbstractModelFile

in AbstractModelFile at line 262
protected AbstractModelFile defineConstants(PhpClass $class)

Parameters

PhpClass $class

Return Value

AbstractModelFile

in AbstractModelFile at line 279
protected AbstractModelFile defineProperties(PhpClass $class)

Parameters

PhpClass $class

Return Value

AbstractModelFile

in AbstractModelFile at line 296
protected AbstractModelFile defineMethods(PhpClass $class)

Parameters

PhpClass $class

Return Value

AbstractModelFile

at line 24
protected getClassConstants(Constant $constants)

Parameters

Constant $constants

See also

\WsdlToPhp\PackageGenerator\File\AbstractModelFile::getClassConstants()

at line 30
protected PhpAnnotationBlock|null getConstantAnnotationBlock(PhpConstant $constant)

Parameters

PhpConstant $constant

Return Value

PhpAnnotationBlock|null

See also

\WsdlToPhp\PackageGenerator\File\AbstractModelFile::getConstantAnnotationBlock()

at line 45
protected getClassProperties(Property $properties)

Parameters

Property $properties

at line 56
protected PhpAnnotationBlock|null getPropertyAnnotationBlock(PhpProperty $property)

Parameters

PhpProperty $property

Return Value

PhpAnnotationBlock|null

at line 70
protected void fillClassMethods()

This method is responsible for filling in the $methods property with appropriate methods for the current model

Return Value

void

at line 350
protected PhpAnnotationBlock|null getMethodAnnotationBlock(PhpMethod $method)

Parameters

PhpMethod $method

Return Value

PhpAnnotationBlock|null

in AbstractModelFile at line 341
protected AbstractModelFile defineStringMethod(PhpClass $class)

Parameters

PhpClass $class

Return Value

AbstractModelFile

in AbstractModelFile at line 350
protected PhpAnnotationBlock getToStringMethodAnnotationBlock()

Return Value

PhpAnnotationBlock

in AbstractModelFile at line 360
protected PhpMethod getToStringMethod()

Return Value

PhpMethod

in AbstractModelFile at line 370
protected StructAttribute getStructAttribute(StructAttribute $attribute = null)

Parameters

StructAttribute $attribute

Return Value

StructAttribute

in AbstractModelFile at line 382
Struct|null getModelFromStructAttribute(StructAttribute $attribute = null)

Parameters

StructAttribute $attribute

Return Value

Struct|null

in AbstractModelFile at line 390
Struct|null getRestrictionFromStructAttribute(StructAttribute $attribute = null)

Parameters

StructAttribute $attribute

Return Value

Struct|null

in AbstractModelFile at line 412
bool isAttributeAList(StructAttribute $attribute = null)

Parameters

StructAttribute $attribute

Return Value

bool

in AbstractModelFile at line 421
string getStructAttributeType(StructAttribute $attribute = null, bool $namespaced = false)

Parameters

StructAttribute $attribute
bool $namespaced

Return Value

string

in AbstractModelFile at line 455
protected string getStructAttributeTypeGetAnnotation(StructAttribute $attribute = null, bool $returnArrayType = true)

Parameters

StructAttribute $attribute
bool $returnArrayType

Return Value

string

in AbstractModelFile at line 465
protected string getStructAttributeTypeSetAnnotation(StructAttribute $attribute = null, bool $returnArrayType = true)

Parameters

StructAttribute $attribute
bool $returnArrayType

Return Value

string

in AbstractModelFile at line 475
protected bool useBrackets(StructAttribute $attribute, bool $returnArrayType = true)

Parameters

StructAttribute $attribute
bool $returnArrayType

Return Value

bool

in AbstractModelFile at line 484
protected string getStructAttributeTypeHint(StructAttribute $attribute = null, bool $returnArrayType = true)

Parameters

StructAttribute $attribute
bool $returnArrayType

Return Value

string

in AbstractModelFile at line 493
string getStructAttributeTypeAsPhpType(StructAttribute $attribute = null)

Parameters

StructAttribute $attribute

Return Value

string

in AbstractModelFile at line 509
static mixed getValidType($type, $xsdTypesPath = null, $fallback = null)

See http://php.net/manual/fr/language.oop5.typehinting.php for these cases Also see http://www.w3schools.com/schema/schema_dtypes_numeric.asp

Parameters

$type
$xsdTypesPath
$fallback

Return Value

mixed

in AbstractModelFile at line 520
static mixed getPhpType($type, $xsdTypesPath = null, $fallback = self::TYPE_STRING)

See http://php.net/manual/fr/language.oop5.typehinting.php for these cases Also see http://www.w3schools.com/schema/schema_dtypes_numeric.asp

Parameters

$type
$xsdTypesPath
$fallback

Return Value

mixed

at line 38
protected StructAttribute getModelAttributes(bool $includeInheritanceAttributes = false, bool $requiredFirst = true)

Parameters

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 StructAttribute object and an index "model" for the Struct 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

Return Value

StructAttribute

at line 80
protected Struct addStructMethodConstruct()

Return Value

Struct

at line 91
protected Struct addStructMethodConstructBody(PhpMethod $method)

Parameters

PhpMethod $method

Return Value

Struct

at line 108
protected Struct addStructMethodConstructBodyForAttribute(PhpMethod $method, StructAttribute $attribute, bool $isLast)

Parameters

PhpMethod $method
StructAttribute $attribute
bool $isLast

Return Value

Struct

at line 117
protected PhpFunctionParameter[] getStructMethodParametersValues()

Return Value

PhpFunctionParameter[]

at line 131
protected PhpFunctionParameter getStructMethodParameter(StructAttribute $attribute, bool $lowCaseFirstLetter = false, mixed $defaultValue = null)

Parameters

StructAttribute $attribute
bool $lowCaseFirstLetter
mixed $defaultValue

Return Value

PhpFunctionParameter

at line 145
protected string|null getStructMethodParameterType(StructAttribute $attribute, bool $returnArrayType = true)

Parameters

StructAttribute $attribute
bool $returnArrayType

Return Value

string|null

at line 152
protected Struct addStructMethodsSetAndGet()

Return Value

Struct

at line 166
protected Struct addStructMethodAddTo(StructAttribute $attribute)

Parameters

StructAttribute $attribute

Return Value

Struct

at line 182
protected Struct addStructMethodAddToBody(PhpMethod $method, StructAttribute $attribute)

Parameters

PhpMethod $method
StructAttribute $attribute

Return Value

Struct

at line 196
protected Struct addStructMethodSet(StructAttribute $attribute)

Parameters

StructAttribute $attribute

Return Value

Struct

at line 210
protected Struct addStructMethodSetBody(PhpMethod $method, StructAttribute $attribute)

Parameters

PhpMethod $method
StructAttribute $attribute

Return Value

Struct

at line 223
protected Struct addStructMethodSetBodyAssignment(PhpMethod $method, StructAttribute $attribute)

Parameters

PhpMethod $method
StructAttribute $attribute

Return Value

Struct

at line 243
protected Struct addStructMethodSetBodyReturn(PhpMethod $method)

Parameters

PhpMethod $method

Return Value

Struct

at line 253
protected string getStructMethodSetBodyAssignment(StructAttribute $attribute, string $parameterName)

Parameters

StructAttribute $attribute
string $parameterName

Return Value

string

at line 276
protected Struct addStructMethodGetBody(PhpMethod $method, StructAttribute $attribute, string $thisAccess)

Parameters

PhpMethod $method
StructAttribute $attribute
string $thisAccess

Return Value

Struct

at line 286
protected Struct addStructMethodGetBodyReturn(PhpMethod $method, StructAttribute $attribute, string $thisAccess)

Parameters

PhpMethod $method
StructAttribute $attribute
string $thisAccess

Return Value

Struct

at line 311
protected Struct addStructMethodGet(StructAttribute $attribute)

Parameters

StructAttribute $attribute

Return Value

Struct

at line 327
protected PhpFunctionParameter[] getStructMethodGetParameters(StructAttribute $attribute)

Parameters

StructAttribute $attribute

Return Value

PhpFunctionParameter[]

at line 338
protected Struct addStructMethodSetState()

Return Value

Struct

at line 358
protected PhpAnnotationBlock|null getStructMethodAnnotationBlock(PhpMethod $method)

Parameters

PhpMethod $method

Return Value

PhpAnnotationBlock|null

at line 399
protected PhpAnnotationBlock getStructMethodConstructAnnotationBlock()

Return Value

PhpAnnotationBlock

at line 410
protected PhpAnnotationBlock getStructMethodSetStateAnnotationBlock()

Return Value

PhpAnnotationBlock

at line 425
protected PhpAnnotationBlock getStructMethodsSetAndGetAnnotationBlock(PhpMethod $method)

Parameters

PhpMethod $method

Return Value

PhpAnnotationBlock

at line 470
protected Struct addStructMethodsSetAndGetAnnotationBlockFromStructAttribute(string $setOrGet, PhpAnnotationBlock $annotationBlock, StructAttribute $attribute)

Parameters

string $setOrGet
PhpAnnotationBlock $annotationBlock
StructAttribute $attribute

Return Value

Struct

at line 518
protected Struct addStructMethodsSetAndGetAnnotationBlockFromScalar(string $setOrGet, PhpAnnotationBlock $annotationBlock, string $attributeName)

Parameters

string $setOrGet
PhpAnnotationBlock $annotationBlock
string $attributeName

Return Value

Struct

at line 536
protected Struct addStructMethodsSetAnnotationBlock(PhpAnnotationBlock $annotationBlock, string $type, string $name)

Parameters

PhpAnnotationBlock $annotationBlock
string $type
string $name

Return Value

Struct

at line 546
protected Struct addStructMethodsGetAnnotationBlock(PhpAnnotationBlock $annotationBlock, string $attributeType)

Parameters

PhpAnnotationBlock $annotationBlock
string $attributeType

Return Value

Struct

at line 556
protected Struct addStructMethodsGetAnnotationBlockFromXmlAttribute(PhpAnnotationBlock $annotationBlock, StructAttribute $attribute)

Parameters

PhpAnnotationBlock $annotationBlock
StructAttribute $attribute

Return Value

Struct

at line 569
protected Struct addStructPropertiesToAnnotationBlock(PhpAnnotationBlock $annotationBlock)

Parameters

PhpAnnotationBlock $annotationBlock

Return Value

Struct

at line 577
protected Struct addStructPropertiesToAnnotationBlockUses(PhpAnnotationBlock $annotationBlock)

Parameters

PhpAnnotationBlock $annotationBlock

Return Value

Struct

at line 588
protected Struct addStructPropertiesToAnnotationBlockParams(PhpAnnotationBlock $annotationBlock)

Parameters

PhpAnnotationBlock $annotationBlock

Return Value

Struct

at line 599
protected PhpAnnotationBlock getStructMethodsAddToAnnotationBlock(PhpMethod $method)

Parameters

PhpMethod $method

Return Value

PhpAnnotationBlock

at line 621
protected PhpAnnotationBlock getStructMethodsValidateArrayAnnotationBlock(PhpMethod $method)

Parameters

PhpMethod $method

Return Value

PhpAnnotationBlock

at line 635
protected PhpAnnotationBlock getStructMethodsValidateUnionAnnotationBlock(PhpMethod $method)

Parameters

PhpMethod $method

Return Value

PhpAnnotationBlock

at line 650
protected PhpAnnotationBlock getStructMethodsValidateChoiceAnnotationBlock(PhpMethod $method)

Parameters

PhpMethod $method

Return Value

PhpAnnotationBlock

at line 666
protected PhpAnnotationBlock getStructMethodsValidateLengthAnnotationBlock(PhpMethod $method, string $type = '')

Parameters

PhpMethod $method
string $type

Return Value

PhpAnnotationBlock

at line 705
protected applyRules(PhpMethod $method, StructAttribute $attribute, $parameterName, bool $itemType = false)

Parameters

PhpMethod $method
StructAttribute $attribute
$parameterName
bool $itemType