X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=plugins%2FQnA%2FQnAPlugin.php;h=8aa3247f9ae9ba4b52535d765b583ecef80db9dd;hb=3f9a16dc587b86b8912bc5a00dd1800c6475f73d;hp=992641b18e13684be5f888eda972e697a8e68041;hpb=c1a27922ba738f71b100a520e5db6f32985a307b;p=quix0rs-gnu-social.git diff --git a/plugins/QnA/QnAPlugin.php b/plugins/QnA/QnAPlugin.php index 992641b18e..8aa3247f9a 100644 --- a/plugins/QnA/QnAPlugin.php +++ b/plugins/QnA/QnAPlugin.php @@ -65,42 +65,8 @@ class QnAPlugin extends MicroAppPlugin return true; } - /** - * Load related modules when needed - * - * @param string $cls Name of the class to be loaded - * - * @return boolean hook value; true means continue processing, false means stop. - */ - function onAutoload($cls) - { - $dir = dirname(__FILE__); - - switch ($cls) - { - case 'QnanewquestionAction': - case 'QnanewanswerAction': - case 'QnashowquestionAction': - case 'QnashowanswerAction': - case 'QnavoteAction': - include_once $dir . '/actions/' - . strtolower(mb_substr($cls, 0, -6)) . '.php'; - return false; - case 'QnaquestionForm': - case 'QnaanswerForm': - case 'QnaansweredForm': - case 'QnavoteForm': - include_once $dir . '/lib/' . strtolower($cls).'.php'; - break; - case 'QnA_Question': - case 'QnA_Answer': - case 'QnA_Vote': - include_once $dir . '/classes/' . $cls.'.php'; - return false; - break; - default: - return true; - } + public function newFormAction() { + return 'qnanewquestion'; } /** @@ -120,9 +86,16 @@ class QnAPlugin extends MicroAppPlugin array('action' => 'qnanewquestion') ); $m->connect( - 'main/qna/newanswer/:id', - array('action' => 'qnanewanswer'), - array('id' => $UUIDregex) + 'answer/qna/closequestion', + array('action' => 'qnaclosequestion') + ); + $m->connect( + 'main/qna/newanswer', + array('action' => 'qnanewanswer') + ); + $m->connect( + 'main/qna/reviseanswer', + array('action' => 'qnareviseanswer') ); $m->connect( 'question/vote/:id', @@ -152,17 +125,19 @@ class QnAPlugin extends MicroAppPlugin { $versions[] = array( 'name' => 'QnA', - 'version' => STATUSNET_VERSION, + 'version' => GNUSOCIAL_VERSION, 'author' => 'Zach Copley', 'homepage' => 'http://status.net/wiki/Plugin:QnA', 'description' => + // TRANS: Plugin description. _m('Question and Answers micro-app.') ); return true; } function appTitle() { - return _m('Question'); + // TRANS: Application title. + return _m('TITLE','Question'); } function tag() { @@ -189,13 +164,15 @@ class QnAPlugin extends MicroAppPlugin function saveNoticeFromActivity($activity, $actor, $options=array()) { if (count($activity->objects) != 1) { - throw new Exception('Too many activity objects.'); + // TRANS: Exception thrown when there are too many activity objects. + throw new Exception(_m('Too many activity objects.')); } $questionObj = $activity->objects[0]; - if ($questinoObj->type != QnA_Question::OBJECT_TYPE) { - throw new Exception('Wrong type for object.'); + if ($questionObj->type != QnA_Question::OBJECT_TYPE) { + // TRANS: Exception thrown when an incorrect object type is encountered. + throw new Exception(_m('Wrong type for object.')); } $notice = null; @@ -210,15 +187,17 @@ class QnAPlugin extends MicroAppPlugin ); break; case Answer::ObjectType: - $question = QnA_Question::staticGet('uri', $questionObj->id); + $question = QnA_Question::getKV('uri', $questionObj->id); if (empty($question)) { // FIXME: save the question - throw new Exception("Answer to unknown question."); + // TRANS: Exception thrown when answering a non-existing question. + throw new Exception(_m('Answer to unknown question.')); } $notice = QnA_Answer::saveNew($actor, $question, $options); break; default: - throw new Exception("Unknown object type received by QnA Plugin"); + // TRANS: Exception thrown when an object type is encountered that cannot be handled. + throw new Exception(_m('Unknown object type.')); } return $notice; @@ -247,13 +226,15 @@ class QnAPlugin extends MicroAppPlugin } if (empty($question)) { - throw new Exception("Unknown object type."); + // TRANS: Exception thrown when an object type is encountered that cannot be handled. + throw new Exception(_m('Unknown object type.')); } $notice = $question->getNotice(); if (empty($notice)) { - throw new Exception("Unknown question notice."); + // TRANS: Exception thrown when requesting a non-existing question notice. + throw new Exception(_m('Unknown question notice.')); } $obj = new ActivityObject(); @@ -261,7 +242,7 @@ class QnAPlugin extends MicroAppPlugin $obj->id = $question->uri; $obj->type = QnA_Question::OBJECT_TYPE; $obj->title = $question->title; - $obj->link = $notice->bestUrl(); + $obj->link = $notice->getUrl(); // XXX: probably need other stuff here @@ -269,20 +250,66 @@ class QnAPlugin extends MicroAppPlugin } /** - * Change the verb on Answer notices + * Output our CSS class for QnA notice list elements * - * @param Notice $notice + * @param NoticeListItem $nli The item being shown * - * @return ActivityObject + * @return boolean hook value */ - function onEndNoticeAsActivity($notice, &$act) { - switch ($notice->object_type) { - case Answer::NORMAL: - case Answer::ANONYMOUS: - $act->verb = $notice->object_type; + function onStartOpenNoticeListItemElement($nli) + { + $type = $nli->notice->object_type; + + switch($type) + { + case QnA_Question::OBJECT_TYPE: + $id = (empty($nli->repeat)) ? $nli->notice->id : $nli->repeat->id; + $class = 'hentry notice question'; + if ($nli->notice->scope != 0 && $nli->notice->scope != 1) { + $class .= ' limited-scope'; + } + + $question = QnA_Question::getKV('uri', $nli->notice->uri); + + if (!empty($question->closed)) { + $class .= ' closed'; + } + + $nli->out->elementStart( + 'li', array( + 'class' => $class, + 'id' => 'notice-' . $id + ) + ); + Event::handle('EndOpenNoticeListItemElement', array($nli)); + return false; break; + case QnA_Answer::OBJECT_TYPE: + $id = (empty($nli->repeat)) ? $nli->notice->id : $nli->repeat->id; + + $cls = array('hentry', 'notice', 'answer'); + + $answer = QnA_Answer::getKV('uri', $nli->notice->uri); + + if (!empty($answer) && !empty($answer->best)) { + $cls[] = 'best'; + } + + $nli->out->elementStart( + 'li', + array( + 'class' => implode(' ', $cls), + 'id' => 'notice-' . $id + ) + ); + Event::handle('EndOpenNoticeListItemElement', array($nli)); + return false; + break; + default: + return true; } + return true; } @@ -292,7 +319,7 @@ class QnAPlugin extends MicroAppPlugin * @param Notice $notice * @param HTMLOutputter $out */ - function showNotice($notice, $out) + function showNotice(Notice $notice, $out) { switch ($notice->object_type) { case QnA_Question::OBJECT_TYPE: @@ -300,18 +327,17 @@ class QnAPlugin extends MicroAppPlugin case QnA_Answer::OBJECT_TYPE: return $this->showNoticeAnswer($notice, $out); default: - // TRANS: Exception thrown when performing an unexpected action on a question. - // TRANS: %s is the unpexpected object type. throw new Exception( - sprintf( - _m('Unexpected type for QnA plugin: %s.'), - $notice->object_type + // TRANS: Exception thrown when performing an unexpected action on a question. + // TRANS: %s is the unpexpected object type. + sprintf(_m('Unexpected type for QnA plugin: %s.'), + $notice->object_type ) ); } } - - function showNoticeQuestion($notice, $out) + + function showNoticeQuestion(Notice $notice, $out) { $user = common_current_user(); @@ -319,23 +345,18 @@ class QnAPlugin extends MicroAppPlugin $nli = new NoticeListItem($notice, $out); $nli->showNotice(); - $out->elementStart('div', array('class' => 'entry-content question-content')); + $out->elementStart('div', array('class' => 'entry-content question-description')); + $question = QnA_Question::getByNotice($notice); - - if ($question) { - if ($user) { - $profile = $user->getProfile(); - $answer = $question->getAnswer($profile); - if ($answer) { - // User has already answer; show the results. - $form = new QnaansweredForm($answer, $out); - } else { - $form = new QnaanswerForm($question, $out); - } - $form->show(); - } + + if (!empty($question)) { + + $form = new QnashowquestionForm($out, $question); + $form->show(); + } else { - $out->text(_m('Question data is missing')); + // TRANS: Error message displayed when question data is not present. + $out->text(_m('Question data is missing.')); } $out->elementEnd('div'); @@ -343,28 +364,127 @@ class QnAPlugin extends MicroAppPlugin $out->elementStart('div', array('class' => 'entry-content')); } - function showNoticeAnswer($notice, $out) + /** + * Output the HTML for this kind of object in a list + * + * @param NoticeListItem $nli The list item being shown. + * + * @return boolean hook value + * + * @todo FIXME: WARNING WARNING WARNING this closes a 'div' that is implicitly opened in BookmarkPlugin's showNotice implementation + */ + function onStartShowNoticeItem($nli) + { + if (!$this->isMyNotice($nli->notice)) { + return true; + } + + $out = $nli->out; + $notice = $nli->notice; + + $this->showNotice($notice, $out); + + $nli->showNoticeLink(); + $nli->showNoticeSource(); + $nli->showNoticeLocation(); + $nli->showContext(); + $nli->showRepeat(); + + $out->elementEnd('div'); + + $nli->showNoticeOptions(); + + if ($notice->object_type == QnA_Question::OBJECT_TYPE) { + $user = common_current_user(); + $question = QnA_Question::getByNotice($notice); + + if (!empty($user) and !empty($question)) { + $profile = $user->getProfile(); + $answer = $question->getAnswer($profile); + + // Output a placeholder input -- clicking on it will + // bring up a real answer form + + // NOTE: this whole ul is just a placeholder + if (empty($question->closed) && empty($answer)) { + $out->elementStart('ul', 'notices qna-dummy'); + $out->elementStart('li', 'qna-dummy-placeholder'); + $out->element( + 'input', + array( + 'class' => 'placeholder', + // TRANS: Placeholder value for a possible answer to a question + // TRANS: by the logged in user. + 'value' => _m('Your answer...') + ) + ); + $out->elementEnd('li'); + $out->elementEnd('ul'); + } + } + } + + return false; + } + + function showNoticeAnswer(Notice $notice, $out) { $user = common_current_user(); - // @hack we want regular rendering, then just add stuff after that + $answer = QnA_Answer::getByNotice($notice); + $question = $answer->getQuestion(); + $nli = new NoticeListItem($notice, $out); $nli->showNotice(); - // @fixme + $out->elementStart('div', array('class' => 'entry-content answer-content')); + + if (!empty($answer)) { + $form = new QnashowanswerForm($out, $answer); + $form->show(); + } else { + // TRANS: Error message displayed when answer data is not present. + $out->text(_m('Answer data is missing.')); + } + + $out->elementEnd('div'); + + // @todo FIXME $out->elementStart('div', array('class' => 'entry-content')); } + static function shorten($content, $notice) + { + $short = null; + + if (Notice::contentTooLong($content)) { + common_debug("content too long"); + $max = Notice::maxContent(); + // TRANS: Link description for link to full notice text if it is longer than + // TRANS: what will be dispplayed. + $ellipsis = _m('…'); + $short = mb_substr($content, 0, $max - 1); + $short .= sprintf('%3$s', + $notice->getUrl(), + // TRANS: Title for link that is an ellipsis in English. + _m('more...'), + $ellipsis); + } else { + $short = $content; + } + + return $short; + } + /** * Form for our app * * @param HTMLOutputter $out * @return Widget */ - function entryForm($out) { - return new QnaquestionForm($out); + return new QnanewquestionForm($out); } /** @@ -372,7 +492,6 @@ class QnAPlugin extends MicroAppPlugin * * @param Notice $notice */ - function deleteRelated($notice) { switch ($notice->object_type) { @@ -394,7 +513,8 @@ class QnAPlugin extends MicroAppPlugin function onEndShowScripts($action) { - // XXX maybe some cool shiz here + $action->script($this->path('js/qna.js')); + return true; } function onEndShowStyles($action)