Miliooo\Messaging\Helpers\FlashMessages\FlashMessageProviderInterface

Size/Duplication

Total Lines	14
Duplicated Lines	0 %

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
	addFlash()	0	1	?

<?php

/*
 * This file is part of the MilioooMessageBundle package.
 *
 * (c) Michiel boeckaert <boeckaert@gmail.com>
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Miliooo\Messaging\Helpers\FlashMessages;

/**
 * The flash message provider is responsible for providing translated flash keys to the user.
 *
 * @author Michiel Boeckaert <boeckaert@gmail.com>
 */
interface FlashMessageProviderInterface
{
    const TYPE_SUCCESS = 'success';
    const TYPE_ERROR = 'error';

    /**
     * Adds a flash message we will display to the user.
     *
     * @param string $type           One of the class constants type
     * @param string $translationKey A translation string
     * @param array  $parameters     Optional parameters for the translation of the string.
     */
    public function addFlash($type, $translationKey, $parameters = []);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

}