Merge branch '6.0'

[GitHub/WoltLab/WCF.git] / wcfsetup / install / files / lib / data / IMessage.class.php

<?php

namespace wcf\data;

/**
 * Default interface for message database objects.
 *
 * @author  Alexander Ebert
 * @copyright   2001-2019 WoltLab GmbH
 * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
 */
interface IMessage extends IUserContent
{
    /**
     * Returns a simplified message (only inline codes), truncated to 255 characters by default.
     *
     * @param int $maxLength
     * @return  string
     */
    public function getExcerpt($maxLength = 255);

    /**
     * Returns formatted message text.
     *
     * @return  string
     */
    public function getFormattedMessage();

    /**
     * Returns message text.
     *
     * @return  string
     */
    public function getMessage();

    /**
     * Returns true, if message is visible for current user.
     *
     * @return  bool
     */
    public function isVisible();

    /**
     * Returns formatted message text.
     *
     * @see \wcf\data\IMessage::getFormattedMessage()
     */
    public function __toString();
}