Erebot  latest
A modular IRC bot for PHP 7.0+
Source.php
1 <?php
2 /*
3  This file is part of Erebot, a modular IRC bot written in PHP.
4 
5  Copyright © 2010 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\Event\Match;
22 
31 class Source implements \Erebot\Interfaces\Event\Match
32 {
34  protected $source;
35 
45  public function __construct($source)
46  {
47  $this->setSource($source);
48  }
49 
56  public function getSource()
57  {
58  return $this->source;
59  }
60 
70  public function setSource($source)
71  {
72  if ($source !== null && !\Erebot\Utils::stringifiable($source)) {
73  throw new \Erebot\InvalidValueException('Not a valid nickname');
74  }
75 
76  $this->source = $source;
77  }
78 
79  public function match(\Erebot\Interfaces\Event\Base\Generic $event)
80  {
81  if (!($event instanceof \Erebot\Interfaces\Event\Base\Source)) {
82  return false;
83  }
84 
85  if ($this->source === null) {
86  return true;
87  }
88 
89  $collator = $event->getConnection()->getCollator();
90  return (
91  $collator->compare(
92  $event->getSource(),
93  (string) $this->source
94  ) == 0
95  );
96  }
97 }
$source
Source to use in the comparison, as a string.
Definition: Source.php:34
A filter which matches when the source of the event equals some predefined value. ...
Definition: Source.php:31