TextAbstract.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\Event\Match;

abstract class TextAbstract implements \Erebot\Interfaces\Event\Match
{
    protected $pattern;

    protected $requirePrefix;

    public function __construct($pattern, $requirePrefix = false)
    {
        $this->setPattern($pattern);
        $this->setPrefixRequirement($requirePrefix);
    }

    public function getPattern()
    {
        return $this->pattern;
    }

    public function setPattern($pattern)
    {
        if (!\Erebot\Utils::stringifiable($pattern)) {
            throw new \Erebot\InvalidValueException('Pattern must be a string');
        }

        $this->pattern = $pattern;
    }

    public function getPrefixRequirement()
    {
        return $this->requirePrefix;
    }

    public function setPrefixRequirement($requirePrefix = false)
    {
        if ($requirePrefix !== null && !is_bool($requirePrefix)) {
            throw new \Erebot\InvalidValueException(
                '$requirePrefix must be a boolean or null'
            );
        }

        $this->requirePrefix = $requirePrefix;
    }

    public function match(\Erebot\Interfaces\Event\Base\Generic $event)
    {
        if (!($event instanceof \Erebot\Interfaces\Event\Base\Text)) {
            return false;
        }

        $prefix = $event
            ->getConnection()->getConfig(null)
            ->getMainCfg()->getCommandsPrefix();

        $result = $this->realMatch($prefix, $event->getText());
        if (!is_bool($result)) {
            throw new \Erebot\InvalidValueException('Invalid return value');
        }
        return $result;
    }

    abstract protected function realMatch($prefix, $text);
}