fab2s\NodalFlow\Callbacks\CallbackAbstract

Complexity

Total Complexity

4

Size/Duplication

Total Lines	43
Duplicated Lines	0 %

Importance

Changes	2
Bugs	1	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	fail()	0	2	1
A	progress()	0	2	1
A	start()	0	2	1
A	success()	0	2	1

<?php

/*
 * This file is part of NodalFlow.
 *     (c) Fabrice de Stefanis / https://github.com/fab2s/NodalFlow
 * This source file is licensed under the MIT license which you will
 * find in the LICENSE file or at https://opensource.org/licenses/MIT
 */

namespace fab2s\NodalFlow\Callbacks;

use fab2s\NodalFlow\Flows\FlowInterface;
use fab2s\NodalFlow\Nodes\NodeInterface;

/**
 * Abstract Class CallbackAbstract
 * Provide with dummy implementations to allow partial
 * and DRY usage (eg actually use some of the events)
 *
 * @deprecated use FlowEvent or implement FlowEventInterface instead
 */
abstract class CallbackAbstract implements CallbackInterface

The interface fab2s\NodalFlow\Callbacks\CallbackInterface has been deprecated: use FlowEvent or implement FlowEventInterface instead

{
    /**
     * Triggered when a Flow starts
     *
     * @param FlowInterface $flow
     */
    public function start(FlowInterface $flow)
    {
    }

    /**
     * Triggered when a Flow progresses,
     * eg exec once or generates once
     *
     * @param FlowInterface $flow
     * @param NodeInterface $node
     */
    public function progress(FlowInterface $flow, NodeInterface $node)
    {
    }

    /**
     * Triggered when a Flow completes without exceptions
     *
     * @param FlowInterface $flow
     */
    public function success(FlowInterface $flow)
    {
        /*
         * `if ($flow->getFlowStatus()->isDirty()) {
         *      // a node broke the flow
         * }`
         */
    }

    /**
     * Triggered when a Flow fails
     *
     * @param FlowInterface $flow
     */
    public function fail(FlowInterface $flow)
    {
    }
}