PEIP\Event\Event

Complexity

Total Complexity

9

Size/Duplication

Total Lines	94
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Importance

Changes	3
Bugs	3	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	2
A	getName()	0	4	1
A	getType()	0	4	1
A	setReturnValue()	0	4	1
A	getReturnValue()	0	4	1
A	setProcessed()	0	4	1
A	isProcessed()	0	4	1
A	getSubject()	0	4	1

<?php

namespace PEIP\Event;

namespace PEIP\Event;

/*
 * This file is part of the PEIP package.
 * (c) 2009-2016 Timo Michna <timomichna/yahoo.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

/*
 * Event
 *
 * @author Timo Michna <timomichna/yahoo.de>
 * @package PEIP
 * @subpackage event
 * @extends \PEIP\Message\GenericMessage
 * @implements \PEIP\INF\Base\Buildable, \PEIP\INF\Message\Message, \PEIP\INF\Base\Container, \PEIP\INF\Event\Event
 */




use PEIP\Util\Test;

class Event extends \PEIP\Message\GenericMessage implements
        \PEIP\INF\Event\Event
{
    protected $value = null,
        $processed = false,
        $subject = null,
        $name = '',
        $parameters = null,
        $type;

    /**
     * constructor.
     *
     * @param mixed  $subject the subject for the event
     * @param string $name    the name of the event
     */
    public function __construct($subject, $name, $parameters = [], $type = false)
    {
        parent::__construct($subject, Test::ensureArrayAccess($parameters));
        $this->name = $name;
        $this->type = $type ? $type : get_class($this);
    }

    /**
     * returns the name of the event.
     *
     * @return string the name of the event
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * returns the type of the event (Name of this Event-Class if no
     * event-type has been set in constructor).
     *
     * @return string the type of the event
     */
    public function getType()
    {
        return $this->name;
    }

    /**
     * sets the return-value of the event.
     *
     * @param mixed $value the return-value to set
     */
    public function setReturnValue($value)
    {
        $this->value = $value;
    }

    /**
     * returns the return-value of the event.
     *
     * @return mixed the return-value to set
     */
    public function getReturnValue()
    {
        return $this->value;
    }

    /**
     * sets wether the event is processed.
     *
     * @param bool $processed
     */
    public function setProcessed($processed)
    {
        $this->processed = (bool) $processed;
    }

    /**
     * checks wether the event is processed.
     *
     * @return bool wether the event is processed
     */
    public function isProcessed()
    {
        return $this->processed;
    }

    /**
     * Returns the subject/content of the container.
     *
     * @return mixed the subject/content
     */
    public function getSubject()
    {
        return $this->getContent();
    }
}