Skip to content
Permalink
Browse files

Plugin: Add ApaExportSurvey - refs BT#15281

  • Loading branch information...
AngelFQC committed Feb 13, 2019
1 parent 01feab5 commit bde49a2b72dcc26dfe7122d9fb3a99a23f9d9050
@@ -0,0 +1,96 @@
<?php
/* For licensing terms, see /license.txt */
use Chamilo\CourseBundle\Entity\CTool;
/**
* Class ApaExportSurvey.
*/
class ApaExportSurvey extends Plugin
{
/**
* ApaExportSurvey constructor.
*/
protected function __construct()
{
$settings = [
'enabled' => 'boolean',
];
parent::__construct('0.1', 'Angel Fernado Quiroz Campos', $settings);
}
/**
* @return ApaExportSurvey|null
*/
public static function create()
{
static $result = null;
return $result ? $result : $result = new self();
}
/**
* Installation process.
*/
public function install()
{
}
/**
* Create tools for all courses.
*/
private function createLinkToCourseTools()
{
$result = Database::getManager()
->createQuery('SELECT c.id FROM ChamiloCoreBundle:Course c')
->getResult();
foreach ($result as $item) {
$this->createLinkToCourseTool($this->get_name().':teacher', $item['id'], 'survey.png');
}
}
/**
* Remove all course tools created by plugin.
*/
private function removeLinkToCourseTools()
{
Database::getManager()
->createQuery('DELETE FROM ChamiloCourseBundle:CTool t WHERE t.link LIKE :link AND t.category = :category')
->execute(['link' => 'apaexportsurvey/start.php%', 'category' => 'plugin']);
}
/**
* Uninstallation process.
*/
public function uninstall()
{
}
/**
* @param $id
*
* @return string
*/
public static function filterModify($params)
{
$enabled = api_get_plugin_setting('apaexportsurvey', 'enabled');
if ($enabled !== 'true') {
return '';
}
$surveyId = isset($params['survey_id']) ? (int) $params['survey_id'] : 0;
$iconSize = isset($params['icon_size']) ? $params['icon_size'] : ICON_SIZE_SMALL;
if (empty($surveyId)) {
return '';
}
return Display::url(
Display::return_icon('export_evaluation.png', get_lang('Export'), [], $iconSize),
api_get_path(WEB_PLUGIN_PATH).'apaexportsurvey/export.php?survey='.$surveyId.'&'.api_get_cidreq()
);
}
}
@@ -0,0 +1,10 @@
# APA Export Survey

Export surveys for APA.

This plugin will add a new action button in survey list allowing export the survey.

**Instructions**

