Uplink/P10_Channel.class.php

   1 <?php
   2 /********************************* PHP-P10 ******************************
   3  *    P10 uplink class by pk910   (c)2011 pk910                         *
   4  ************************************************************************
   5  *                          Version 2 (OOP)                             *
   6  *                                                                      *
   7  * PHP-P10 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 2 of the License, or    *
  10  * (at your option) any later version.                                  *
  11  *                                                                      *
  12  * This program 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 PHP-P10; if not, write to the Free Software Foundation,   *
  19  * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.       *
  20  *                                                                      *
  21  ************************************************************************
  22  *
  23  *  Uplink/P10_Channel.class.php
  24  *
  25  * This class represents a IRC Channel
  26  *
  27  ************************************************************************
  28  * accessable methods:
  29  *
  30  * static P10_User getChannelByName(String $name)
  31  *     searches and returns the Channel with the provided name
  32  *
  33  * __construct(String $name)
  34  *     *** nothing to say here ***
  35  *
  36  */
  37
  38 class P10_Channel {
  39         private static $static_channels = array();
  40
  41         public static function getChannelByName($name) {
  42                 $name = strtolower($name);
  43                 if(array_key_exists($name, self::$static_channels)) {
  44                         return self::$static_channels[$name];
  45                 }
  46                 return NULL;
  47         }
  48
  49
  50         private $name;
  51         private $topic;
  52         private $modes;
  53         private $users = array();
  54         const USERPRIV_OPED  = 0x0001;
  55         const USERPRIV_VOICE = 0x0002;
  56         private $userPrivs = array();
  57
  58         public function __construct($name) {
  59                 $this->name = $name;
  60                 $this->modes = new P10_ChannelModeSet($this);
  61                 self::$static_channels[strtolower($name)] = $this;
  62         }
  63
  64         public function getName() {
  65                 return $this->name;
  66         }
  67
  68         public function getModes() {
  69                 return $this->modes;
  70         }
  71
  72         public function setTopic($topic) {
  73                 $this->topic = $topic;
  74         }
  75
  76         public function getTopic() {
  77                 return $this->topic;
  78         }
  79
  80         public function joinUser($user) {
  81                 $this->users[$user->getNumeric()] = $user;
  82                 $this->userPrivs[$user->getNumeric()] = 0;
  83                 $user->addChannel($this);
  84         }
  85
  86         public function burstUser($user, $opped, $voiced) {
  87                 $this->users[$user->getNumeric()] = $user;
  88                 $this->userPrivs[$user->getNumeric()] = ($opped ? self::USERPRIV_OPED : 0) | ($voiced ? self::USERPRIV_VOICE : 0);
  89                 $user->addChannel($this);
  90         }
  91
  92         public function quitUser($user) {
  93                 if(array_key_exists($user->getNumeric(), $this->users)) {
  94                         unset($this->users[$user->getNumeric()]);
  95                         unset($this->userPrivs[$user->getNumeric()]);
  96                         //$user->delChannel($this)  is not necessary because the user quits (the whole Object gets removed later)
  97                 } else {
  98                         trigger_error("Tried to quit a User from a Channel it is not joined.", E_USER_WARNING);
  99                 }
 100         }
 101
 102         public function partUser($user) {
 103                 if(array_key_exists($user->getNumeric(), $this->users)) {
 104                         unset($this->users[$user->getNumeric()]);
 105                         unset($this->userPrivs[$user->getNumeric()]);
 106                         $user->delChannel($this);
 107                 } else {
 108                         trigger_error("Tried to part a User from a Channel it is not joined.", E_USER_WARNING);
 109                 }
 110         }
 111
 112         public function getUserPrivs($user) {
 113                 if(array_key_exists($user->getNumeric(), $this->users)) {
 114                         return $this->userPrivs[$user->getNumeric()];
 115                 } else
 116                         return 0;
 117         }
 118
 119         public function setUserPrivs($user, $privs) {
 120                 if(array_key_exists($user->getNumeric(), $this->users)) {
 121                         $this->userPrivs[$user->getNumeric()] = $privs;
 122                 }
 123         }
 124
 125 }
 126
 127 ?>