Schema
class Schema extends AbstractDocument (View source)
Constants
| META_DOCUMENTATION |
Constant used to define the key to store documentation value in meta |
Properties
| protected Generator | $generator | from AbstractGeneratorAware | |
| protected string | $name | Original name od the element | from AbstractModel |
| protected string[] | $meta | Values associated to the operation | from AbstractModel |
| protected string | $inheritance | Define the inheritance of a struct by the name of the parent struct or type | from AbstractModel |
| protected AbstractModel | $owner | Store the object which owns the current model | from AbstractModel |
| protected bool | $isAbstract | Indicates that the current element is an abstract element. | from AbstractModel |
| static protected array | $replacedPhpReservedKeywords | Replaced keywords time in order to generate unique new keyword | from AbstractModel |
| protected array | $replacedReservedMethods | Replaced methods time in order to generate unique new method | from AbstractModel |
| static protected array | $uniqueNames | Unique name generated in order to ensure unique naming (for struct constructor and setters/getters even for different case attribute name with same value) | from AbstractModel |
| protected Wsdl | $content | The content | from AbstractDocument |
Methods
Returns the name of the class the current class inherits from
Sets the name of the class the current class inherits from
Add meta information to the operation
Allows to merge meta from different sources and ensure consistency of their order Must be passed as less important (at first position) to most important (last position)
Sets the documentation meta value.
Returns a meta value according to its name
Returns the value of the first meta value assigned to the name
Sets the original name extracted from the WSDL
Returns a valid clean name for PHP
Returns true if the original name is safe to use as a PHP property, variable name or class name
Allows to define the contextual part of the class name for the package
Allows to define from which class the current model extends
Returns directory where to store class and create it if needed
Returns the sub package name which the model belongs to Must be overridden by sub classes
Clean a string to make it valid as PHP variable
Returns a usable keyword for a original keyword
Returns a usable method for a original method
Static method which returns a unique name case sensitively Useful to name methods case sensitively distinct, see http://the-echoplex.net/log/php-case-sensitivity
Gives the availability for test purpose and multiple package generation to purge unique names
Gives the availability for test purpose and multiple package generation to purge reserved keywords usage
No description
No description
Details
in AbstractDocument at line 20
__construct(Generator $generator, string $name, string $content)
protected AbstractGeneratorAware
setGenerator(Generator $generator)
Generator
getGenerator()
in AbstractModel at line 82
string
getExtendsClassName()
in AbstractModel at line 97
string
getInheritance()
Returns the name of the class the current class inherits from
in AbstractModel at line 106
AbstractModel
setInheritance(string $inheritance = '')
Sets the name of the class the current class inherits from
in AbstractModel at line 117
Struct
getInheritedModel()
in AbstractModel at line 125
string[]
getMeta()
Returns the meta
in AbstractModel at line 134
AbstractModel
setMeta(array $meta = [])
Sets the meta
in AbstractModel at line 147
AbstractModel
addMeta(string $metaName, mixed $metaValue)
Add meta information to the operation
in AbstractModel at line 177
protected array
mergeMeta()
Allows to merge meta from different sources and ensure consistency of their order Must be passed as less important (at first position) to most important (last position)
in AbstractModel at line 224
AbstractModel
setDocumentation(string $documentation)
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.
in AbstractModel at line 237
mixed
getMetaValue(string $metaName, mixed $fallback = null)
Returns a meta value according to its name
in AbstractModel at line 248
mixed
getMetaValueFirstSet(array $names, mixed $fallback = null)
Returns the value of the first meta value assigned to the name
in AbstractModel at line 262
string
getName()
Returns the original name extracted from the WSDL
in AbstractModel at line 271
AbstractModel
setName(string $name)
Sets the original name extracted from the WSDL
in AbstractModel at line 283
string
getCleanName(bool $keepMultipleUnderscores = true)
Returns a valid clean name for PHP
in AbstractModel at line 291
AbstractModel
getOwner()
Returns the owner model object
in AbstractModel at line 300
AbstractModel
setOwner(AbstractModel $owner = null)
Sets the owner model object
in AbstractModel at line 308
bool
isAbstract()
in AbstractModel at line 316
AbstractModel
setAbstract(bool $isAbstract)
in AbstractModel at line 327
bool
nameIsClean()
Returns true if the original name is safe to use as a PHP property, variable name or class name
in AbstractModel at line 345
string
getPackagedName(bool $namespaced = false)
Returns the packaged name
in AbstractModel at line 367
string
getContextualPart()
Allows to define the contextual part of the class name for the package
in AbstractModel at line 376
string|null
getExtends(bool $short = false)
Allows to define from which class the current model extends
in AbstractModel at line 388
string
getNamespace()
in AbstractModel at line 414
string
getSubDirectory()
Returns directory where to store class and create it if needed
in AbstractModel at line 427
array
getDocSubPackages()
Returns the sub package name which the model belongs to Must be overridden by sub classes
in AbstractModel at line 438
static string
cleanString(string $string, bool $keepMultipleUnderscores = true)
Clean a string to make it valid as PHP variable
in AbstractModel at line 450
static string
replacePhpReservedKeyword(string $keyword, string $context = null)
Returns a usable keyword for a original keyword
in AbstractModel at line 473
AbstractReservedWord
getReservedMethodsInstance($filename = null)
in AbstractModel at line 485
string
replaceReservedMethod(string $methodName, string $context = null)
Returns a usable method for a original method
in AbstractModel at line 510
static protected string
uniqueName(string $name, string $context)
Static method which returns a unique name case sensitively Useful to name methods case sensitively distinct, see http://the-echoplex.net/log/php-case-sensitivity
in AbstractModel at line 528
static
purgeUniqueNames()
Gives the availability for test purpose and multiple package generation to purge unique names
in AbstractModel at line 535
static
purgePhpReservedKeywords()
Gives the availability for test purpose and multiple package generation to purge reserved keywords usage
in AbstractDocument at line 57
protected array
toJsonSerialize()
Should return the properties of the inherited class
in AbstractModel at line 548
jsonSerialize()
{@inheritDoc}