plugins/GroupPrivateMessage/groupmessagecommand.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * Command object for messages to groups
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  Command
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2011 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * Command object for messages to groups
  39  *
  40  * @category  General
  41  * @package   StatusNet
  42  * @author    Evan Prodromou <evan@status.net>
  43  * @copyright 2011 StatusNet, Inc.
  44  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  45  * @link      http://status.net/
  46  */
  47 class GroupMessageCommand extends Command
  48 {
  49     /** User sending the message. */
  50     var $user;
  51     /** Nickname of the group they're sending to. */
  52     var $nickname;
  53     /** Text of the message. */
  54     var $text;
  55
  56     /**
  57      * Constructor
  58      *
  59      * @param User   $user     User sending the message
  60      * @param string $nickname Nickname of the group
  61      * @param string $text     Text of message
  62      */
  63     function __construct($user, $nickname, $text)
  64     {
  65         $this->user     = $user;
  66         $this->nickname = $nickname;
  67         $this->text     = $text;
  68     }
  69
  70     function handle($channel)
  71     {
  72         // Throws a command exception if group not found
  73         $group = $this->getGroup($this->nickname);
  74
  75         $gm = Group_message::send($this->user, $group, $this->text);
  76
  77         $channel->output($this->user,
  78                          // TRANS: Succes message after sending private group message to group %s.
  79                          sprintf(_m('Direct message to group %s sent.'),
  80                                  $group->nickname));
  81
  82         return true;
  83     }
  84 }