Erebot  latest
A modular IRC bot for PHP 5.3+
HelpEnabled.php
1 <?php
2 /*
3  This file is part of Erebot, a modular IRC bot written in PHP.
4 
5  Copyright © 2013 François Poirotte
6 
7  Erebot is free software: you can redistribute it and/or modify
8  it under the terms of the GNU General Public License as published by
9  the Free Software Foundation, either version 3 of the License, or
10  (at your option) any later version.
11 
12  Erebot is distributed in the hope that it will be useful,
13  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  GNU General Public License for more details.
16 
17  You should have received a copy of the GNU General Public License
18  along with Erebot. If not, see <http://www.gnu.org/licenses/>.
19 */
20 
21 namespace Erebot\Interfaces;
22 
31 interface HelpEnabled
32 {
53  public function getHelp(
54  \Erebot\Interfaces\Event\Base\TextMessage $event,
55  \Erebot\Interfaces\TextWrapper $words
56  );
57 }
Definition: CLI.php:21
getHelp(\Erebot\Interfaces\Event\Base\TextMessage $event,\Erebot\Interfaces\TextWrapper $words)
Interface for a text wrapper that makes it easier to manipulate text.
Definition: TextWrapper.php:28
Interface for a module that implements an help method.
Definition: HelpEnabled.php:31