Jingga/oms-QA
1
0
Fork 0
mirror of https://github.com/Karaka-Management/oms-QA.git synced 2026-01-11 15:48:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

bug fixes

Browse Source
This commit is contained in:
Dennis Eichhorn 2021-06-05 11:01:03 +02:00
parent cc88c2d2b9
commit bcf4c63835
14 changed files with 680 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
Admin/Install/db.json
View File

@ -119,15 +119,15 @@
"primary": true,
"autoincrement": true
},
"qa_question_vote_src": {
"name": "qa_question_vote_src",
"qa_question_vote_question": {
"name": "qa_question_vote_question",
"type": "INT",
"null": false,
"foreignTable": "qa_question",
"foreignKey": "qa_question_id"
},
"qa_question_vote_dst": {
"name": "qa_question_vote_dst",
"qa_question_vote_created_by": {
"name": "qa_question_vote_created_by",
"type": "INT",
"null": false,
"foreignTable": "account",
@ -137,6 +137,11 @@
"name": "qa_question_vote_score",
"type": "TINYINT",
"null": false
},
"qa_question_vote_created_at": {
"name": "qa_question_vote_created_at",
"type": "DATETIME",
"null": false
}
}
},
@ -229,15 +234,15 @@
"primary": true,
"autoincrement": true
},
"qa_answer_vote_src": {
"name": "qa_answer_vote_src",
"qa_answer_vote_answer": {
"name": "qa_answer_vote_answer",
"type": "INT",
"null": false,
"foreignTable": "qa_answer",
"foreignKey": "qa_answer_id"
},
"qa_answer_vote_dst": {
"name": "qa_answer_vote_dst",
"qa_answer_vote_created_by": {
"name": "qa_answer_vote_created_by",
"type": "INT",
"null": false,
"foreignTable": "account",
@ -247,6 +252,11 @@
"name": "qa_answer_vote_score",
"type": "TINYINT",
"null": false
},
"qa_answer_vote_created_at": {
"name": "qa_answer_vote_created_at",
"type": "DATETIME",
"null": false
}
}
}

91
Admin/Routes/Web/Api.php Normal file
View File

@ -0,0 +1,91 @@
<?php declare(strict_types=1);
use Modules\QA\Controller\ApiController;
use Modules\QA\Models\PermissionState;
use phpOMS\Account\PermissionType;
use phpOMS\Router\RouteVerb;
return [
'^.*/qa/category(\?.*|$)' => [
[
'dest' => '\Modules\QA\Controller\ApiController:apiQACategoryCreate',
'verb' => RouteVerb::PUT,
'permission' => [
'module' => ApiController::MODULE_NAME,
'type' => PermissionType::CREATE,
'state' => PermissionState::CATEGORY,
],
],
[
'dest' => '\Modules\QA\Controller\ApiController:apiQACategoryUpdate',
'verb' => RouteVerb::SET,
'permission' => [
'module' => ApiController::MODULE_NAME,
'type' => PermissionType::CREATE,
'state' => PermissionState::CATEGORY,
],
],
],
'^.*/qa/question(\?.*|$)' => [
[
'dest' => '\Modules\QA\Controller\ApiController:apiQAQuestionCreate',
'verb' => RouteVerb::PUT,
'permission' => [
'module' => ApiController::MODULE_NAME,
'type' => PermissionType::CREATE,
'state' => PermissionState::QUESTION,
],
],
[
'dest' => '\Modules\QA\Controller\ApiController:apiQuestionUpdate',
'verb' => RouteVerb::SET,
'permission' => [
'module' => ApiController::MODULE_NAME,
'type' => PermissionType::CREATE,
'state' => PermissionState::QUESTION,
],
],
],
'^.*/qa/question/vote(\?.*|$)' => [
[
'dest' => '\Modules\QA\Controller\ApiController:apiChangeQAQuestionVote',
'verb' => RouteVerb::PUT | RouteVerb::SET,
'permission' => [
'module' => ApiController::MODULE_NAME,
'type' => PermissionType::CREATE,
'state' => PermissionState::VOTE,
],
],
],
'^.*/qa/answer(\?.*|$)' => [
[
'dest' => '\Modules\QA\Controller\ApiController:apiQAAnswerCreate',
'verb' => RouteVerb::PUT,
'permission' => [
'module' => ApiController::MODULE_NAME,
'type' => PermissionType::CREATE,
'state' => PermissionState::ANSWER,
],
],
[
'dest' => '\Modules\QA\Controller\ApiController:apiAnswerUpdate',
'verb' => RouteVerb::SET,
'permission' => [
'module' => ApiController::MODULE_NAME,
'type' => PermissionType::CREATE,
'state' => PermissionState::ANSWER,
],
],
],
'^.*/qa/answer/vote(\?.*|$)' => [
[
'dest' => '\Modules\QA\Controller\ApiController:apiChangeQAAnswerVote',
'verb' => RouteVerb::PUT | RouteVerb::SET,
'permission' => [
'module' => ApiController::MODULE_NAME,
'type' => PermissionType::CREATE,
'state' => PermissionState::VOTE,
],
],
],
];

