Base.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\NumericProfile;

abstract class Base implements \ArrayAccess
{
    const ERR_ALREADYREGISTERED     = 'ERR_ALREADYREGISTRED';
    const ERR_ALREADYREGISTRED      = 'ERR_ALREADYREGISTERED';

    const ERR_CANTCHANGENICK        = 'ERR_NONICKCHANGE';
    const ERR_NONICKCHANGE          = 'ERR_CANTCHANGENICK';

    const ERR_CANTJOINOPERSONLY     = 'ERR_OPERONLY';
    const ERR_OPERONLY              = 'ERR_OPERONLYCHAN';
    const ERR_OPERONLYCHAN          = 'ERR_CANTJOINOPERSONLY';

    const ERR_CHANOPPRIVSNEEDED     = 'ERR_CHANOPRIVSNEEDED';
    const ERR_CHANOPRIVSNEEDED      = 'ERR_CHANOPPRIVSNEEDED';

    const ERR_KICKNOREJOIN          = 'ERR_DELAYREJOIN';
    const ERR_DELAYREJOIN           = 'ERR_KICKNOREJOIN';

    const ERR_LAST_ERR_MSG          = 'ERR_NUMERICERR';
    const ERR_NUMERICERR            = 'ERR_NUMERIC_ERR';
    const ERR_NUMERIC_ERR           = 'ERR_LAST_ERR_MSG';

    const ERR_NCHANGETOOFAST        = 'ERR_NICKTOOFAST';
    const ERR_NICKTOOFAST           = 'ERR_NCHANGETOOFAST';

    const ERR_NEEDPONG              = 'ERR_BADPING';
    const ERR_BADPING               = 'ERR_NEEDPONG';

    const ERR_NOCTCP                = 'ERR_NOCTCPALLOWED';
    const ERR_NOCTCPALLOWED         = 'ERR_NOCTCP';

    const ERR_NOSWEAR               = 'ERR_WORDFILTERED';
    const ERR_WORDFILTERED          = 'ERR_NOSWEAR';

    const ERR_NOTSSLCLIENT          = 'ERR_NOSSL';
    const ERR_NOSSL                 = 'ERR_NOTSSLCLIENT';

    const ERR_STARTTLS              = 'ERR_STARTTLSFAIL';
    const ERR_STARTTLSFAIL          = 'ERR_STARTTLS';

    const ERR_TARGETTOFAST          = 'ERR_TARGETTOOFAST';
    const ERR_TARGETTOOFAST         = 'ERR_TARGETTOFAST';

    const RPL_CHANNELCREATED        = 'RPL_CREATIONTIME';
    const RPL_CREATIONTIME          = 'RPL_CHANNELCREATED';

    const RPL_ENDMAP                = 'RPL_MAPEND';
    const RPL_MAPEND                = 'RPL_ENDMAP';

    const RPL_ENDOFTRACE            = 'RPL_TRACEEND';
    const RPL_TRACEEND              = 'RPL_ENDOFTRACE';

    const RPL_EXEMPTLIST            = 'RPL_EXLIST';
    const RPL_EXLIST                = 'RPL_EXCEPTLIST';
    const RPL_EXCEPTLIST            = 'RPL_EXEMPTLIST';

    const RPL_INVEXLIST             = 'RPL_INVITELIST';
    const RPL_INVITELIST            = 'RPL_INVEXLIST';

    const RPL_LISTSYNTAX            = 'RPL_COMMANDSYNTAX';
    const RPL_COMMANDSYNTAX         = 'RPL_LISTSYNTAX';

    const RPL_ENDOFEXEMPTLIST       = 'RPL_ENDOFEXLIST';
    const RPL_ENDOFEXLIST           = 'RPL_ENDOFEXCEPTLIST';
    const RPL_ENDOFEXCEPTLIST       = 'RPL_ENDOFEXEMPTLIST';

    const RPL_ENDOFINVEXLIST        = 'RPL_ENDOFINVITELIST';
    const RPL_ENDOFINVITELIST       = 'RPL_ENDOFINVEXLIST';

    const RPL_LOAD2HI               = 'RPL_TRYAGAIN';
    const RPL_TRYAGAIN              = 'RPL_LOAD2HI';

    const RPL_NAMEREPLY             = 'RPL_NAMREPLY';
    const RPL_NAMREPLY              = 'RPL_NAMEREPLY';

    const RPL_REDIR                 = 'RPL_BOUNCE';
    const RPL_BOUNCE                = 'RPL_REDIR';

    const RPL_RULESEND              = 'RPL_ENDOFRULES';
    const RPL_ENDOFRULES            = 'RPL_RULESEND';

    const RPL_RULESSTART            = 'RPL_RULESTART';
    const RPL_RULESTART             = 'RPL_RULESSTART';

    const RPL_SERVERCREATED         = 'RPL_CREATED';
    const RPL_CREATED               = 'RPL_SERVERCREATED';

    const RPL_SERVERVERSION         = 'RPL_MYINFO';
    const RPL_MYINFO                = 'RPL_SERVERVERSION';

    const RPL_STARTTLS              = 'RPL_STARTTLSOK';
    const RPL_STARTTLSOK            = 'RPL_STARTTLS';

    const RPL_TOPICTIME             = 'RPL_TOPICWHOTIME';
    const RPL_TOPICWHOTIME          = 'RPL_TOPICTIME';

    const RPL_WHOISSECURE           = 'RPL_USINGSSL';
    const RPL_USINGSSL              = 'RPL_WHOISSECURE';

    const RPL_YOUAREOPER            = 'RPL_YOUREOPER';
    const RPL_YOUREOPER             = 'RPL_YOUAREOPER';

    const RPL_YOURHOSTIS            = 'RPL_YOURHOST';
    const RPL_YOURHOST              = 'RPL_YOURHOSTIS';

    const RPL_YOURUUID              = 'RPL_YOURID';
    const RPL_YOURID                = 'RPL_YOURUUID';


    protected $reflector;


    final public function __construct()
    {
        $this->reflector = new \ReflectionClass(get_called_class());
    }

    public function offsetExists($offset)
    {
        return ($this[$offset] !== null);
    }

    public function offsetGet($offset)
    {
        if (!is_string($offset)) {
            throw new \Erebot\InvalidValueException('Not a valid name');
        }

        $seen   = array();
        $name   = strtoupper($offset);
        while (!in_array($name, $seen)) {
            $seen[] = $name;

            if (!$this->reflector->hasConstant($name)) {
                return null;
            }
            $constValue = $this->reflector->getConstant($name);

            if (is_int($constValue) &&
                $constValue > 0 &&
                $constValue <= 999) {
                return $constValue;
            }

            if (is_string($constValue)) {
                $name = strtoupper($constValue);
                continue;
            }

            return null;
        }
        throw new \Erebot\InvalidValueException('Loop detected');
    }

    public function offsetSet($offset, $value)
    {
        throw new \Erebot\NotImplementedException();
    }

    public function offsetUnset($offset)
    {
        throw new \Erebot\NotImplementedException();
    }
}