plugins/QnA/lib/qnashowanswerform.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Form for showing / revising an answer
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Form
  23  * @package   StatusNet
  24  * @author    Zach Copley <zach@status.net>
  25  * @copyright 2011 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR . '/lib/form.php';
  35
  36 /**
  37  * Form for showing / revising an answer
  38  *
  39  * @category Form
  40  * @package  StatusNet
  41  * @author   Zach Copley <zach@status.net>
  42  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  43  * @link     http://status.net/
  44  *
  45  */
  46 class QnashowanswerForm extends Form
  47 {
  48     /**
  49      * The answer to show
  50      */
  51     protected $answer   = null;
  52
  53     /**
  54      * The question this is an answer to
  55      */
  56     protected $question = null;
  57
  58     /**
  59      * Constructor
  60      *
  61      * @param HTMLOutputter $out    output channel
  62      * @param QnA_Answer    $answer answer to revise
  63      */
  64     function __construct($out = null, $answer = null)
  65     {
  66         parent::__construct($out);
  67
  68         $this->answer   = $answer;
  69         $this->question = $answer->getQuestion();
  70     }
  71
  72     /**
  73      * ID of the form
  74      *
  75      * @return int ID of the form
  76      */
  77     function id()
  78     {
  79         return 'show-' . $this->answer->id;
  80     }
  81
  82     /**
  83      * Action of the form
  84      *
  85      * @return string URL of the action
  86      */
  87     function action()
  88     {
  89         return common_local_url('qnareviseanswer');
  90     }
  91
  92     /**
  93      * Include a session token for CSRF protection
  94      *
  95      * @return void
  96      */
  97     function sessionToken()
  98     {
  99         $this->out->hidden(
 100             'token',
 101             common_session_token()
 102         );
 103     }
 104
 105     /**
 106      * Legend of the Form
 107      *
 108      * @return void
 109      */
 110     function formLegend()
 111     {
 112         // TRANS: Form legend for showing the answer.
 113         $this->out->element('legend', null, _m('Answer'));
 114     }
 115
 116     /**
 117      * Data elements
 118      *
 119      * @return void
 120      */
 121     function formData()
 122     {
 123         $this->out->hidden(
 124             'qna-answer-id',
 125             'answer-' . $this->answer->id,
 126             'id'
 127         );
 128
 129         $this->out->raw($this->answer->asHTML());
 130     }
 131
 132     /**
 133      * Action elements
 134      *
 135      * @return void
 136      */
 137     function formActions()
 138     {
 139         $user = common_current_user();
 140         if (empty($user)) {
 141             return;
 142         }
 143
 144         if (empty($this->question->closed)) {
 145             if ($user->id == $this->question->profile_id) {
 146                 if (empty($this->answer->best)) {
 147                     $this->out->submit(
 148                         'qna-best-answer',
 149                         // TRANS: Button text for marking an answer as "best".
 150                         _m('BUTTON', 'Best'),
 151                         'submit',
 152                         'best',
 153                         // TRANS: Title for button text marking an answer as "best".
 154                         _m('Mark this answer as the best answer.')
 155                     );
 156
 157                 }
 158             }
 159
 160             /*
 161              * @todo FIXME: Revise is disabled until we figure out the
 162              *         Ostatus bits This comment is just a reminder
 163              *         that the UI for this works.
 164              */
 165             /*
 166             if ($user->id == $this->answer->profile_id) {
 167                 $this->out->submit(
 168                     'revise',
 169                     // TRANS: Button text for revising an answer.
 170                     _m('BUTTON', 'Revise'),
 171                     'submit',
 172                     null,
 173                     // TRANS: Title for button text for revising an answer.
 174                     _m('Revise your answer.')
 175                 );
 176             }
 177              */
 178         }
 179     }
 180
 181     /**
 182      * Class of the form.
 183      *
 184      * @return string the form's class
 185      */
 186     function formClass()
 187     {
 188         return 'form_answer_show ajax';
 189     }
 190 }