PaymentCoreEvents.php

<?php

/*
 * This file is part of the PaymentSuite package.
 *
 * Copyright (c) 2013-2016 Marc Morera
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * Feel free to edit as you please, and have fun.
 *
 * @author Marc Morera <yuhu@mmoreram.com>
 */

namespace PaymentSuite\PaymentCoreBundle;

/**
 * This class define all events thrown by all payment method.
 */
final class PaymentCoreEvents
{
    /**
     * This event is thrown when an order must be created.
     *
     * event.name : payment.order.load
     * event.class : PaymentOrderLoadEvent
     */
    const PAYMENT_ORDER_LOAD = 'payment.order.load';

    /**
     * This event is thrown when an order must be created.
     *
     * event.name : payment.order.created
     * event.class : PaymentOrderCreatedEvent
     */
    const PAYMENT_ORDER_CREATED = 'payment.order.created';

    /**
     * This event is thrown when an order is paid, no matter the result.
     *
     * event.name : payment.order.done
     * event.class : PaymentDoneEvent
     */
    const PAYMENT_ORDER_DONE = 'payment.order.done';

    /**
     * This event is thrown when an order is paid succesfuly.
     *
     * event.name : payment.order.success
     * event.class : PaymentOrderSuccessEvent
     */
    const PAYMENT_ORDER_SUCCESS = 'payment.order.success';

    /**
     * This event is thrown when an order can't be paid for any reason.
     *
     * event.name : payment.order.fail
     * event.class : PaymentOrderFailEvent
     */
    const PAYMENT_ORDER_FAIL = 'payment.order.fail';
}