3 * Data class to save answers to questions
9 * @author Zach Copley <zach@status.net>
10 * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
11 * @link http://status.net/
13 * StatusNet - the distributed open-source microblogging tool
14 * Copyright (C) 2011, StatusNet, Inc.
16 * This program is free software: you can redistribute it and/or modify
17 * it under the terms of the GNU Affero General Public License as published by
18 * the Free Software Foundation, either version 3 of the License, or
19 * (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU Affero General Public License for more details.
26 * You should have received a copy of the GNU Affero General Public License
27 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 if (!defined('STATUSNET')) {
39 * @author Zach Copley <zach@status.net>
40 * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
41 * @link http://status.net/
45 class QnA_Answer extends Managed_DataObject
47 const OBJECT_TYPE = 'http://activityschema.org/object/answer';
49 public $__table = 'qna_answer'; // table name
50 public $id; // char(36) primary key not null -> UUID
51 public $question_id; // char(36) -> question.id UUID
52 public $profile_id; // int -> question.id
53 public $best; // (boolean) int -> whether the question asker has marked this as the best answer
54 public $revisions; // int -> count of revisions to this answer
55 public $content; // text -> response text
56 public $created; // datetime
59 * Get an instance by compound key
61 * This is a utility method to get a single instance with a given set of
62 * key-value pairs. Usually used for the primary key for a compound key; thus
65 * @param array $kv array of key-value mappings
67 * @return QA_Answer object found, or null for no hits
72 return Memcached_DataObject::pkeyGet('QnA_Answer', $kv);
76 * The One True Thingy that must be defined and declared.
78 public static function schemaDef()
81 'description' => 'Record of answers to questions',
86 'not null' => true, 'description' => 'UUID of the response'),
91 'description' => 'UUID to the answer notice'
93 'question_id' => array(
97 'description' => 'UUID of question being responded to'
99 'content' => array('type' => 'text'), // got a better name?
100 'best' => array('type' => 'int', 'size' => 'tiny'),
101 'revisions' => array('type' => 'int'),
102 'profile_id' => array('type' => 'int'),
103 'created' => array('type' => 'datetime', 'not null' => true),
105 'primary key' => array('id'),
106 'unique keys' => array(
107 'question_uri_key' => array('uri'),
108 'question_id_profile_id_key' => array('question_id', 'profile_id'),
111 'profile_id_question_id_index' => array('profile_id', 'question_id'),
117 * Get an answer based on a notice
119 * @param Notice $notice Notice to check for
121 * @return QnA_Answer found response or null
123 function getByNotice($notice)
125 $answer = self::staticGet('uri', $notice->uri);
126 if (empty($answer)) {
127 throw new Exception("No answer with URI {$notice->uri}");
133 * Get the notice that belongs to this answer
139 return Notice::staticGet('uri', $this->uri);
142 static function fromNotice($notice)
144 return QnA_Answer::staticGet('uri', $notice->uri);
149 return $this->getNotice()->bestUrl();
153 * Get the Question this is an answer to
155 * @return QnA_Question
157 function getQuestion()
159 $question = QnA_Question::staticGet('id', $this->question_id);
160 if (empty($question)) {
161 // TRANS: Exception thown when getting a question with a non-existing ID.
162 // TRANS: %s is the non-existing question ID.
163 throw new Exception(sprintf(_m('No question with ID %s'),$this->question_id));
168 function getProfile()
170 $profile = Profile::staticGet('id', $this->profile_id);
171 if (empty($profile)) {
172 // TRANS: Exception thown when getting a profile with a non-existing ID.
173 // TRANS: %s is the non-existing profile ID.
174 throw new Exception(sprintf(_m('No profile with ID %s'),$this->profile_id));
183 $this->getQuestion(),
190 return self::toString(
192 $this->getQuestion(),
197 static function toHTML($profile, $question, $answer)
199 $notice = $question->getNotice();
201 $out = new XMLStringer();
203 $cls = array('qna_answer');
204 if (!empty($answer->best)) {
208 $out->elementStart('p', array('class' => implode(' ', $cls)));
209 $out->elementStart('span', 'answer-content');
210 $out->raw(common_render_text($answer->content));
211 $out->elementEnd('span');
213 if (!empty($answer->revisions)) {
214 $out->elementstart('span', 'answer-revisions');
217 // Notification of how often an answer was revised.
218 // TRANS: %s is the number of answer revisions.
219 sprintf(_m('%s revision','%s revisions',$answer->revisions), $answer->revisions)
222 $out->elementEnd('span');
225 $out->elementEnd('p');
227 return $out->getString();
230 static function toString($profile, $question, $answer)
232 // @todo FIXME: unused variable?
233 $notice = $question->getNotice();
236 // TRANS: Text for a question that was answered.
237 // TRANS: %1$s is the user that answered, %2$s is the question title,
238 // TRANS: %2$s is the answer content.
239 _m('%1$s answered the question "%2$s": %3$s'),
240 htmlspecialchars($profile->getBestName()),
241 htmlspecialchars($question->title),
242 htmlspecialchars($answer->content)
247 * Save a new answer notice
249 * @param Profile $profile
250 * @param Question $Question the question being answered
253 * @return Notice saved notice
255 static function saveNew($profile, $question, $text, $options = null)
257 if (empty($options)) {
261 $answer = new QnA_Answer();
262 $answer->id = UUID::gen();
263 $answer->profile_id = $profile->id;
264 $answer->question_id = $question->id;
265 $answer->revisions = 0;
267 $answer->content = $text;
268 $answer->created = common_sql_now();
269 $answer->uri = common_local_url(
271 array('id' => $answer->id)
274 common_log(LOG_DEBUG, "Saving answer: $answer->id, $answer->uri");
278 // TRANS: Text for a question that was answered.
279 // TRANS: %s is the question title.
284 $link = '<a href="' . htmlspecialchars($answer->uri) . '">' . htmlspecialchars($question->title) . '</a>';
285 // TRANS: Rendered version of the notice content answering a question.
286 // TRANS: %s a link to the question with question title as the link content.
287 $rendered = sprintf(_m('answered "%s"'), $link);
292 $options = array_merge(
295 'content' => $content,
296 'rendered' => $rendered,
298 'replies' => $replies,
299 'reply_to' => $question->getNotice()->id,
300 'object_type' => self::OBJECT_TYPE
305 if (!array_key_exists('uri', $options)) {
306 $options['uri'] = $answer->uri;
309 $saved = Notice::saveNew(
312 array_key_exists('source', $options) ?
313 $options['source'] : 'web',