- Install plugin
- Set enabled in configuration
@@ -0,0 +1,174 @@
<?php
/* For licensing terms, see /license.txt */
use Chamilo\CourseBundle\Entity\CSurveyQuestionOption;
require_once __DIR__.'/../../main/inc/global.inc.php';
api_protect_course_script(true);
api_protect_teacher_script();
$surveyId = isset($_GET['survey']) ? (int)$_GET['survey'] : 0;
$surveyData = SurveyManager::get_survey($surveyId);
$courseId = api_get_course_int_id();
if (empty($surveyData)) {
api_not_allowed(true);
}
$plugin = ApaExportSurvey::create();
if ($plugin->get('enabled') !== 'true') {
api_not_allowed(true);
}
$questionsData = SurveyManager::get_questions($surveyId, $courseId);
// Sort questions by their "sort" field
usort(
$questionsData,
function ($qL, $qR) {
if ($qL['sort'] == $qR['sort']) {
return 0;
}
return $qL['sort'] < $qR['sort'] ? -1 : 1;
}
);
$content = [];
$parts = [];
$indexPart = 0;
// Separate questions in introduction and main blocks
foreach ($questionsData as $questionData) {
if (!in_array($questionData['type'], ['yesno', 'pagebreak', 'multiplechoice'])) {
continue;
}
if ('pagebreak' === $questionData['type']) {
$indexPart++;
continue;
}
if (0 === $indexPart) {
$parts[0][] = $questionData;
continue;
}
$parts[$indexPart][] = $questionData;
}
// Process introduction questions to show
foreach ($parts[0] as $key => $introQuestion) {
$content[] = chr($key + 97).'. '.strip_tags($introQuestion['question']);
foreach ($introQuestion['answers'] as $answer) {
$content[] = '>'.strip_tags($answer);
}
}
$content[] = str_repeat('*', 40);
// Get surveys by users
$surveyAnswers = Database::getManager()
->createQuery(
'SELECT sa.user, MIN(sa.iid) AS id FROM ChamiloCourseBundle:CSurveyAnswer sa
WHERE sa.cId = :course AND sa.surveyId = :survey
GROUP BY sa.user ORDER BY id ASC'
)
->setParameters(['course' => $courseId, 'survey' => $surveyId])
->getResult();
// Process answers
foreach ($surveyAnswers as $i => $answer) {
$surveyLine = '"'.($i + 1).'","';
// Show answers for introduction questions
foreach ($parts[0] as $introQuestion) {
$options = getQuestionOptions(
$answer['user'],
$courseId,
$introQuestion['survey_id'],
$introQuestion['question_id']
);
/** @var CSurveyQuestionOption $option */
foreach ($options as $option) {
$surveyLine .= $option->getSort();
}
}
$surveyLine .= '","';
// Show answers for main questions
foreach ($parts[1] as $mainQuestion) {
$options = getQuestionOptions(
$answer['user'],
$courseId,
$mainQuestion['survey_id'],
$mainQuestion['question_id']
);
/** @var CSurveyQuestionOption $option */
foreach ($options as $option) {
$surveyLine .= $option->getSort();
}
}
$surveyLine .= '"';
$content[] = $surveyLine;
}
// Add EOL to lines
$fileContent = array_map(
function ($line) {
return html_entity_decode($line).PHP_EOL.PHP_EOL;
},
$content
);
// Generate file
$fileName = api_get_path(SYS_ARCHIVE_PATH).md5($surveyId.time()).'.txt';
file_put_contents($fileName, $fileContent);
DocumentManager::file_send_for_download($fileName, true);
/**
* @param string $user
* @param int $courseId
* @param int $surveyId
* @param int $questionId
*
* @return array
*/
function getQuestionOptions($user, $courseId, $surveyId, $questionId)
{
$options = Database::getManager()
->createQuery(
'SELECT sqo FROM ChamiloCourseBundle:CSurveyQuestionOption sqo
INNER JOIN ChamiloCourseBundle:CSurveyAnswer sa
WITH
sqo.cId = sa.cId
AND sqo.questionId = sa.questionId
AND sqo.surveyId = sa.surveyId
AND sqo.iid = sa.optionId
WHERE sa.user = :user AND sa.cId = :course AND sa.surveyId = :survey AND sa.questionId = :question'
)
->setParameters(
[
'user' => $user,
'course' => $courseId,
'survey' => $surveyId,
'question' => $questionId,
]
)
->getResult();
return $options;
}
@@ -0,0 +1,4 @@
<?php
/* For licensing terms, see /license.txt */
ApaExportSurvey::create()->install();
@@ -0,0 +1,7 @@
<?php
/* For licensing terms, see /license.txt */
$strings['plugin_title'] = "APA Export Survey";
$strings['plugin_comment'] = "Export surveys for APA.";
$strings['enabled'] = 'Enabled';
@@ -0,0 +1,7 @@
<?php
/* For licensing terms, see /license.txt */
$strings['plugin_title'] = "APA Export Survey";
$strings['plugin_comment'] = "Exportar encuestas para APA.";
$strings['enabled'] = 'Habilitado';
@@ -0,0 +1,4 @@
<?php
/* For licensing terms, see /license.txt */
$plugin_info = ApaExportSurvey::create()->get_info();
@@ -0,0 +1,50 @@
<?php
/* For licensing terms, see /license.txt */
require_once __DIR__.'/../../main/inc/global.inc.php';
api_protect_course_script(true);
api_protect_teacher_script();
$plugin = ApaExportSurvey::create();
$courseCode = api_get_course_id();
// Create a sortable table with survey-data
$table = new SortableTable(
'surveys',
['SurveyUtil', 'get_number_of_surveys'],
['SurveyUtil', 'get_survey_data'],
2
);
$table->set_additional_parameters(['cidReq' => $courseCode]);
$table->set_header(0, '', false);
$table->setHideColumn(0);
$table->set_header(1, get_lang('SurveyName'));
$table->set_header(2, get_lang('SurveyCode'), true, ['class' => 'text-center'], ['class' => 'text-center']);
$table->set_header(3, get_lang('NumberOfQuestions'), true, ['class' => 'text-right'], ['class' => 'text-right']);
$table->set_header(4, get_lang('Author'));
$table->set_header(5, get_lang('AvailableFrom'), true, ['class' => 'text-center'], ['class' => 'text-center']);
$table->set_header(6, get_lang('AvailableUntil'), true, ['class' => 'text-center'], ['class' => 'text-center']);
$table->set_header(7, get_lang('Invite'), true, ['class' => 'text-right'], ['class' => 'text-right']);
$table->set_header(8, get_lang('Anonymous'), true, ['class' => 'text-center'], ['class' => 'text-center']);
$table->set_column_filter(8, ['SurveyUtil', 'anonymous_filter']);
if (api_get_configuration_value('allow_mandatory_survey')) {
$table->set_header(9, get_lang('IsMandatory'), true, ['class' => 'text-center'], ['class' => 'text-center']);
$table->set_header(10, get_lang('Export'), false, ['class' => 'text-center'], ['class' => 'text-center']);
$table->set_column_filter(10, ['ApaExportSurvey', 'filterModify']);
} else {
$table->set_header(9, get_lang('Export'), false, ['class' => 'text-center'], ['class' => 'text-center']);
$table->set_column_filter(9, ['ApaExportSurvey', 'filterModify']);
}
$pageTitle = $plugin->get_title();
$template = new Template($pageTitle);
$content = $table->return_table();
$template->assign('header', $pageTitle);
$template->assign('content', $content);
$template->display_one_col_template();
@@ -0,0 +1,4 @@
<?php
/* For licensing terms, see /license.txt */
ApaExportSurvey::create()->uninstall();

0 comments on commit bde49a2

Please sign in to comment.
You can’t perform that action at this time.