PHP Класс WsdlToPhp\PackageGenerator\Model\Struct

Наследование: extends AbstractModel
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
__construct ( Generator $generator, string $name, boolean $isStruct = true, boolean $isRestriction = false ) Main constructor
addAttribute ( string $attributeName, string $attributeType ) : Struct Adds attribute based on its original name
addValue ( mixed $value ) : Struct Adds value to values array
countOwnAttributes ( ) : integer Returns the number of own attributes
getAttribute ( string $attributeName ) : StructAttribute | null Returns the attribute by its name, otherwise null
getAttributes ( boolean $includeInheritanceAttributes = false, boolean $requiredFirst = false ) : StructAttribute Returns the attributes of the struct and potentially from the parent class
getContextualPart ( ) : string Returns the contextual part of the class name for the package
getDocSubPackages ( ) : array Returns the sub package name which the model belongs to Must be overridden by sub classes
getExtends ( boolean $short = false ) : string Allows to define from which class the curent model extends
getInheritanceStruct ( ) : Struct | null
getIsRestriction ( ) : boolean Returns the isRestriction value
getIsStruct ( ) : boolean Returns the isStruct value
getMeta ( ) : string[]
getReservedMethodsInstance ( $filename = null ) : StructReservedMethod | StructArrayReservedMethod
getTopInheritance ( ) : Struct | null
getValue ( string $value ) : StructValue | null Gets the value object for the given value
getValues ( ) : StructValue Returns the values for an enumeration
isArray ( ) : boolean Returns true if the current struct is a collection of values (like an array)
setAttributes ( StructAttribute $structAttributeContainer ) : Struct Sets the attributes of the struct
setIsRestriction ( boolean $isRestriction = true ) : Struct Sets the isRestriction value
setIsStruct ( boolean $isStruct = true ) : Struct Sets the isStruct value

Защищенные методы

Метод Описание
addInheritanceAttributes ( StructAttribute $attributes )
getAllAttributes ( boolean $includeInheritanceAttributes, boolean $requiredFirst ) : StructAttribute
putRequiredFirst ( StructAttribute $allAttributes ) : StructAttribute

Приватные методы

Метод Описание
setValues ( StructValue $structValueContainer ) : Struct Sets the values for an enumeration

Описание методов

__construct() публичный Метод

Main constructor
См. также: AbstractModel::__construct()
public __construct ( Generator $generator, string $name, boolean $isStruct = true, boolean $isRestriction = false )
$generator WsdlToPhp\PackageGenerator\Generator\Generator
$name string the original name
$isStruct boolean defines if it's a real sruct or not
$isRestriction boolean defines if it's an enumeration or not

addAttribute() публичный Метод

Adds attribute based on its original name
public addAttribute ( string $attributeName, string $attributeType ) : Struct
$attributeName string the attribute name
$attributeType string the attribute type
Результат Struct

addInheritanceAttributes() защищенный Метод

protected addInheritanceAttributes ( StructAttribute $attributes )
$attributes WsdlToPhp\PackageGenerator\Container\Model\StructAttribute

addValue() публичный Метод

Adds value to values array
public addValue ( mixed $value ) : Struct
$value mixed the original value
Результат Struct

countOwnAttributes() публичный Метод

Returns the number of own attributes
public countOwnAttributes ( ) : integer
Результат integer

getAllAttributes() защищенный Метод

protected getAllAttributes ( boolean $includeInheritanceAttributes, boolean $requiredFirst ) : StructAttribute
$includeInheritanceAttributes boolean
$requiredFirst boolean
Результат WsdlToPhp\PackageGenerator\Container\Model\StructAttribute

getAttribute() публичный Метод

Returns the attribute by its name, otherwise null
public getAttribute ( string $attributeName ) : StructAttribute | null
$attributeName string the original attribute name
Результат StructAttribute | null

getAttributes() публичный Метод

Returns the attributes of the struct and potentially from the parent class
public getAttributes ( boolean $includeInheritanceAttributes = false, boolean $requiredFirst = false ) : StructAttribute
$includeInheritanceAttributes boolean 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.
$requiredFirst boolean places the required attributes first, then the not required in order to have the _contrust method with the required attribute at first
Результат WsdlToPhp\PackageGenerator\Container\Model\StructAttribute

getContextualPart() публичный Метод

Returns the contextual part of the class name for the package
См. также: AbstractModel::getContextualPart()
public getContextualPart ( ) : string
Результат string

getDocSubPackages() публичный Метод

Returns the sub package name which the model belongs to Must be overridden by sub classes
См. также: AbstractModel::getDocSubPackages()
public getDocSubPackages ( ) : array
Результат array

getExtends() публичный Метод

Allows to define from which class the curent model extends
public getExtends ( boolean $short = false ) : string
$short boolean
Результат string

getInheritanceStruct() публичный Метод

public getInheritanceStruct ( ) : Struct | null
Результат Struct | null

getIsRestriction() публичный Метод

Returns the isRestriction value
public getIsRestriction ( ) : boolean
Результат boolean

getIsStruct() публичный Метод

Returns the isStruct value
public getIsStruct ( ) : boolean
Результат boolean

getMeta() публичный Метод

См. также: WsdlToPhp\PackageGenerator\Model\AbstractModel::getMeta()
public getMeta ( ) : string[]
Результат string[]

getReservedMethodsInstance() публичный Метод

public getReservedMethodsInstance ( $filename = null ) : StructReservedMethod | StructArrayReservedMethod
$filename
Результат WsdlToPhp\PackageGenerator\ConfigurationReader\StructReservedMethod | WsdlToPhp\PackageGenerator\ConfigurationReader\StructArrayReservedMethod

getTopInheritance() публичный Метод

public getTopInheritance ( ) : Struct | null
Результат Struct | null

getValue() публичный Метод

Gets the value object for the given value
public getValue ( string $value ) : StructValue | null
$value string Value name
Результат StructValue | null

getValues() публичный Метод

Returns the values for an enumeration
public getValues ( ) : StructValue
Результат WsdlToPhp\PackageGenerator\Container\Model\StructValue

isArray() публичный Метод

Returns true if the current struct is a collection of values (like an array)
public isArray ( ) : boolean
Результат boolean

putRequiredFirst() защищенный Метод

protected putRequiredFirst ( StructAttribute $allAttributes ) : StructAttribute
$allAttributes WsdlToPhp\PackageGenerator\Container\Model\StructAttribute
Результат WsdlToPhp\PackageGenerator\Container\Model\StructAttribute

setAttributes() публичный Метод

Sets the attributes of the struct
public setAttributes ( StructAttribute $structAttributeContainer ) : Struct
$structAttributeContainer WsdlToPhp\PackageGenerator\Container\Model\StructAttribute
Результат Struct

setIsRestriction() публичный Метод

Sets the isRestriction value
public setIsRestriction ( boolean $isRestriction = true ) : Struct
$isRestriction boolean
Результат Struct

setIsStruct() публичный Метод

Sets the isStruct value
public setIsStruct ( boolean $isStruct = true ) : Struct
$isStruct boolean
Результат Struct