     1: <?php
     2:
     3: /**
     4:  *
     5:  * An interface that contains the methods for a code highlight implementation
     6:  * that is used in the CMS to colour highlight source code for publication.
     7:  *
     8:  * @package alpha::util::codehighlight
     9:  * @since 1.2
    10:  * @author John Collins <dev@alphaframework.org>
    11:  * @version $Id: AlphaHighlightProviderInterface.inc 1492 2012-02-01 20:03:35Z johnc $
    12:  * @license http://www.opensource.org/licenses/bsd-license.php The BSD License
    13:  * @copyright Copyright (c) 2012, John Collins (founder of Alpha Framework).
    14:  * All rights reserved.
    15:  *
    16:  * <pre>
    17:  * Redistribution and use in source and binary forms, with or
    18:  * without modification, are permitted provided that the
    19:  * following conditions are met:
    20:  *
    21:  * * Redistributions of source code must retain the above
    22:  *   copyright notice, this list of conditions and the
    23:  *   following disclaimer.
    24:  * * Redistributions in binary form must reproduce the above
    25:  *   copyright notice, this list of conditions and the
    26:  *   following disclaimer in the documentation and/or other
    27:  *   materials provided with the distribution.
    28:  * * Neither the name of the Alpha Framework nor the names
    29:  *   of its contributors may be used to endorse or promote
    30:  *   products derived from this software without specific
    31:  *   prior written permission.
    32:  *
    33:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
    34:  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
    35:  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
    36:  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    37:  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
    38:  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    39:  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
    40:  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
    41:  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    42:  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    43:  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
    44:  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
    45:  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    46:  * </pre>
    47:  *
    48:  */
    49: interface AlphaHighlightProviderInterface {
    50:     /**
    51:      * Highlights the text provided using colours to make the source code within the
    52:      * text more readable for humans.
    53:      *
    54:      * @param string $source The source code string.
    55:      * @param string $language The language identifier that will be passed as-is to the implementing class.
    56:      * @return string The colour-highlighted code.
    57:      * @since 1.2
    58:      */
    59:     public function highlight($source, $language);
    60: }
    61:
    62: ?>