Slick\Orm\Mapper\EventTriggers

Complexity

Total Complexity

7

Size/Duplication

Total Lines	91
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	2	Features	1

6 Methods

Rating	Name	Duplication	Size	Complexity
A	triggerBeforeSave()	0	12	2
A	triggerAfterSave()	0	12	2
A	triggerBeforeDelete()	0	4	1
A	triggerAfterDelete()	0	4	1
A	triggerDelete()	0	8	1
	getEntityClassName()	0	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\Mapper;

use Slick\Database\Sql\Insert;
use Slick\Orm\EntityInterface;
use Slick\Orm\Event\Delete;
use Slick\Orm\Event\Save;
use Slick\Orm\Orm;

/**
 * ORM entity event triggers methods
 *
 * @package Slick\Orm\Mapper
 * @author  Filipe Silva <silvam.filipe@gmail.com>
 */
trait EventTriggers
{

    /**
     * Triggers the before save event
     *
     * @param Sql/Update|Sql/Insert $query

The doc-type Sql/Update|Sql/Insert could not be parsed: Unknown type name "Sql/Update" at position 0. (view supported doc-types)

     * @param EntityInterface $entity
     * @param array $data
     *
     * @return Save
     */
    protected function triggerBeforeSave(
        $query, EntityInterface $entity, array $data
    ) {
        $save = $query instanceof Insert
            ? (new Save($entity, $data))
                ->setAction(Save::ACTION_BEFORE_INSERT)
            : (new Save($entity, $data))
                ->setAction(Save::ACTION_BEFORE_UPDATE);

        /** @var Save $save */
        return Orm::getEmitter($this->getEntityClassName())->emit($save);
    }

    /**
     * Triggers the after save event
     *
     * @param Save $saveEvent
     * @param EntityInterface $entity
     *
     * @return \League\Event\EventInterface|Save
     */
    protected function triggerAfterSave(
        Save $saveEvent, EntityInterface $entity
    ) {
        $afterSave = clone $saveEvent;
        $action = $afterSave->getName() == Save::ACTION_BEFORE_INSERT
            ? Save::ACTION_AFTER_INSERT
            : Save::ACTION_AFTER_UPDATE;

        $afterSave->setEntity($entity)->setAction($action);
        return Orm::getEmitter($this->getEntityClassName())
            ->emit($afterSave);
    }

    /**
     * Triggers the before delete event
     *
     * @param EntityInterface $entity
     *
     * @return \League\Event\EventInterface|Delete
     */
    protected function triggerBeforeDelete(EntityInterface $entity)
    {
        return $this->triggerDelete($entity);
    }

    /**
     * Triggers the after delete event
     *
     * @param EntityInterface $entity
     *
     * @return \League\Event\EventInterface|Delete
     */
    protected function triggerAfterDelete(EntityInterface $entity)
    {
        return $this->triggerDelete($entity, Delete::ACTION_AFTER_DELETE);
    }

    /**
     * Triggers the delete event with provided action
     *
     * @param EntityInterface $entity
     * @param string $action
     * @return \League\Event\EventInterface|Delete
     */
    protected function triggerDelete(
        EntityInterface $entity, $action = Delete::ACTION_BEFORE_DELETE
    ) {
        $event = new Delete($entity);
        $event->setAction($action);
        return Orm::getEmitter($this->getEntityClassName())
            ->emit($event);
    }

    /**
     * @return string
     */
    abstract public function getEntityClassName();
}