plugins/ActivitySpam/trainhamform.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * Toggle indicating spam, click to train as ham
   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  Spam
  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  * Form
  39  *
  40  * @category  Spam
  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
  48 class TrainHamForm extends Form {
  49
  50     var $notice  = null;
  51
  52     function __construct($out, $notice) {
  53         parent::__construct($out);
  54         $this->notice = $notice;
  55     }
  56
  57     /**
  58      * Name of the form
  59      *
  60      * Sub-classes should overload this with the name of their form.
  61      *
  62      * @return void
  63      */
  64
  65     function formLegend()
  66     {
  67         return _("Train ham");
  68     }
  69
  70     /**
  71      * Visible or invisible data elements
  72      *
  73      * Display the form fields that make up the data of the form.
  74      * Sub-classes should overload this to show their data.
  75      *
  76      * @return void
  77      */
  78
  79     function formData()
  80     {
  81         $this->hidden('notice', $this->notice->id);
  82     }
  83
  84     /**
  85      * Buttons for form actions
  86      *
  87      * Submit and cancel buttons (or whatever)
  88      * Sub-classes should overload this to show their own buttons.
  89      *
  90      * @return void
  91      */
  92
  93     function formActions()
  94     {
  95         $this->submit('train-ham-submit-' . $this->notice->id,
  96                       _('Clear spam'),
  97                       'submit',
  98                       null,
  99                       _("Clear spam"));
 100     }
 101
 102     /**
 103      * ID of the form
 104      *
 105      * Should be unique on the page. Sub-classes should overload this
 106      * to show their own IDs.
 107      *
 108      * @return int ID of the form
 109      */
 110
 111     function id()
 112     {
 113         return 'train-ham-' . $this->notice->id;
 114     }
 115
 116     /**
 117      * Action of the form.
 118      *
 119      * URL to post to. Should be overloaded by subclasses to give
 120      * somewhere to post to.
 121      *
 122      * @return string URL to post to
 123      */
 124
 125     function action()
 126     {
 127         return common_local_url('train', array('category' => 'ham'));
 128     }
 129
 130     /**
 131      * Class of the form. May include space-separated list of multiple classes.
 132      *
 133      * If 'ajax' is included, the form will automatically be submitted with
 134      * an 'ajax=1' parameter added, and the resulting form or error message
 135      * will replace the form after submission.
 136      *
 137      * It's up to you to make sure that the target action supports this!
 138      *
 139      * @return string the form's class
 140      */
 141
 142     function formClass()
 143     {
 144         return 'form-train-ham ajax';
 145     }
 146 }