Slick\Orm\Event\AbstractEvent

Complexity

Total Complexity

8

Size/Duplication

Total Lines	104
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

54.55%

Importance

Changes	1
Bugs	0	Features	1

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	setEntityName()	0	5	1
A	getEntityName()	0	7	2
A	setAction()	0	5	1
A	setEntity()	0	5	1
A	getEntity()	0	4	1
A	getName()	0	4	1

<?php

/**
 * This file is part of slick/orm package
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Slick\Orm\Event;

use \League\Event\AbstractEvent as LeagueAbstractEvent;
use Slick\Orm\EntityInterface;

/**
 * Abstract ORM Event
 *
 * @package Slick\Orm\Event
 * @author  Filipe Silva <silvam.filipe@gmail.com>
 */
abstract class AbstractEvent extends LeagueAbstractEvent implements EventInterface
{

    /**
     * @var string
     */
    protected $entityName;

    /**
     * @var EntityInterface
     */
    protected $entity;

    /**
     * @var string
     */
    protected $action = 'none';

    /**
     * @var mixed
     */
    protected $params;

    /**
     * All ORM events are from entities
     *
     * @param EntityInterface $entity
     * @param mixed $params additional parameters
     */
    public function __construct(EntityInterface $entity, $params = null)
    {
        $this->setEntity($entity);
        $this->params = $params;
    }

    /**
     * Sets the name of the class that triggers the event
     *
     * @param string $className
     * @return self|EventInterface|$this
     */
    public function setEntityName($className)
    {
        $this->entityName = $className;
        return $this;
    }

    /**
     * Gets the entity class name that triggers the event
     *
     * @return string
     */
    public function getEntityName()
    {
        if (null == $this->entityName) {
            $this->setEntityName(get_class($this->getEntity()));
        }
        return $this;
    }

    /**
     * Set event's action
     *
     * @param string $action
     * @return self|EventInterface|$this
     */
    public function setAction($action)
    {
        $this->action = $action;
        return $this;
    }

    /**
     * Sets the entity object that triggers the event
     *
     * @param EntityInterface $entity
     * @return self|EventInterface|$this
     */
    public function setEntity(EntityInterface $entity)
    {
        $this->entity = $entity;
        return $this;
    }

    /**
     * Gets the entity object that triggers the event
     *
     * @return EntityInterface
     */
    public function getEntity()
    {
        return $this->entity;
    }

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