StylingInterface.php

<?php
/*
    This file is part of Erebot, a modular IRC bot written in PHP.

    Copyright © 2010 François Poirotte

    Erebot is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Erebot is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Erebot.  If not, see <http://www.gnu.org/licenses/>.
*/

namespace Erebot;

interface StylingInterface
{
    // Control codes.

    const CODE_BOLD         = "\002";
    const CODE_COLOR        = "\003";
    const CODE_RESET        = "\017";
    const CODE_REVERSE      = "\026";
    const CODE_UNDERLINE    = "\037";


    // mIRC/PIRCH colors.

    const COLOR_WHITE       = 0;
    const COLOR_BLACK       = 1;
    const COLOR_BLUE        = 2;
    const COLOR_NAVY_BLUE   = 2;
    const COLOR_DARK_BLUE   = 2;
    const COLOR_GREEN       = 3;
    const COLOR_DARK_GREEN  = 3;
    const COLOR_RED         = 4;
    const COLOR_BROWN       = 5;
    const COLOR_PURPLE      = 6;
    const COLOR_ORANGE      = 7;
    const COLOR_OLIVE       = 7;
    const COLOR_YELLOW      = 8;
    const COLOR_LIGHT_GREEN = 9;
    const COLOR_LIME_GREEN  = 9;
    const COLOR_CYAN        = 10;
    const COLOR_TEAL        = 10;
    const COLOR_DARK_CYAN   = 10;
    const COLOR_LIGHT_CYAN  = 11;
    const COLOR_AQUA_LIGHT  = 11;
    const COLOR_LIGHT_BLUE  = 12;
    const COLOR_ROYAL_BLUE  = 12;
    const COLOR_PINK        = 13;
    const COLOR_HOT_PINK    = 13;
    const COLOR_GRAY        = 14;
    const COLOR_GREY        = 14;
    const COLOR_DARK_GRAY   = 14;
    const COLOR_DARK_GREY   = 14;
    const COLOR_LIGHT_GRAY  = 15;
    const COLOR_LIGHT_GREY  = 15;

    public function __construct(\Erebot\IntlInterface $translator);

    public function _($template, array $vars = array());
    // @codingStandardsIgnoreEnd

    public function render($template, array $vars = array());

    public function getTranslator();
}