PHP_UML
[ class tree: PHP_UML ] [ index: PHP_UML ] [ all elements ]
Packages:
PHP_UML


Classes:
XMI
   PHP_UML_XMI_AbstractBuilder
   PHP_UML_XMI_BuilderImpl1
   PHP_UML_XMI_BuilderImpl2
PHP_UML
   PHP_UML_Metamodel_Class
   PHP_UML_Metamodel_File
PHP_UML
PHP_UML_Exception
PHP_UML_FilePatternFilterIterator
PHP_UML_FileScanner
PHP_UML_FileScannerImpl
PHP_UML_SimpleUID
PHP_UML_Warning
Output
   PHP_UML_Output_Exporter
Metamodel
   PHP_UML_Metamodel_Interface
   PHP_UML_Metamodel_NamedElement
   PHP_UML_Metamodel_Operation
   PHP_UML_Metamodel_Package
   PHP_UML_Metamodel_Parameter
   PHP_UML_Metamodel_Property
   PHP_UML_Metamodel_Stereotype
   PHP_UML_Metamodel_Superstructure
   PHP_UML_Metamodel_Tag
   PHP_UML_Metamodel_Type
   PHP_UML_Metamodel_TypedElement
PHP
   PHP_UML_PHP_Parser
Files:
Exception.php
FilePatternFilterIterator.php
FileScanner.php
FileScannerImpl.php
SimpleUID.php
test_to_run.php
test_with_api.php
UML.php
Warning.php

subpackage Metamodel
Class.php
Enumeration.php
File.php
Interface.php
NamedElement.php
Operation.php
Package.php
Parameter.php
Property.php
Stereotype.php
Superstructure.php
Tag.php
Type.php
TypedElement.php

subpackage Output
Exporter.php

subpackage PHP
Parser.php

subpackage XMI
AbstractBuilder.php
Builder.php
BuilderImpl1.php
BuilderImpl2.php

Class: PHP_UML_XMI_AbstractBuilder

Source Location: /PHP_UML-1.0.1/UML/XMI/AbstractBuilder.php

Class Overview




Abstract class to generate UML elements in XMI code.




Author(s):






            






Variables






Methods















Child classes:






PHP_UML_XMI_BuilderImpl1

	
Implementation class to create XMI in version 1






PHP_UML_XMI_BuilderImpl2

	
Implementation class to create XMI in version 2









Inherited Variables





Inherited Methods














Class Details



[line 29]

Abstract class to generate UML elements in XMI code.
To deal with the two different versions of XMI (1.4 and 2.1), you must use one of  the two specialized versions:  PHP_UML_XMI_BuilderImpl1, or PHP_UML_XMI_BuilderImpl2









[ Top ]







Class Variables



	
	

	
$extensions = array(''=>'File', 'php'=>self::PHP_FILE)

	
[line 35]

  


    

  • Access: public
    • 





  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$stereotypes = array('File', self::PHP_FILE)

	
[line 34]

  


    

  • Access: public
    • 





  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$xmlEncoding = 

	
[line 37]

  


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]










Method Detail



	
	
__construct (Constructor)   [line 87]

	

    

    

		PHP_UML_XMI_AbstractBuilder __construct(
string
$xmlEncoding)
    

    


	
		Constructor


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $xmlEncoding  
        —
          XML encoding of the file
      

        

    


        
[ Top ]

  

  
  
	
	
factory   [line 74]

	

    

    

		PHP_UML_XMI_Builder factory(
float
$version, string
$xmlEncoding)
    

    


	
		Factory method. Retrieves a proper implementation class,  matching the XMI version.


    

  • Return: An XMI builder object
    • 








        
Parameters:

    

    

          

        float  
        $version  
        —
          XMI version
      

          

        string  
        $xmlEncoding  
        —
          XML encoding
      

        

    


        
[ Top ]

  

  
  
	
	
getAllComponents   [line 157]

	

    

    

		string getAllComponents(
PHP_UML_Metamodel_Package
$package)
    

    


	
		Get all components, with its provided classes  PHP_UML considers each logical package as a component, and each owned class  as a provided class.


    

  • Return: XMI code
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        PHP_UML_Metamodel_Package  
        $package  
        —
          Package to map to a component
      

        

    


        
[ Top ]

  

  
  
	
	
getAllPackages   [line 101]

	

    

    

		string getAllPackages(
PHP_UML_Metamodel_Package
$package)
    

    


	
		Get all packages, recursively, with all the objects they contain  Initially called by PHP_UML->generateXMI() on the root package


    

  • Return: XMI code
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        PHP_UML_Metamodel_Package  
        $package  
        —
          Base package
      

        

    


        
[ Top ]

  

  
  
	
	
getOwnedTypes   [line 127]

	

    

    

		string getOwnedTypes(
PHP_UML_Metamodel_Package
$package)
    

    


	
		Get the different types owned by  package


    

  • Return: XMI code
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        PHP_UML_Metamodel_Package  
        $package  
        —
          Package to get the types of
      

        

    


        
[ Top ]

  

  
  
	
	
getUID   [line 47]

	

    

    

		string getUID(
[string
$prefix = null])
    

    


	
		Generates an ID for an element. A partial identifier can be provided  (used for classes and their idrefs)


    

  • Return: ID
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $prefix  
        —
          Prefix
      

        

    


        
[ Top ]

  

  
  
	
	
getXmlHeader   [line 60]

	

    

    

		string getXmlHeader(
)
    

    


	
		Gets an XML header for the XMI file


    

  • Access: public
    • 








        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Thu, 27 Aug 2009 17:30:04 +0000 by phpDocumentor 1.4.2. PEAR Logo Copyright ©  PHP Group 2004.