UmlSequenceDiagramFactoryFromXml Class Reference

Inheritance diagram for UmlSequenceDiagramFactoryFromXml:

List of all members.

Public Member Functions
	setXml ($strXml)
	getXml ()
	setUmlSequenceDiagram (UmlSequenceDiagram $objUmlSequenceDiagram)
	getUmlSequenceDiagram ()
	perform ()
Static Public Member Functions
static	getInstance ()
Protected Member Functions
	loadActors ()
	loadMessages ()
Protected Attributes
	$objUmlSequenceDiagram
	$objXml
Static Protected Attributes
static	$objInstance

---

Detailed Description

Factory what creates UmlSequenceDiagram based into Xml Files

Author:

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

Definition at line 11 of file UmlSequenceDiagramFactoryFromXml.class.php.

---

Member Function Documentation

static getInstance

(

)

[static]

Return the singleton of the UmlSequenceDiagramFactoryFromXml

Returns:

UmlSequenceDiagramFactoryFromXml

Implements UmlSequenceDiagramFactoryInterface.

Definition at line 41 of file UmlSequenceDiagramFactoryFromXml.class.php.

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

getUmlSequenceDiagram

(

)

get the xml sequence object

See also:

UmlSequenceDiagramFactoryInterface->getUmlSequenceDiagram()

Returns:

UmlSequenceDiagram

Implements UmlSequenceDiagramFactoryInterface.

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

Referenced by loadActors(), loadMessages(), and perform().

    {
        return $this->objUmlSequenceDiagram;
    }

getXml

(

)

Get the xml of the sequence object

See also:

UmlSequenceDiagram->objXml

UmlSequenceDiagram::setXml( string )

Parameters:

string

$strXml

Returns:

SimpleXmlElement

Definition at line 73 of file UmlSequenceDiagramFactoryFromXml.class.php.

    {
        return $this->objXml;
    }

loadActors

(

)

[protected]

Load the xml file and based on it insert a list of actors into the UmlSequenceDiagram Object

Definition at line 120 of file UmlSequenceDiagramFactoryFromXml.class.php.

References getUmlSequenceDiagram().

Referenced by perform().

    {
        $arrActors = $this->getUmlSequenceDiagram()->getActors();

        foreach( $this->objXml->actors->actor as $xmlActor )
        {
            $strId = (string)$xmlActor['id'];
            $strType = (string)$xmlActor['type'];
            $strName = (string)$xmlActor;

            $objActor = new UmlSequenceDiagramActor();
            $objActor->setId( $strId );
            $objActor->setType( $strType );
            $objActor->setName( $strName );

            $arrActors[ $objActor->getId() ] = $objActor;
        }
        $this->getUmlSequenceDiagram()->setActors( $arrActors );
    }

loadMessages

(

)

[protected]

Load the xml file and based on it insert a list of messages into the UmlSequenceDiagram Object

Definition at line 144 of file UmlSequenceDiagramFactoryFromXml.class.php.

References getUmlSequenceDiagram().

Referenced by perform().

    {
        $arrMessages = $this->getUmlSequenceDiagram()->getMessages();
        $arrActors = $this->getUmlSequenceDiagram()->getActors();

        foreach( $this->objXml->messages->message as $xmlMessage )
        {
            $strFrom    = (string)$xmlMessage[ 'from' ];
            $strTo      = (string)$xmlMessage[ 'to' ];
            $strType    = (string) $xmlMessage[ 'type' ];
            $strText = (string) $xmlMessage[ 'text' ];

            $objMessage = new UmlSequenceDiagramMessage();
            $objMessage->setType( $strType );
            $objMessage->setText( $strText );

           if( !array_key_exists( $strFrom , $arrActors ) )
            {
                throw new Exception( ' Actor From ' . $strFrom . ' not Found ' );
            }
            $objMessage->setActorFrom( $arrActors[ $strFrom ] );

           if( !array_key_exists( $strTo , $arrActors ) )
            {
                throw new Exception( ' Actor To ' . $strTo . ' not Found ' );
            }
            $objMessage->setActorTo( $arrActors[ $strTo ] );

            if( isset( $xmlMessage->values->value ) )
            foreach( $xmlMessage->values->value as $xmlValue )
            {
                $strName = (string)$xmlValue['name'];
                $strValue = (string)$xmlValue['value'];
                $objValue = new UmlSequenceDiagramValue();
                $objValue->setName( $strName );
                $objValue->setValue( $strValue );

                $objMessage->addValue( $objValue );
            }

            $arrMessages[] = $objMessage;
        }
        $this->getUmlSequenceDiagram()->setMessages( $arrMessages );
    }

perform

(

)

create a UmlSequenceDiagram based into its configurations

See also:

UmlSequenceDiagramFactoryInterface->perform()

Returns:

UmlSequenceDiagram

Implements UmlSequenceDiagramFactoryInterface.

Definition at line 108 of file UmlSequenceDiagramFactoryFromXml.class.php.

References getUmlSequenceDiagram(), loadActors(), loadMessages(), and setUmlSequenceDiagram().

    {
        $this->setUmlSequenceDiagram( new UmlSequenceDiagram() );
        $this->loadActors();
        $this->loadMessages();
        return $this->getUmlSequenceDiagram();
    }

setUmlSequenceDiagram

(

UmlSequenceDiagram $

objUmlSequenceDiagram

)

set the xml sequence object

See also:

UmlSequenceDiagramFactoryInterface->setUmlSequenceDiagram( UmlSequenceDiagram )

Parameters:

$objUmlSequenceDiagram

Returns:

UmlSequenceDiagramFactoryFromXml me

Implements UmlSequenceDiagramFactoryInterface.

Definition at line 85 of file UmlSequenceDiagramFactoryFromXml.class.php.

Referenced by perform().

    {
        $this->objUmlSequenceDiagram = $objUmlSequenceDiagram;
        return $this;
    }

setXml

(

$

strXml

)

Set the xml of the sequence object

See also:

UmlSequenceDiagram->objXml

UmlSequenceDiagram::getXml()

Parameters:

string

$strXml

Returns:

UmlSequenceDiagramFactoryFromXml me

Definition at line 59 of file UmlSequenceDiagramFactoryFromXml.class.php.

References $strXml.

    {
        $this->objXml = simplexml_load_string( $strXml );
        return $this;
    }

---

Member Data Documentation

$objInstance [static, protected]

Singleton of the UmlSequenceDiagramFactoryFromXml

See also:

UmlSequenceDiagramFactoryInterface::$objInstance

UmlSequenceDiagramFactoryFromXml

Definition at line 19 of file UmlSequenceDiagramFactoryFromXml.class.php.

$objUmlSequenceDiagram [protected]

Xml Sequence Object in factory

See also:

UmlSequenceDiagramFactoryInterface->objUmlSequenceDiagram

UmlSequenceDiagram

Definition at line 27 of file UmlSequenceDiagramFactoryFromXml.class.php.

$objXml [protected]

Simple Xml Element used to access information from a xml

SimpleXmlElement

Definition at line 34 of file UmlSequenceDiagramFactoryFromXml.class.php.

---

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

• components/umlSequenceDiagram/UmlSequenceDiagramFactoryFromXml.class.php