Erebot  latest
A modular IRC bot for PHP 7.0+
Chan.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 Chan implements \Erebot\Interfaces\Event\Match
32 {
34  protected $chan;
35 
45  public function __construct($chan)
46  {
47  $this->setChan($chan);
48  }
49 
56  public function getChan()
57  {
58  return $this->chan;
59  }
60 
70  public function setChan($chan)
71  {
72  if (!\Erebot\Utils::stringifiable($chan)) {
73  throw new \Erebot\InvalidValueException('Not a channel');
74  }
75 
76  $this->chan = $chan;
77  }
78 
79  public function match(\Erebot\Interfaces\Event\Base\Generic $event)
80  {
81  if (!($event instanceof \Erebot\Interfaces\Event\Base\Chan)) {
82  return false;
83  }
84 
85  $collator = $event->getConnection()->getCollator();
86  return (
87  $collator->compare(
88  $event->getChan(),
89  (string) $this->chan
90  ) == 0
91  );
92  }
93 }
$chan
Channel to use in the comparison, as a string.
Definition: Chan.php:34
A filter that compares the target channel for an event with some predefined value.
Definition: Chan.php:31