spunQ_ITypeParser Interface Reference
Interface for generating spunQ_LocalUserType objects out of doc comments. More...
Inheritance diagram for spunQ_ITypeParser:
Public Member Functions | |
| parseType ($typeName, $fileName) | |
| Creates a type object out of documentation. | |
| addMembers (spunQ_LocalUserType $type, $fileName) | |
| Adds members to a type object. | |
Detailed Description
Interface for generating spunQ_LocalUserType objects out of doc comments.Definition at line 6 of file ITypeParser.interface.php.
Member Function Documentation
| spunQ_ITypeParser::addMembers | ( | spunQ_LocalUserType $ | type, | |
| $ | fileName | |||
| ) |
Adds members to a type object.
Since it is not possible to parse types and their members in a single step due to possible circular dependencies (a parent has a child, a child has a parent), the members of a type are added after all types have been declared.
- Parameters:
-
$type A type that was created using parseType(). $fileName The file in which the type was defined.
- Returns:
- spunQ_ITypeParser $this
Implemented in spunQ_ReflectionTypeParser.
| spunQ_ITypeParser::parseType | ( | $ | typeName, | |
| $ | fileName | |||
| ) |
Creates a type object out of documentation.
- Parameters:
-
$typeName The proposed name for the type. The actual type name can be different, if one is provided in a @name tag in the class documentation. $fileName File containing the source code for a type. This file must be named X.class.php where X is the name of a class that is declared in this file. The filename can optionally be prepended with the unique name of the module. Example: The file 'Test.class.php' is expected to contain the declaration of the class 'Test'. It might have as well been called 'myModule_Test.class.php', if the class was defined in the myModule module.
- Returns:
- spunQ.type.Type The type does not have to contain all members of the type. They will be added in a later step using addMembers().
- Exceptions:
-
spunQ_TypeNotFoundException When the parent type was not found.
Implemented in spunQ_ReflectionTypeParser.
The documentation for this interface was generated from the following file:
