UmlSequenceDiagramPrinterToXml Class Reference

Inheritance diagram for UmlSequenceDiagramPrinterToXml:

List of all members.

Public Member Functions
	getHeader ()
	perform (UmlSequenceDiagram $objUmlSequenceDiagram)
	createXml ()
	createXmlHeader ()
	createXmlFooter ()
	createXmlActors ()
	createXmlMessages ()
	setConfiguration (UmlSequenceDiagramPrinterConfigurationInterface $objConfiguration)
	getConfiguration ()
Static Public Member Functions
static	getInstance ()
Protected Attributes
	$objUmlSequenceDiagram
	$objConfiguration
Static Protected Attributes
static	$objInstance

---

Detailed Description

Generate a Xml from the Uml Sequence Diagram object

Author:

Thiago Henrique Ramos da Mata <thiago.henrique.mata@gmail.com>

Definition at line 12 of file UmlSequenceDiagramPrinterToXml.class.php.

---

Member Function Documentation

createXml

(

)

Create and return the xml of the sequence diagram object

See also:

UmlSequenceDiagramPrinterToXml::createXmlHeader()

UmlSequenceDiagramPrinterToXml::createXmlActors()

UmlSequenceDiagramPrinterToXml::createXmlFooter()

Returns:

string

Definition at line 82 of file UmlSequenceDiagramPrinterToXml.class.php.

References $strXml, createXmlActors(), createXmlFooter(), createXmlHeader(), and createXmlMessages().

Referenced by perform().

    {
        $strXml = '';
        $strXml .= $this->createXmlHeader();
        $strXml .= $this->createXmlActors();
        $strXml .= $this->createXmlMessages();
        $strXml .= $this->createXmlFooter();
        return $strXml;
    }

createXmlActors

(

)

Create and return the actors slice of the xml

Returns:

string

$objActor UmlSequenceDiagramActor

Definition at line 117 of file UmlSequenceDiagramPrinterToXml.class.php.

Referenced by createXml().

    {
        $arrActors = $this->objUmlSequenceDiagram->getActors();
        
        $strXmlActors = "\t<actors>\n";
        foreach( $arrActors as $objActor )
        {
            $strXmlActors .= "\t\t";
            $strXmlActors .= "<actor ";
            $strXmlActors .= 'id="' . $objActor->getId() . '" ';
            $strXmlActors .= 'type="' . $objActor->getType() . '" ';
            $strXmlActors .= '>';
            $strXmlActors .= $objActor->getName() . ':' . $objActor->getClassName();
            $strXmlActors .= "</actor>\n";
        }
        $strXmlActors .= "\t</actors>\n";
        return $strXmlActors;
    }

createXmlFooter

(

)

Create and return the footer slice of the xml

Returns:

string

Definition at line 107 of file UmlSequenceDiagramPrinterToXml.class.php.

Referenced by createXml().

    {
        return "</sequence>\n";
    }

createXmlHeader

(

)

Create and return the header slice of the xml

Returns:

string

Definition at line 97 of file UmlSequenceDiagramPrinterToXml.class.php.

Referenced by createXml().

    {
        return "<sequence>\n";
    }

createXmlMessages

(

)

Create and return the messages slice of the xml

Returns:

string

$objMessage UmlSequenceDiagramMessage

$objValue UmlSequenceDiagramValue

Definition at line 142 of file UmlSequenceDiagramPrinterToXml.class.php.

Referenced by createXml().

    {
        $arrMessages = $this->objUmlSequenceDiagram->getMessages();
        
        $strXmlMessages = "\t<messages>\n";
        foreach( $arrMessages as $objMessage )
        {

            $strXmlMessages .= "\t\t";
            $strXmlMessages .= "<message ";
            $strXmlMessages .= 'type="' . $objMessage->getType() . '" ';
            $strXmlMessages .= 'from="' . $objMessage->getActorFrom()->getId() . '" ';
            $strXmlMessages .= 'to="' . $objMessage->getActorTo()->getId() . '" ';
            $strXmlMessages .= 'text="' . htmlentities( $objMessage->getText() ) . '" ';
            $strXmlMessages .= '>' . "\n";

            $strXmlMessages .= "\t\t\t";
            $strXmlMessages .= "<values>\n";

            $arrValues = $objMessage->getValues();
            foreach($arrValues as $objValue )
            {
                $strXmlMessages .= "\t\t\t\t";
                $strXmlMessages .= "<value ";
                $strXmlMessages .= 'name = "' . $objValue->getName() . '" ';
                $strXmlMessages .= 'value = "' . $objValue->getValue() . '" ';
                $strXmlMessages .= "/>\n";
            }

            $strXmlMessages .= "\t\t\t";
            $strXmlMessages .= "</values>\n";

            $strXmlMessages .= "\t\t";
            $strXmlMessages .= "</message>\n";
        }
        $strXmlMessages .= "\t</messages>\n";
        return $strXmlMessages;
    }

getConfiguration

(

)

Todo:

Create the configuration class to the xml printer

use the configuration class of the xml printer

Implements UmlSequenceDiagramPrinterInterface.

Definition at line 196 of file UmlSequenceDiagramPrinterToXml.class.php.

    {
        return $this->objConfiguration;
    }

getHeader

(

)

Get the header of the xml printer type

Implements UmlSequenceDiagramPrinterInterface.

Definition at line 56 of file UmlSequenceDiagramPrinterToXml.class.php.

    {
        header( "Content-type: text/xml" );
    }

static getInstance

(

)

[static]

Return the singleton of the UmlSequenceDiagramPrinterToXml

See also:

UmlSequenceDiagramPrinterInterface::getInstance

Returns:

UmlSequenceDiagramPrinterToXml

Implements UmlSequenceDiagramPrinterInterface.

Definition at line 44 of file UmlSequenceDiagramPrinterToXml.class.php.

Referenced by UmlSequenceDiagramPrinterConfigurationToXml::perform(), and CodeToDiagram::setPrinterType().

        {
                if( self::$objInstance == null )
                {
                        self::$objInstance = new UmlSequenceDiagramPrinterToXml();
                }
                return self::$objInstance;
        }

perform

(

UmlSequenceDiagram $

objUmlSequenceDiagram

)

Perfom the print process

See also:

UmlSequenceDiagramPrinterInterface::perform( UmlSequenceDiagram )

Parameters:

UmlSequenceDiagram

$objUmlSequenceDiagram

Returns:

mixer

Implements UmlSequenceDiagramPrinterInterface.

Definition at line 68 of file UmlSequenceDiagramPrinterToXml.class.php.

References createXml().

        {
                $this->objUmlSequenceDiagram = $objUmlSequenceDiagram;
                return $this->createXml();      
        }

setConfiguration

(

UmlSequenceDiagramPrinterConfigurationInterface $

objConfiguration

)

Todo:

Create the configuration class to the xml printer

use the configuration class of the xml printer

Implements UmlSequenceDiagramPrinterInterface.

Definition at line 187 of file UmlSequenceDiagramPrinterToXml.class.php.

    {
        $this->objConfiguration = $objConfiguration;
    }

---

Member Data Documentation

$objConfiguration [protected]

Uml Sequence Diagram Printer Configuration To Xml

Todo:

Create the class configuration to the xml

UmlSequenceDiagramPrinterConfigurationToXml

Definition at line 28 of file UmlSequenceDiagramPrinterToXml.class.php.

$objInstance [static, protected]

Singleton of the UmlSequenceDiagramPrinterToXml

See also:

UmlSequenceDiagramPrinterInterface::$objInstance

UmlSequenceDiagramPrinterToXml

Definition at line 36 of file UmlSequenceDiagramPrinterToXml.class.php.

$objUmlSequenceDiagram [protected]

Uml Sequence Diagram object what will be print

See also:

UmlSequenceDiagramPrinterInterface->objUmlSequenceDiagram

UmlSequenceDiagram

Definition at line 20 of file UmlSequenceDiagramPrinterToXml.class.php.

---

The documentation for this class was generated from the following file:

• components/umlSequenceDiagram/UmlSequenceDiagramPrinterToXml.class.php