<?php

namespace Geeklog\Text\Wiki;

    /**
     * Parses for subscripted text.
     *
     * @category Text
     * @package  Text_Wiki
     * @author   Paul M. Jones <pmjones@php.net>
     * @license  LGPL
     * @version  $Id: Subscript.php 180691 2005-02-24 17:24:56Z pmjones $
     */

/**
 * Parses for subscripted text.
 *
 * @category Text
 * @package  Text_Wiki
 * @author   Paul M. Jones <pmjones@php.net>
 */
class Text_Wiki_Parse_Subscript extends Text_Wiki_Parse
{
    /**
     * The regular expression used to parse the source text and find
     * matches conforming to this rule.  Used by the parse() method.
     *
     * @var string
     * @see    parse()
     */
    public $regex = "/,,(()|.*),,/U";

    /**
     * Generates a replacement for the matched text.  Token options are:
     * 'type' => ['start'|'end'] The starting or ending point of the
     * emphasized text.  The text itself is left in the source.
     *
     * @param  array &$matches The array of matches from parse().
     * @return string A pair of delimited tokens to be used as a placeholder in
     *                        the source text surrounding the text to be emphasized.
     */
    public function process(&$matches)
    {
        $start = $this->wiki->addToken(
            $this->rule, array('type' => 'start')
        );

        $end = $this->wiki->addToken(
            $this->rule, array('type' => 'end')
        );

        return $start . $matches[1] . $end;
    }
}
