Source of file MessageproviderExtendedInterface.php

Size: 1,582 Bytes - Last Modified: 2016-05-18T03:08:27+02:00

buildproject/core/module_system/system/messageproviders/MessageproviderExtendedInterface.php

123456789101112131415161718192021222324252627282930313233343536373839404142434445
<?php
/*"******************************************************************************************************
*   (c) 2007-2016 by Kajona, www.kajona.de                                                              *
*       Published under the GNU LGPL v2.1, see /system/licence_lgpl.txt                                 *
********************************************************************************************************/

namespace Kajona\System\System\Messageproviders;

/**
 * The extended interface adds some special configuration options to messageproviders.
 * This includes whether it is allowed to switch of a messageprovider or some default values, such as enabled by mail by default.
 *
 * @author sidler@mulchprod.de
 * @since 4.3
 * @package module_messaging
 */
interface MessageproviderExtendedInterface extends MessageproviderInterface {

    /**
     * If set to true, the messageprovider may not be disabled by the user.
     * Messages are always sent to the user.
     *
     * @return bool
     */
    public function isAlwaysActive();

    /**
     * If set to true, all messages sent by this provider will be sent by mail, too.
     * The user is not allowed to disable the by-mail flag.
     * Set this to true with care.
     *
     * @return mixed
     */
    public function isAlwaysByMail();

    /**
     * This method is queried when the config-view is rendered.
     * It controls whether a message-provider is shown in the config-view or not.
     *
     * @return bool
     * @since 4.5
     */
    public function isVisibleInConfigView();

}