CodeInstrumentationReceiver Class Reference

Inheritance diagram for CodeInstrumentationReceiver:

List of all members.

Public Member Functions
	setConfiguration (CodeInstrumentationReceiverConfiguration $objConfiguration)
	getConfiguration ()
	__construct ()
	renameMethod ($strMethod, $strClass)
	onEnterMethod ($uid, $strClassDefinition, $strMethod, $arrArguments)
	onLeaveMethod ($uid, $strClassDefinition, $strMethod, $mixReturn)
	getUmlSequenceDiagram ()
	setUmlSequenceDiagram (UmlSequenceDiagram $objUmlSequence)
	restart ()
	perform ()
	getActualActor ()
	getActualMessage ()
Static Public Member Functions
static	getInstance ()
Protected Member Functions
	shouldBeLog ($strClass, $strMethod)
Protected Attributes
	$arrStack = array()
	$arrActors = array()
	$arrClasses = array()
	$arrMessages = array()
	$objUmlSequence = null
	$objConfiguration
	$objActualMessage
	$objActualActor
Static Protected Attributes
static	$objCodeInstrumentationReceiver

---

Detailed Description

Class create to make possible the creation of code instrumentation of executions.

It receive the messages of enter methods and leave methods, into what object, of what class and, based into this informations, create a UmlSequenceDiagram object.

The uml sequence diagram object created, can be used for many ways, since create a xml, create a diagram file, etc. as the printers avaliable of it.

Todo:

make filter methods to reduce the diagram of big executions

See also:

CodeInstrumentationMethod

CodeInstrumentationClass

Author:

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

Definition at line 22 of file CodeInstrumentationReceiver.class.php.

---

Constructor & Destructor Documentation

__construct

(

)

prepare the code instrumentation receiver to start to receive the informations about the execution.

Execution Plan:

1. create the internal objects
2. create the uml sequence diagram object
3. create the user actor

Returns:

null

Definition at line 113 of file CodeInstrumentationReceiver.class.php.

References $objConfiguration, and setConfiguration().

Referenced by restart().

    {
        // set the configuration file //
        $objConfiguration = new CodeInstrumentationReceiverConfiguration();
        $this->setConfiguration( $objConfiguration );

        // create the uml sequence diagram object //
        $this->objUmlSequence = new UmlSequenceDiagram();

        // create the user actor //     
        $objActorFrom = new UmlSequenceDiagramActor();
        $objActorFrom->setType( 'user' );
        $objActorFrom->setName( "user" );
        $objActorFrom->setId( sizeof( $this->arrActors ) + 1 );
        $this->arrActors[] = $objActorFrom;
        $this->arrStack[] = $objActorFrom;
        $this->objUmlSequence->addActor($objActorFrom);
    }

---

Member Function Documentation

getActualActor

(

)

Get the actual actor

Returns:

UmlSequenceDiagramActor

Definition at line 524 of file CodeInstrumentationReceiver.class.php.

    {
        return $this->objActualActor;
    }

getActualMessage

(

)

Get the actual message

Returns:

UmlSequenceDiagramMessage

Definition at line 534 of file CodeInstrumentationReceiver.class.php.

    {
        return ( $this->objActualMessage );
    }

getConfiguration

(

)

Get the code instrumentation receiver configuration

Returns:

CodeInstrumentationReceiverConfiguration

Definition at line 94 of file CodeInstrumentationReceiver.class.php.

Referenced by onEnterMethod(), onLeaveMethod(), and shouldBeLog().

    {
        return $this->objConfiguration;
    }

static getInstance

(

)

[static]

Get the code instrumentation receiver singleton

Returns:

CodeInstrumentationReceiver

Implements UmlSequenceDiagramFactoryInterface.

Definition at line 138 of file CodeInstrumentationReceiver.class.php.

    {
        if( self::$objCodeInstrumentationReceiver ==  null )
        {
            self::$objCodeInstrumentationReceiver = new CodeInstrumentationReceiver();
        }
        return self::$objCodeInstrumentationReceiver;
    }

getUmlSequenceDiagram

(

)

Return the uml sequence diagram Object what the Code Instrumentation Receiver feeds

See also:

CodeInstrumentationReceiver->objUmlSequence

CodeInstrumentationReceiver::setUmlSequenceDiagram( UmlSequenceDiagram )

Returns:

UmlSequenceDiagram

Implements UmlSequenceDiagramFactoryInterface.