180
Controller/ApiController.php
View File

@ -27,6 +27,12 @@ use Modules\QA\Models\QACategoryMapper;
use Modules\QA\Models\QAQuestion;
use Modules\QA\Models\QAQuestionMapper;
use Modules\QA\Models\QAQuestionStatus;
use Modules\QA\Models\QAQuestionVote;
use Modules\QA\Models\QAQuestionVoteMapper;
use Modules\QA\Models\QAAnswerVote;
use Modules\QA\Models\QAAnswerVoteMapper;
use Modules\QA\Models\NullQAQuestionVote;
use Modules\QA\Models\NullQAAnswerVote;
use Modules\Tag\Models\NullTag;
use phpOMS\Message\Http\HttpRequest;
use phpOMS\Message\Http\HttpResponse;
@ -47,6 +53,57 @@ use phpOMS\Utils\Parser\Markdown\Markdown;
*/
final class ApiController extends Controller
{
/**
* Api method to create a question
*
* @param RequestAbstract $request Request
* @param ResponseAbstract $response Response
* @param mixed $data Generic data
*
* @return void
*
* @api
*
* @since 1.0.0
*/
public function apiQuestionUpdate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{
}
/**
* Api method to create a question
*
* @param RequestAbstract $request Request
* @param ResponseAbstract $response Response
* @param mixed $data Generic data
*
* @return void
*
* @api
*
* @since 1.0.0
*/
public function apiQACategoryUpdate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{
}
/**
* Api method to create a question
*
* @param RequestAbstract $request Request
* @param ResponseAbstract $response Response
* @param mixed $data Generic data
*
* @return void
*
* @api
*
* @since 1.0.0
*/
public function apiAnswerUpdate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{
}
/**
* Api method to create a question
*
@ -189,6 +246,7 @@ final class ApiController extends Controller
$answer->answerRaw = (string) $request->getData('plain');
$answer->answer = Markdown::parse((string) ($request->getData('plain') ?? ''));
$answer->question = new NullQAQuestion((int) $request->getData('question'));
$answer->isAccepted = (bool) ($request->getData('accepted') ?? false);
$answer->setStatus((int) $request->getData('status'));
$answer->createdBy = new NullAccount($request->header->account);
@ -367,4 +425,126 @@ final class ApiController extends Controller
return $l11nQACategory;
}
/**
* Api method to change question vote
*
* @param RequestAbstract $request Request
* @param ResponseAbstract $response Response
* @param mixed $data Generic data
*
* @return void
*
* @api
*
* @since 1.0.0
*/
private function apiChangeQAQuestionVote(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{
if (!empty($val = $this->validateQuestionVote($request))) {
$response->set('qa_question_vote', new FormValidation($val));
$response->header->status = RequestStatusCode::R_400;
return;
}
$questionVote = QAQuestionVoteMapper::findVote((int) $reqeust->getData('id'), $request->header->account);
if ($questionVote instanceof NullQAQuestionVote) {
$new = new QAQuestionVote();
$new->score = (int) $request->getData('type');
$new->createdBy = $request->header->account;
$this->createModel($request->header->account, $new, QAQuestionVoteMapper::class, 'qa_question_vote', $request->getOrigin());
$this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Vote', 'Sucessfully voted.', $new);
} else {
$new = clone $questionVote;
$new->score = (int) $request->getData('type');
$this->updateModel($request->header->account, $questionVote, $new, QAQuestionVoteMapper::class, 'qa_question_vote', $request->getOrigin());
$this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Vote', 'Vote successfully changed.', $new);
}
}
/**
* Validate question vote request
*
* @param RequestAbstract $request Request
*
* @return array<string, bool> Returns the validation array of the request
*
* @since 1.0.0
*/
private function validateQuestionVote(RequestAbstract $request) : array
{
$val = [];
if (($val['id'] = ($request->getData('id') === null))
|| ($val['type'] = ($request->getData('type', 'int') < -1 || $request->getData('type') > 1))
) {
return $val;
}
return [];
}
/**
* Api method to change answer vote
*
* @param RequestAbstract $request Request
* @param ResponseAbstract $response Response
* @param mixed $data Generic data
*
* @return void
*
* @api
*
* @since 1.0.0
*/
private function apiChangeQAAnswerVote(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{
if (!empty($val = $this->validateAnswerVote($request))) {
$response->set('qa_answer_vote', new FormValidation($val));
$response->header->status = RequestStatusCode::R_400;
return;
}
$answerVote = QAAnswerVoteMapper::findVote((int) $reqeust->getData('id'), $request->header->account);
if ($answerVote instanceof NullQAAnswerVote) {
$new = new QAAnswerVote();
$new->score = (int) $request->getData('type');
$new->createdBy = $request->header->account;
$this->createModel($request->header->account, $new, QAAnswerVoteMapper::class, 'qa_answer_vote', $request->getOrigin());
$this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Vote', 'Sucessfully voted.', $new);
} else {
$new = clone $answerVote;
$new->score = (int) $request->getData('type');
$this->updateModel($request->header->account, $answerVote, $new, QAAnswerVoteMapper::class, 'qa_answer_vote', $request->getOrigin());
$this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Vote', 'Vote successfully changed.', $new);
}
}
/**
* Validate answer vote request
*
* @param RequestAbstract $request Request
*
* @return array<string, bool> Returns the validation array of the request
*
* @since 1.0.0
*/
private function validateAnswerVote(RequestAbstract $request) : array
{
$val = [];
if (($val['id'] = ($request->getData('id') === null))
|| ($val['type'] = ($request->getData('type', 'int') < -1 || $request->getData('type') > 1))
) {
return $val;
}
return [];
}
}

38
Models/NullQAAnswerVote.php Normal file
View File

@ -0,0 +1,38 @@
<?php
/**
* Orange Management
*
* PHP Version 8.0
*
* @package Modules\QA\Models
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @link https://orange-management.org
*/
declare(strict_types=1);
namespace Modules\QAs\Models;
/**
* Null model
*
* @package Modules\QA\Models
* @license OMS License 1.0
* @link https://orange-management.org
* @since 1.0.0
*/
final class NullQAAnswerVote extends QAAnswerVote
{
/**
* Constructor
*
* @param int $id Model id
*
* @since 1.0.0
*/
public function __construct(int $id = 0)
{
$this->id = $id;
}
}

38
Models/NullQAQuestionVote.php Normal file
View File

@ -0,0 +1,38 @@
<?php
/**
* Orange Management
*
* PHP Version 8.0
*
* @package Modules\QA\Models
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @link https://orange-management.org
*/
declare(strict_types=1);
namespace Modules\QAs\Models;
/**
* Null model
*
* @package Modules\QA\Models
* @license OMS License 1.0
* @link https://orange-management.org
* @since 1.0.0
*/
final class NullQAQuestionVote extends QAQuestionVote
{
/**
* Constructor
*
* @param int $id Model id
*
* @since 1.0.0
*/
public function __construct(int $id = 0)
{
$this->id = $id;
}
}

6
Models/PermissionState.php
View File

@ -29,4 +29,10 @@ abstract class PermissionState extends Enum
public const QA = 1;
public const QUESTION = 2;
public const ANSWER = 3;
public const VOTE = 4;
public const CATEGORY = 5;
}

8
Models/QAAnswer.php
View File

@ -35,6 +35,12 @@ class QAAnswer implements \JsonSerializable
*/
protected int $id = 0;
/**
* Status.
*
* @var int
* @since 1.0.0
*/
private int $status = QAAnswerStatus::ACTIVE;
/**
@ -67,7 +73,7 @@ class QAAnswer implements \JsonSerializable
* @var bool
* @since 1.0.0
*/
private bool $isAccepted = false;
public bool $isAccepted = false;
/**
* Created by.

80
Models/QAAnswerVote.php Normal file
View File

@ -0,0 +1,80 @@
<?php
/**
* Orange Management
*
* PHP Version 8.0
*
* @package Modules\QA\Models
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @link https://orange-management.org
*/
declare(strict_types=1);
namespace Modules\QA\Models;
use Modules\Admin\Models\Account;
use Modules\Admin\Models\NullAccount;
/**
* Task class.
*
* @package Modules\QA\Models
* @license OMS License 1.0
* @link https://orange-management.org
* @since 1.0.0
*/
class QAAnswerVote
{
/**
* ID.
*
* @var int
* @since 1.0.0
*/
protected int $id = 0;
/**
* Account.
*
* @var Account
* @since 1.0.0
*/
public Account $createdBy;
/**
* Created at
*
* @var \DateTimeImmutable
* @since 1.0.0
*/
public \DateTimeImmutable $createdAt;
/**
* Comment
*
* @var int
* @since 1.0.0
*/
public int $comment = 0;
/**
* Score
*
* @var int
* @since 1.0.0
*/
public int $score = 0;
/**
* Constructor.
*
* @since 1.0.0
*/
public function __construct()
{
$this->createdBy = new NullAccount();
$this->createdAt = new \DateTimeImmutable();
}
}

66
Models/QAAnswerVoteMapper.php Normal file
View File

@ -0,0 +1,66 @@
<?php
/**
* Orange Management
*
* PHP Version 8.0
*
* @package Modules\QA\Models
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @link https://orange-management.org
*/
declare(strict_types=1);
namespace Modules\QA\Models;
use phpOMS\DataStorage\Database\DataMapperAbstract;
/**
* Mapper class.
*
* @package Modules\QA\Models
* @license OMS License 1.0
* @link https://orange-management.org
* @since 1.0.0
*/
final class QAAnswerVoteMapper extends DataMapperAbstract
{
/**
* Columns.
*
* @var array<string, array{name:string, type:string, internal:string, autocomplete?:bool, readonly?:bool, writeonly?:bool, annotations?:array}>
* @since 1.0.0
*/
protected static array $columns = [
'qa_answer_vote_id' => ['name' => 'qa_answer_vote_id', 'type' => 'int', 'internal' => 'id'],
'qa_answer_vote_score' => ['name' => 'qa_answer_vote_score', 'type' => 'int', 'internal' => 'score'],
'qa_answer_vote_answer' => ['name' => 'qa_answer_vote_comment', 'type' => 'int', 'internal' => 'comment', 'readonly' => true],
'qa_answer_vote_created_by' => ['name' => 'qa_answer_vote_created_by', 'type' => 'int', 'internal' => 'createdBy', 'readonly' => true],
'qa_answer_vote_created_at' => ['name' => 'qa_answer_vote_created_at', 'type' => 'DateTimeImmutable', 'internal' => 'createdAt', 'readonly' => true],
];
/**
* Primary table.
*
* @var string
* @since 1.0.0
*/
protected static string $table = 'qa_answer_vote';
/**
* Created at.
*
* @var string
* @since 1.0.0
*/
protected static string $createdAt = 'qa_answer_vote_created_at';
/**
* Primary field name.
*
* @var string
* @since 1.0.0
*/
protected static string $primaryField = 'qa_answer_vote_id';
}

9
Models/QAQuestion.php
View File

@ -14,9 +14,10 @@ declare(strict_types=1);
namespace Modules\QA\Models;
use Modules\Admin\Models\Account;
use Modules\Admin\Models\NullAccount;
use Modules\Profile\Models\NullProfile;
use Modules\Tag\Models\Tag;
use Modules\Profile\Models\Profile;
/**
* Task class.
@ -87,10 +88,10 @@ class QAQuestion implements \JsonSerializable
/**
* Created by.
*
* @var Account
* @var Profile
* @since 1.0.0
*/
public Account $createdBy;
public Profile $createdBy;
/**
* Created at.
@ -124,7 +125,7 @@ class QAQuestion implements \JsonSerializable
public function __construct()
{
$this->createdAt = new \DateTimeImmutable('now');
$this->createdBy = new NullAccount();
$this->createdBy = new NullProfile();
}
/**

7
Models/QAQuestionMapper.php
View File

@ -14,7 +14,7 @@ declare(strict_types=1);
namespace Modules\QA\Models;
use Modules\Admin\Models\AccountMapper;
use Modules\Profile\Models\ProfileMapper;
use Modules\Tag\Models\TagMapper;
use phpOMS\DataStorage\Database\DataMapperAbstract;
@ -88,8 +88,9 @@ final class QAQuestionMapper extends DataMapperAbstract
*/
protected static array $belongsTo = [
'createdBy' => [
'mapper' => AccountMapper::class,
'external' => 'qa_question_created_by',
'mapper' => ProfileMapper::class,
'external' => 'qa_question_created_by',
'by' => 'account'
],
];

80
Models/QAQuestionVote.php Normal file
View File

@ -0,0 +1,80 @@
<?php
/**
* Orange Management
*
* PHP Version 8.0
*
* @package Modules\QA\Models
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @link https://orange-management.org
*/
declare(strict_types=1);
namespace Modules\QA\Models;
use Modules\Admin\Models\Account;
use Modules\Admin\Models\NullAccount;
/**
* Task class.
*
* @package Modules\QA\Models
* @license OMS License 1.0
* @link https://orange-management.org
* @since 1.0.0
*/
class QAQuestionVote
{
/**
* ID.
*
* @var int
* @since 1.0.0
*/
protected int $id = 0;
/**
* Account.
*
* @var Account
* @since 1.0.0
*/
public Account $createdBy;
/**
* Created at
*
* @var \DateTimeImmutable
* @since 1.0.0
*/
public \DateTimeImmutable $createdAt;
/**
* Comment
*
* @var int
* @since 1.0.0
*/
public int $comment = 0;
/**
* Score
*
* @var int
* @since 1.0.0
*/
public int $score = 0;
/**
* Constructor.
*
* @since 1.0.0
*/
public function __construct()
{
$this->createdBy = new NullAccount();
$this->createdAt = new \DateTimeImmutable();
}
}

66
Models/QAQuestionVoteMapper.php Normal file
View File

@ -0,0 +1,66 @@
<?php
/**
* Orange Management
*
* PHP Version 8.0
*
* @package Modules\QA\Models
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @link https://orange-management.org
*/
declare(strict_types=1);
namespace Modules\QA\Models;
use phpOMS\DataStorage\Database\DataMapperAbstract;
/**
* Mapper class.
*
* @package Modules\QA\Models
* @license OMS License 1.0
* @link https://orange-management.org
* @since 1.0.0
*/
final class QAQuestionVoteMapper extends DataMapperAbstract
{
/**
* Columns.
*
* @var array<string, array{name:string, type:string, internal:string, autocomplete?:bool, readonly?:bool, writeonly?:bool, annotations?:array}>
* @since 1.0.0
*/
protected static array $columns = [
'qa_question_vote_id' => ['name' => 'qa_question_vote_id', 'type' => 'int', 'internal' => 'id'],
'qa_question_vote_score' => ['name' => 'qa_question_vote_score', 'type' => 'int', 'internal' => 'score'],
'qa_question_vote_question' => ['name' => 'qa_question_vote_comment', 'type' => 'int', 'internal' => 'comment', 'readonly' => true],
'qa_question_vote_created_by' => ['name' => 'qa_question_vote_created_by', 'type' => 'int', 'internal' => 'createdBy', 'readonly' => true],
'qa_question_vote_created_at' => ['name' => 'qa_question_vote_created_at', 'type' => 'DateTimeImmutable', 'internal' => 'createdAt', 'readonly' => true],
];
/**
* Primary table.
*
* @var string
* @since 1.0.0
*/
protected static string $table = 'qa_question_vote';
/**
* Created at.
*
* @var string
* @since 1.0.0
*/
protected static string $createdAt = 'qa_question_vote_created_at';
/**
* Primary field name.
*
* @var string
* @since 1.0.0
*/
protected static string $primaryField = 'qa_question_vote_id';
}

2
Theme/Backend/qa-question.tpl.php
View File

@ -41,7 +41,7 @@ echo $this->getData('nav')->render();
<div class="col-xs-12">
<section class="portlet">
<div class="portlet-body">
<?= $this->printHtml($answer->getAnswer()); ?><?= $this->printHtml($answer->createdAt->format('Y-m-d')); ?><?= $answer->createdBy->getId(); ?><?= $answer->getStatus(); ?><?= $this->printHtml((string) $answer->isAccepted()); ?>
<?= $answer->answer; ?><?= $this->printHtml($answer->createdAt->format('Y-m-d')); ?><?= $answer->createdBy->getId(); ?><?= $answer->getStatus(); ?><?= $this->printHtml((string) $answer->isAccepted()); ?>
</div>
</section>
</div>