gnu-social/plugins/QnA/classes/QnA_Question.php

302 lines
8.6 KiB
PHP
Raw Normal View History

<?php
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// GNU social is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with GNU social. If not, see <http://www.gnu.org/licenses/>.
/**
* Data class to mark a notice as a question
*
* @category QnA
* @package GNUsocial
* @author Zach Copley <zach@status.net>
* @copyright 2011 StatusNet, Inc.
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
defined('GNUSOCIAL') || die();
/**
* For storing a question
*
* @copyright 2011 StatusNet, Inc.
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*
* @see DB_DataObject
*/
class QnA_Question extends Managed_DataObject
{
const OBJECT_TYPE = 'http://activityschema.org/object/question';
public $__table = 'qna_question'; // table name
public $id; // char(36) primary key not null -> UUID
public $uri; // varchar(191) not 255 because utf8mb4 takes more space
public $profile_id; // int -> profile.id
public $title; // text
public $description; // text
public $closed; // bool -> whether a question is closed
public $created; // datetime
/**
* The One True Thingy that must be defined and declared.
*/
public static function schemaDef()
{
return array(
'description' => 'Per-notice question data for QNA plugin',
'fields' => array(
'id' => array(
'type' => 'char',
'length' => 36,
'not null' => true,
'description' => 'UUID'
),
'uri' => array(
'type' => 'varchar',
'length' => 191,
'not null' => true
),
'profile_id' => array('type' => 'int'),
'title' => array('type' => 'text'),
'closed' => array('type' => 'bool'),
'description' => array('type' => 'text'),
'created' => array(
'type' => 'datetime',
'not null' => true
),
),
'primary key' => array('id'),
'unique keys' => array(
'question_uri_key' => array('uri'),
),
);
}
/**
* Get a question based on a notice
*
* @param Notice $notice Notice to check for
*
* @return Question found question or null
*/
public static function getByNotice($notice)
{
return self::getKV('uri', $notice->uri);
}
public function getNotice()
{
return Notice::getKV('uri', $this->uri);
}
public function getUrl()
{
return $this->getNotice()->getUrl();
}
public function getProfile()
2011-03-30 18:33:15 +01:00
{
$profile = Profile::getKV('id', $this->profile_id);
2011-03-30 18:33:15 +01:00
if (empty($profile)) {
// TRANS: Exception trown when getting a profile for a non-existing ID.
// TRANS: %s is the provided profile ID.
throw new Exception(sprintf(_m('No profile with ID %s'), $this->profile_id));
2011-03-30 18:33:15 +01:00
}
return $profile;
}
/**
* Get the answer from a particular user to this question, if any.
*
* @param Profile $profile
*
* @return Answer object or null
*/
public function getAnswer(Profile $profile)
{
$a = new QnA_Answer();
$a->question_id = $this->id;
$a->profile_id = $profile->id;
$a->find();
if ($a->fetch()) {
return $a;
} else {
return null;
}
}
public function getAnswers()
2011-03-30 18:33:15 +01:00
{
$a = new QnA_Answer();
$a->question_id = $this->id;
$cnt = $a->find();
if (!empty($cnt)) {
return $a;
} else {
return null;
}
}
public function countAnswers()
{
$a = new QnA_Answer();
$a->question_id = $this->id;
return $a->count();
}
public static function fromNotice($notice)
{
return QnA_Question::getKV('uri', $notice->uri);
}
public function asHTML()
2011-03-30 18:33:15 +01:00
{
2011-04-04 22:33:20 +01:00
return self::toHTML($this->getProfile(), $this);
2011-03-30 18:33:15 +01:00
}
public function asString()
2011-03-30 18:33:15 +01:00
{
2011-04-04 22:33:20 +01:00
return self::toString($this->getProfile(), $this);
2011-03-30 18:33:15 +01:00
}
public static function toHTML($profile, $question)
2011-03-30 18:33:15 +01:00
{
$notice = $question->getNotice();
2011-04-04 23:08:47 +01:00
$out = new XMLStringer();
$cls = array('qna_question');
if (!empty($question->closed)) {
$cls[] = 'closed';
}
$out->elementStart('p', array('class' => implode(' ', $cls)));
if (!empty($question->description)) {
$out->elementStart('span', 'question-description');
$out->raw(common_render_text($question->description));
$out->elementEnd('span');
}
$cnt = $question->countAnswers();
if (!empty($cnt)) {
$out->elementStart('span', 'answer-count');
// TRANS: Number of given answers to a question.
// TRANS: %s is the number of given answers.
$out->text(sprintf(_m('%s answer', '%s answers', $cnt), $cnt));
$out->elementEnd('span');
}
if (!empty($question->closed)) {
$out->elementStart('span', 'question-closed');
// TRANS: Notification that a question cannot be answered anymore because it is closed.
$out->text(_m('This question is closed.'));
$out->elementEnd('span');
}
2011-03-30 18:33:15 +01:00
$out->elementEnd('p');
2011-04-04 23:08:47 +01:00
return $out->getString();
2011-03-30 18:33:15 +01:00
}
public static function toString($profile, $question, $answers)
2011-03-30 18:33:15 +01:00
{
2011-04-04 22:33:20 +01:00
return sprintf(htmlspecialchars($question->description));
2011-03-30 18:33:15 +01:00
}
/**
* Save a new question notice
*
* @param Profile $profile
* @param string $question
* @param string $title
* @param string $description
* @param array $option // and whatnot
*
* @return Notice saved notice
*/
public static function saveNew($profile, $title, $description, $options = [])
{
$q = new QnA_Question();
$q->id = UUID::gen();
$q->profile_id = $profile->id;
$q->title = $title;
$q->description = $description;
if (array_key_exists('created', $options)) {
$q->created = $options['created'];
} else {
$q->created = common_sql_now();
}
if (array_key_exists('uri', $options)) {
$q->uri = $options['uri'];
} else {
$q->uri = common_local_url(
'qnashowquestion',
array('id' => $q->id)
);
}
common_log(LOG_DEBUG, "Saving question: $q->id $q->uri");
$q->insert();
if (Notice::contentTooLong($q->title . ' ' . $q->uri)) {
$max = Notice::maxContent();
$uriLen = mb_strlen($q->uri);
$targetLen = $max - ($uriLen + 15);
$title = mb_substr($q->title, 0, $targetLen) . '…';
}
$content = $title . ' ' . $q->uri;
$link = '<a href="' . htmlspecialchars($q->uri) . '">' . htmlspecialchars($q->title) . '</a>';
// TRANS: Rendered version of the notice content creating a question.
// TRANS: %s a link to the question as link description.
$rendered = sprintf(_m('Question: %s'), $link);
$tags = array('question');
$replies = array();
$options = array_merge(
array(
'urls' => array(),
'rendered' => $rendered,
'tags' => $tags,
'replies' => $replies,
'object_type' => self::OBJECT_TYPE
),
$options
);
if (!array_key_exists('uri', $options)) {
$options['uri'] = $q->uri;
}
$saved = Notice::saveNew(
$profile->id,
$content,
array_key_exists('source', $options) ?
$options['source'] : 'web',
$options
);
return $saved;
}
}