Definition at line 458 of file CodeInstrumentationReceiver.class.php.

Referenced by perform().

    {
        return $this->objUmlSequence;
    }

onEnterMethod	(	$	uid,
		$	strClassDefinition,
		$	strMethod,
		$	arrArguments
	)

Receive a message of enter into some method and append it as a uml sequence diagram message into the uml sequence diagram object, creating if necessary the uml sequence diagram actor

Execution Plan:

1. get the name of method as the diagram standart
2. get the namespace name
3. get the actor what the message is bring from
4. get the actor what the message is bring to
   1. create the actor to if he not exists
5. create the message
   1. set the message attributes
   2. set the message values
6. append the message

Parameters:

	string	$uid
	string	$strClassDefinition
	string	$strMethod
	Array	$arrArguments

Returns:

CodeInstrumentationReceiver me

Definition at line 254 of file CodeInstrumentationReceiver.class.php.

References CorujaClassManipulation::getClassNameFromClassDefinition(), getConfiguration(), CorujaClassManipulation::getNamespaceFromClassDefinition(), renameMethod(), and shouldBeLog().

    {
        // get the name of method as the diagram standart //
        $strClass               = CorujaClassManipulation::getClassNameFromClassDefinition( $strClassDefinition );
        $arrMethod      = explode( "::" , $strMethod );
        $strRealMethod  = array_pop( $arrMethod );
        $strMethod      = $this->renameMethod( $strRealMethod , $strClass);

        // get the namespace name //
        $strNamespace   = CorujaClassManipulation::getNamespaceFromClassDefinition( $strClassDefinition );

        if( ! array_key_exists( $strClass, $this->arrClasses ) )
        {
            $this->arrClasses[ $strClass ] = 0;
        }
        
         // apply receiver configurations
        if( $this->getConfiguration()->getMergeSameClassObjects() )
        {
            $uid = $strClass;
        }        

        if( ! $this->shouldBeLog( $strClass , $strRealMethod ) )
        {
                return $this;
        }
        
        // get the actor what the message is bring from  //
        $objActorFrom = current( $this->arrStack );
        //$objActorFrom = $this->arrStack[0];
        if( $objActorFrom  === false )
        {
            return $this;
        }

        // get the actor what the message is bring to //
        if( ! array_key_exists( $uid , $this->arrActors ) )
        {
                // create the actor to if he not exists //
            $this->arrClasses[ $strClass ]++;
            $objActorTo = new UmlSequenceDiagramActor();
            $objActorTo->setStereotype( $this->getConfiguration()->getMatchGroupStereotypes()->match( $strClass ) );
            $objActorTo->setClassName( $strClass );

            // object counter by class only make sence when has more the one
            // object of the same class
            if( $this->getConfiguration()->getMergeSameClassObjects() )
            {
                    $objActorTo->setName( $strClass );
            }
            else
            {
                    $objActorTo->setName( $strClass . '(' . $this->arrClasses[ $strClass ] . ')');
            }
            
            $objActorTo->setId(sizeof( $this->arrActors ) + 1  );
            $this->arrActors[ $uid ] = $objActorTo;
            $this->objUmlSequence->addActor($objActorTo);
        }
        else
        {
            $objActorTo = $this->arrActors[ $uid ];
        }
        
        if( !$this->getConfiguration()->getIgnoreRecursiveCalls() || ( $objActorFrom != $objActorTo ) )
        {
            // create the message //
            $objMessage = new UmlSequenceDiagramMessage();

            // set the message attributes //
            $objMessage->setMethod( $strRealMethod );
            $objMessage->setText( $strMethod );
            $objMessage->setActorFrom( $objActorFrom );
            $objMessage->setActorTo( $objActorTo );
            $objMessage->setType( 'call' );

            $objReflectedClass = new CodeReflectionClass( $strClass );
            $objReflectedMethod = $objReflectedClass->getMethod( $strRealMethod );
            $arrReflectedParameter = $objReflectedMethod->getParameters();

            // set the message values //
            foreach( $arrArguments as $intPos => $mixValue )
            {
                $objValue = new UmlSequenceDiagramValue();
                $objReflectedParameter = $arrReflectedParameter[ $intPos ];
                $strName = $objReflectedParameter->getName();
                $objValue->setName( $strName );
                $objValue->setValue( $mixValue );
                $objMessage->addValue( $objValue );
            }
            $objMessage->setTimeStart( microtime( true ) );

            // append the message  //
            $this->objUmlSequence->addMessage( $objMessage );
            $this->objActualMessage = $objMessage;
            $this->arrMessages[]        = $objMessage;
        }
        
        array_unshift( $this->arrStack , $objActorTo );

        $this->objActualActor = $objActorFrom;
        return $this;
    }

