Platine\Etl\Event\ItemExceptionEvent

Complexity

Total Complexity

6

Size/Duplication

Total Lines	94
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	ignoreException()	0	4	1
A	shouldThrowException()	0	3	1
A	getException()	0	3	1
A	getKey()	0	3	1
A	getItem()	0	3	1
A	__construct()	0	11	1

<?php

/**
 * Platine ETL
 *
 * Platine ETL is a library to Extract-Transform-Load Data from various sources
 *
 * This content is released under the MIT License (MIT)
 *
 * Copyright (c) 2020 Platine ETL
 * Copyright (c) 2019 Benoit POLASZEK
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

declare(strict_types=1);

namespace Platine\Etl\Event;

use Platine\Etl\Etl;
use Throwable;

/**
 * @class ItemExceptionEvent
 * @package Platine\Etl\Event
 */
class ItemExceptionEvent extends BaseEvent
{
    /**
     * The item
     * @var mixed
     */
    protected mixed $item;

    /**
     * The key
     * @var int|string|null
     */
    protected int|string|null $key;

    /**
     * The exception that is raised
     * @var Throwable
     */
    protected Throwable $exception;

    /**
     * Whether need throw the exception
     * @var bool
     */
    protected bool $shouldBeThrown = true;



    /**
     * Create new instance
     * @param string $name
     * @param mixed $item
     * @param int|string|null $key
     * @param Etl $etl
     * @param Throwable $exception
     */
    public function __construct(
        string $name,
        mixed $item,
        int|string|null $key,
        Etl $etl,
        Throwable $exception
    ) {
        parent::__construct($name, $etl);
        $this->item = $item;
        $this->key = $key;
        $this->exception = $exception;
    }

    /**
     * Return the item
     * @return mixed
     */
    public function getItem(): mixed
    {
        return $this->item;
    }

    /**
     * Return the key
     * @return int|string|null
     */
    public function getKey(): int|string|null
    {
        return $this->key;
    }

    /**
     * Return the exception
     * @return Throwable
     */
    public function getException(): Throwable
    {
        return $this->exception;
    }

    /**
     * @return bool
     */
    public function shouldThrowException(): bool
    {
        return $this->shouldBeThrown;
    }


    /**
     * Exception should not be thrown.
     * And Implicitly skips the current item.
     * @return void
     */
    public function ignoreException(): void
    {
        $this->shouldBeThrown = false;
        $this->etl->skipCurrentItem();
    }
}