UmlSequenceDiagramMessage.class.php

Go to the documentation of this file.

<?php
class UmlSequenceDiagramMessage
{
    protected $strText = null;

    protected $strMethod = null;

    protected $strType = null;

    protected $objActorFrom = null;

    protected $objActorTo = null;

    protected $arrValues = Array();

    protected $intTimeStart;

    protected $intTimeEnd;

    protected $intPosition;

    protected $objUmlSequenceDiagram;

    protected $arrNotesBefore = array();

    protected $arrNotesAfter = array();

    public function setText( $strText )
    {
        $this->strText = $strText;
        return $this;
    }

    public function getText()
    {
        return $this->strText;
    }

    public function setMethod( $strMethod )
    {
        $this->strMethod = $strMethod;
        return $this;
    }

    public function getMethod()
    {
        return $this->strMethod;
    }

    public function setType( $strType )
    {
        if( !in_array( $strType, Array( 'call' , 'return' ) ) )
        {
            throw new Exception( "Invalid type of message " . $strType );
        }
        $this->strType = $strType;
        return $this;
    }

    public function getType()
    {
        return $this->strType;
    }

    public function getPosition()
    {
        return $this->intPosition;
    }

    public function setPosition( $intPosition )
    {
        $this->intPosition = $intPosition;
        return $this;
    }
    
    public function setActorFrom( UmlSequenceDiagramActor $objActor )
    {
        $this->objActorFrom = $objActor;
        return $this;
    }

     public function getActorFrom()
    {
        return $this->objActorFrom;
    }

    public function setActorTo( UmlSequenceDiagramActor $objActor )
    {
        $this->objActorTo = $objActor;
        return $this;
    }

     public function getActorTo()
    {
        return $this->objActorTo;
    }


    public function setUmlSequenceDiagram( UmlSequenceDiagram $objUmlSequenceDiagram )
    {
        $this->objUmlSequenceDiagram = $objUmlSequenceDiagram;
        return $this;
    }

     public function getUmlSequenceDiagram()
    {
        return $this->objUmlSequenceDiagram;
    }

    public function setValues( Array $arrValues )
    {
        $this->arrValues = $arrValues;
        return $this;
    }

    public function getValues()
    {
        return $this->arrValues;
    }

    public function addValue( UmlSequenceDiagramValue $objValue )
    {
        $this->arrValues[] = $objValue;
        return $this;
    }

    public function addNoteBefore( UmlSequenceDiagramNote $objNote )
    {
        $this->arrNotesBefore[] = $objNote;
        return $this;
    }

    public function setNotesBefore( array $arrNotesBefore )
    {
        foreach( $arrNotesBefore as $objNote )
        {
            $this->addNoteBefore( $objNote );
        }
        return $this;
    }

    public function getNotesBefore()
    {
        return $this->arrNotesBefore;
    }


    public function addNoteAfter( UmlSequenceDiagramNote $objNote )
    {
        $this->arrNotesAfter[] = $objNote;
        return $this;
    }

    public function setNotesAfter( array $arrNotesAfter )
    {
        foreach( $arrNotesAfter as $objNote )
        {
            $this->addNoteAfter( $objNote );
        }
        return $this;
    }

    public function getNotesAfter()
    {
        return $this->arrNotesAfter;
    }

   public function setTimeStart( $intTime )
    {
        $this->intTimeStart = $intTime;
        return $this;
    }

    public function getTimeStart()
    {
        return $this->intTimeStart;
    }

    public function setTimeEnd( $intTime )
    {
        $this->intTimeEnd = $intTime;
        return $this;
    }

    public function getTimeEnd()
    {
        return $this->intTimeEnd;
    }

    public function getTimeDuration()
    {
        return $this->intTimeEnd - $this->intTimeStart;
    }


    public function isReverse()
    {
        return ( $this->objActorFrom->getPosition() > $this->objActorTo->getPosition() );
    }


    public function isLarge()
    {
        return ( abs( $this->objActorFrom->getPosition() - $this->objActorTo->getPosition() ) > 1 );
    }

    public function isRecursive()
    {
        return( $this->objActorFrom->getPosition() == $this->objActorTo->getPosition() );
    }
}
?>