onLeaveMethod	(	$	uid,
		$	strClassDefinition,
		$	strMethod,
		$	mixReturn
	)

Receive the message of leave some method and append it message into the uml sequence diagram object

Execution Plan:

1. get the name of method as the diagram standart
2. get the namespace name
3. get the actor what the message is bring from
4. get the actor what the message is bring to
5. create the message
   1. set the message attributes
   2. set the message values
6. append the message

Parameters:

	integer	$uid
	string	$strClassDefinition
	string	$strMethod
	$mixReturn

Returns:

CodeInstrumentationReceiver me

Definition at line 384 of file CodeInstrumentationReceiver.class.php.

References CorujaClassManipulation::getClassNameFromClassDefinition(), getConfiguration(), CorujaClassManipulation::getNamespaceFromClassDefinition(), renameMethod(), and shouldBeLog().

    {
        // get the name of method as the diagram standart //
        $strClass               = CorujaClassManipulation::getClassNameFromClassDefinition( $strClassDefinition );
        $arrMethod      = explode( "::" , $strMethod );
        $strRealMethod  = array_pop( $arrMethod );
        $strMethod      = $this->renameMethod( $strRealMethod , $strClass );

        // get the namespace name //
        $strNamespace   = CorujaClassManipulation::getNamespaceFromClassDefinition( $strClassDefinition );

            if( ! $this->shouldBeLog( $strClass , $strRealMethod ) )
        {
                return $this;
        }
                
        // get the actor what the message is bring from //
        reset( $this->arrStack );
        $objActorFrom = array_shift( $this->arrStack );
        
        // get the actor what the message is bring to //
        //$objActorTo = $this->arrStack[0];
        $objActorTo = current( $this->arrStack );

        $boolCreateMessage = true;

        if( $mixReturn == null and $this->getConfiguration()->getIgnoreNullReturns() )
        {
            $boolCreateMessage = false;
        }

        if( ( $objActorFrom == $objActorTo ) and $this->getConfiguration()->getIgnoreRecursiveCalls() )
        {
            $boolCreateMessage = false;
        }

        if( $boolCreateMessage )
        {
                // create the message //
            $objMessage = new UmlSequenceDiagramMessage();
            
            // set the message attributes //
            $objMessage->setMethod( $strRealMethod );
            $objMessage->setText( $strMethod );
            $objMessage->setActorFrom( $objActorFrom );
            $objMessage->setActorTo( $objActorTo );
            $objMessage->setType( 'return' );

            // set the message values //
            if( $mixReturn !== null )
            {
                $objValue = new UmlSequenceDiagramValue();
                $objValue->setName( "return" );
                $objValue->setValue( $mixReturn );
                $objMessage->addValue( $objValue );
            }

            // append the message  //
            $this->objUmlSequence->addMessage( $objMessage );
            $objMessage->setTimeEnd( microtime( true ) );
            $this->objActualMessage = $objMessage;
        }
        $this->objActualActor = $objActorTo;
        
        return $this;
    }

perform

(

)

Return the UmlSequenceDiagram created by this factory

Returns:

UmlSequenceDiagram

Implements UmlSequenceDiagramFactoryInterface.

Definition at line 513 of file CodeInstrumentationReceiver.class.php.

References getUmlSequenceDiagram().

    {
        return $this->getUmlSequenceDiagram();
    }

renameMethod	(	$	strMethod,
		$	strClass
	)

Rename the method to which they are in accordance with the standarts of the diagram

Execution Plan:

1. if __construct replace by >>create<<
2. if __destruct replace by >>destroy<<
3. other cases should append the "()"

Parameters:

string

$strMethod old method name

Returns:

string new method name

Definition at line 162 of file CodeInstrumentationReceiver.class.php.

Referenced by onEnterMethod(), and onLeaveMethod().

    {
        switch( $strMethod )
        {
                // 1. if __construct replace by <<create>> //
            case "__construct":
            {
                $strMethod = ( "<<create>>" );
                break;
            }
            // 2. if __destruct replace by <<destroy>> //
            case "__destruct":
            {
                $strMethod = ( "<<destroy>>" );
                break;
            }
            // 3. other cases should append the "()" //
            default:
            {
                $objReflectedClass = new CodeReflectionClass( $strClass );
                $objReflectedMethod = $objReflectedClass->getMethod( $strMethod );
                $arrReflectedParameter = $objReflectedMethod->getParameters();
                $arrParams = array();
                foreach( $arrReflectedParameter as $objReflectedParameter )
                {
                    $arrParams[] = $objReflectedParameter->getCode();
                }
                $strMethod .= "( " . implode( " , " , $arrParams ) . " )";
                break;
            }
        }
        return $strMethod;
    }

restart

(

)

Clean the attributes of the uml sequence diagram existing

1. clean actors
2. clean classes
3. clean messages
4. clean stack
5. clean object uml sequence diagram
6. restart the receiver

Returns:

CodeInstrumentationReceiver

Definition at line 491 of file CodeInstrumentationReceiver.class.php.

References __construct().

    {
        // clean actors //
        $this->arrActors = array();
        // clean classes //
        $this->arrClasses = array();
        // clean messages //
        $this->arrMessages = array();
        // clean stack //
        $this->arrStack = array();
        // clean object uml sequence diagram //
        $this->objUmlSequence->restart();
        // restart the receiver //
        $this->__construct();
        return $this;
    }

setConfiguration

(

CodeInstrumentationReceiverConfiguration $

objConfiguration

)

Set the code instrumentation receiver configuration

Parameters:

CodeInstrumentationReceiverConfiguration

$objConfiguration

Returns:

CodeInstrumentationReceiver

Definition at line 83 of file CodeInstrumentationReceiver.class.php.

Referenced by __construct().

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

setUmlSequenceDiagram

(

UmlSequenceDiagram $

objUmlSequence

)

Set the uml sequence diagram Object what the Code Instrumentation Receiver feeds

Parameters:

UmlSequenceDiagram

See also:

CodeInstrumentationReceiver->objUmlSequence

CodeInstrumentationReceiver::getUmlSequenceDiagram()

Returns:

CodeInstrumentationReceiver me

Implements UmlSequenceDiagramFactoryInterface.

Definition at line 471 of file CodeInstrumentationReceiver.class.php.

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

shouldBeLog	(	$	strClass,
		$	strMethod
	)			[protected]

Check if the method should be loged into the uml sequence diagram

Parameters:

	String	$strClass
	String	$strMethod

Returns:

boolean

Definition at line 203 of file CodeInstrumentationReceiver.class.php.

References getConfiguration().

Referenced by onEnterMethod(), and onLeaveMethod().

    {
        if( ! $this->getConfiguration()->getActive() )
        {
            return false;
        }
        
        if( $this->getConfiguration()->getGatekeeperClasses()->match( $strClass ) == false )
        {
            return false;
        }

        // returns of it is a ignored method
        if( $this->getConfiguration()->getGatekeeperMethods()->match( $strMethod ) == false )
        {
            return false;
        }
        
        return true;
    }

---

Member Data Documentation

$arrActors = array() [protected]

array with all the actors existents into the execution

UmlSequenceActor[]

Definition at line 43 of file CodeInstrumentationReceiver.class.php.

$arrClasses = array() [protected]

Array with the name of all the classes existents into the execution

String[]

Definition at line 50 of file CodeInstrumentationReceiver.class.php.

$arrMessages = array() [protected]

Array with all the messages received into the execution

UmlSequenceMessage[]

Definition at line 57 of file CodeInstrumentationReceiver.class.php.

$arrStack = array() [protected]

stack of actors into the execution pile

UmlSequenceActor[]

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

$objActualActor [protected]

Definition at line 75 of file CodeInstrumentationReceiver.class.php.

$objActualMessage [protected]

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

$objCodeInstrumentationReceiver [static, protected]

singletoon of the CodeInstrumentationReceiver

CodeInstrumentationReceiver

Definition at line 29 of file CodeInstrumentationReceiver.class.php.

$objConfiguration [protected]

Configuration of this printer

CodeInstrumentationReceiverConfiguration

Definition at line 71 of file CodeInstrumentationReceiver.class.php.

Referenced by __construct().

$objUmlSequence = null [protected]

Object of the uml sequence diagram what will be feed into the execution

UmlSequenceDiagram

Definition at line 64 of file CodeInstrumentationReceiver.class.php.

---

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

• components/codeInstrumentation/CodeInstrumentationReceiver.class.php