Skip to content

Commit

Permalink
Fixed issue #11568: Active surveys list for surveytakers is not prope…
Browse files Browse the repository at this point in the history 
…rly formatted
  • Loading branch information
markusfluer committed Aug 22, 2016
1 parent 2cc5e12 commit f83da38
Show file tree
Hide file tree
Showing 6 changed files with 401 additions and 19 deletions.
20 changes: 16 additions & 4 deletions application/controllers/SurveysController.php
View file
Expand Up @@ -30,10 +30,22 @@ public function actionPublicList($lang = null)
App()->bootstrap->registerAllScripts();
}

$this->render('publicSurveyList', array(
'publicSurveys' => Survey::model()->active()->open()->public()->with('languagesettings')->findAll(),
'futureSurveys' => Survey::model()->active()->registration()->public()->with('languagesettings')->findAll(),
));
$aData = array(
'publicSurveys' => Survey::model()->active()->open()->public()->with('languagesettings')->findAll(),
'futureSurveys' => Survey::model()->active()->registration()->public()->with('languagesettings')->findAll(),
);
$htmlOut = $this->render('publicSurveyList', $aData,true );

$event = new PluginEvent('beforeSurveysStartpageRender', $this);
$event->set('aData', $aData);
App()->getPluginManager()->dispatchEvent($event);

if(!empty($event->get('result')))
{
$htmlFromEvent = $event->get('result');
$htmlOut = $htmlFromEvent['html'];
}
echo $htmlOut;
}
}
?>
28 changes: 28 additions & 0 deletions application/core/plugins/extendedStartPage/extendedStartPage.php
View file
@@ -0,0 +1,28 @@
<?php
/**
* Extended startpage plugin to display more information about the
* sctive surveys on the startpage.
*
* @since 2016-07-22
* @author Markus Flür
*
*/
class ExtendedStartpage extends \ls\pluginmanager\PluginBase
{
static protected $description = 'Extended start page view';
static protected $name = 'extendStartpage';

public function init()
{
$this->subscribe('beforeSurveysStartpageRender');
}

public function beforeSurveysStartpageRender(){
$event = $this->getEvent();
$aData = $event->get('aData');

$html = $this->renderPartial('publicSurveyList_extended',$aData,true,true );
$event->append('result',array('html'=>$html));
}

}
208 changes: 208 additions & 0 deletions application/core/plugins/extendedStartPage/views/publicSurveyList_extended.php
View file
@@ -0,0 +1,208 @@
<?php
$outputSurveys = 0;
$list = "<div class='container'>";
$list .= "<div class='row'>";
$divideToggle = true;

foreach($publicSurveys as $survey)
{
$outputSurveys++;
//echo "IKI :";var_dump( $survey->localizedTitle);
$divider = ($divideToggle ? " vertical-divider right " : "");
if ($survey->publicstatistics == "Y")
{
$statistics = "<div class='col-md-1 col-sm-2 col-xs-2 no-divide ls-custom-padding five ".$divider."'>";
$statistics .= CHtml::link('<span class="fa fa-bar-chart" aria-hidden="true"></span><span class="sr-only">'. gT('View statistics') .'</span>',
array('statistics_user/action', 'surveyid' => $survey->sid,'language' => App()->language),
array(
'class'=>'view-stats btn btn-success btn-block',
'title'=>gT('View statistics'),
'data-toggle'=>'tooltip',
)
);
$statistics .= "</div>";
$list .= "<div class='col-md-5 col-sm-10 col-xs-10 ls-custom-padding five'>";
}
else
{
$statistics = "";
$list .= "<div class='col-md-6 col-xs-12 ls-custom-padding five ".$divider."'>";
}

$tooltips = "";
if($survey->allowregister == "Y")
{
$tooltips .= "<i class=\"fa fa-sign-in\" aria-hidden=\"true\">&nbsp;</i>";
}
else
{
if($survey->hasTokens($survey->sid))
{
$tooltips .= "<i class=\"fa fa-key\" aria-hidden=\"true\">&nbsp;</i>";
}
}

if($survey->usecaptcha == "Y" || $survey->usecaptcha == "A")
{
$tooltips .= "<i class=\"fa fa-puzzle-piece\" aria-hidden=\"true\">&nbsp;</i>";
}
if($survey->anonymized == "Y")
{
$tooltips .= "<i class=\"fa fa-shield\" aria-hidden=\"true\">&nbsp;</i>";
}
if($survey->allowsave == "Y")
{
$tooltips .= "<i class=\"fa fa-save\" aria-hidden=\"true\">&nbsp;</i>";
}
if($survey->allowprev == "Y")
{
$tooltips .= "<i class=\"fa fa-undo\" aria-hidden=\"true\">&nbsp;</i>";
}
$tooltips .= "<i class=\"fa fa-clock-o\" aria-hidden=\"true\">&nbsp;</i>&nbsp;".$survey->calculateEstimatedTime()." ".gt("Minutes");

$content = $survey->localizedTitle;
$content .= "<span class='pull-right clearfix'>"
."<span href='#' class='fa fa-question-circle' onclick='return false;' data-html='true' data-toggle=\"popover\" title=\"".gT("Survey information")."\" data-content='".$tooltips."'>&nbsp;</span>"
."</span>";

$list .= CHtml::link(
$content,
array(
'survey/index',
'sid' => $survey->sid,
'lang' => App()->language,
'encode' => false
),
array(
'class' => 'surveytitle btn btn-primary btn-block',
'data-html' => true,
'data-toggle' => 'tooltip',
'title' => $tooltips
)
);
$list .= "</div>";
$list .= $statistics;
$divideToggle = !$divideToggle;
}

$list .= "</div>";
$list .= "</div>";

if (!empty($futureSurveys))
{
$list .= "<div class=\"survey-list-heading\">". gT("Following survey(s) are not yet active but you can register for them.")."</div>";
$list .= "<div class='container'>";
$list .= "<div class='row'>";
foreach($futureSurveys as $survey)
{
$outputSurveys++;
$list .= CHtml::openTag('div', array('class'=>'col-xs-12'));
$list .= CHtml::link($survey->localizedTitle, array('survey/index', 'sid' => $survey->sid, 'lang' => App()->language), array('class' => 'surveytitle'));
$list .= CHtml::closeTag('div');
$list .= CHtml::tag('div', array(
'data-regformsurvey' => $survey->sid,
'class' => 'col-xs-12'
));
}
}


$legendForSurvey_button = "<button class='btn btn-info' data-toggle='modal' href='#legendForSurveys'>".gt("Toggle Legend")."</button>";
$legendForSurvey = ""
. "<div class='modal fade' id='legendForSurveys'>"
. "<div class='modal-dialog' role='document'>"
. "<div class='modal-content'>"
. "<div class='modal-body'>"
. "<div class='row'>"
. "<div class='col-xs-3 text-right'><i class='fa fa-sign-in'>&nbsp;</i></div>"
. "<div class='col-xs-9'>".gT('You have to register to tage this survey')."</div>"
. "</div>"
. "<div class='row'>"
. "<div class='col-xs-3 text-right'><i class='fa fa-lock'>&nbsp;</i></div>"
. "<div class='col-xs-9'>".gT('You need a valid token to take this survey')."</div>"
. "</div>"
. "<div class='row'>"
. "<div class='col-xs-3 text-right'><i class='fa fa-puzzle-piece'>&nbsp;</i></div>"
. "<div class='col-xs-9'>".gT('You need to enter a CAPTCHA to take this survey')."</div>"
. "</div>"
. "<div class='row'>"
. "<div class='col-xs-3 text-right'><i class='fa fa-shield'>&nbsp;</i></div>"
. "<div class='col-xs-9'>".gT('This survey is anonymized')."</div>"
. "</div>"
. "<div class='row'>"
. "<div class='col-xs-3 text-right'><i class='fa fa-undo'>&nbsp;</i></div>"
. "<div class='col-xs-9'>".gT('You may change the answers in this survey')."</div>"
. "</div>"
. "<div class='row'>"
. "<div class='col-xs-3 text-right'><i class='fa fa-clock-o'>&nbsp;</i></div>"
. "<div class='col-xs-9'>".gT('The estimated time for this survey')."</div>"
. "</div>"
. "</div>"
. "</div>"
. "</div>"
. "</div>";

//@TODO: Create Global configuration for showSurveyInfo
$showSurveyInformation = false;


$listheading="<div class='container'>
<div class='row'>
<h3>
".gT("The following surveys are available:")."
<span class='pull-right '>".$legendForSurvey_button."</span>
</h3>
".$legendForSurvey."
</div>";
if( $outputSurveys==0)
{
$list=CHtml::openTag('div',array('class'=>'col-xs-12')).gT("No available surveys").CHtml::closeTag('div');
}
$data['surveylist'] = array(
"nosid"=> "",
"contact"=> sprintf(gT("Please contact %s ( %s ) for further assistance."),
Yii::app()->getConfig("siteadminname"),
encodeEmail(Yii::app()->getConfig("siteadminemail"))
),
"listheading"=> $listheading,
"list"=> $list,
);

$oTemplate = Template::model()->getInstance("default");

$data['templatedir'] = Template::getTemplatePath(Yii::app()->getConfig("defaulttemplate"));
$data['templateurl'] = Template::getTemplateURL(Yii::app()->getConfig("defaulttemplate"))."/";
$data['templatename'] = $oTemplate->name;
$data['sitename'] = Yii::app()->getConfig("sitename");
$data['languagechanger'] = makeLanguageChanger(App()->language);

//A nice exit
sendCacheHeaders();
doHeader();
// Javascript Var
$aLSJavascriptVar=array();
$aLSJavascriptVar['bFixNumAuto']=(int)(bool)Yii::app()->getConfig('bFixNumAuto',1);
$aLSJavascriptVar['bNumRealValue']=(int)(bool)Yii::app()->getConfig('bNumRealValue',0);
if(isset($thissurvey['surveyls_numberformat']))
{
$radix=getRadixPointData($thissurvey['surveyls_numberformat']);
}
else
{
$aLangData=getLanguageData();
$radix=getRadixPointData($aLangData[ Yii::app()->getConfig('defaultlang')]['radixpoint']);// or App()->language . defaultlang ensure it's same for each language ?
}
$aLSJavascriptVar['sLEMradix']=$radix['separator'];
$sLSJavascriptVar="LSvar=".json_encode($aLSJavascriptVar);
App()->clientScript->registerScript('sLSJavascriptVar',$sLSJavascriptVar,CClientScript::POS_HEAD);
App()->clientScript->registerScript('setJsVar',"setJsVar();",CClientScript::POS_BEGIN);// Ensure all js var is set before rendering the page (User can click before $.ready)
App()->getClientScript()->registerPackage('jqueryui');
App()->getClientScript()->registerPackage('jquery-touch-punch');
App()->getClientScript()->registerScriptFile(Yii::app()->getConfig('generalscripts')."survey_runtime.js");
useFirebug();

echo templatereplace(file_get_contents($oTemplate->viewPath."/startpage.pstpl"),array(),$data,'survey['.__LINE__.']');
echo templatereplace(file_get_contents($oTemplate->viewPath."/surveylist.pstpl"),array(),$data,'survey['.__LINE__.']');
echo templatereplace(file_get_contents($oTemplate->viewPath."/endpage.pstpl"),array(),$data,'survey['.__LINE__.']');
doFooter();
?>
25 changes: 25 additions & 0 deletions application/models/Survey.php
View file
Expand Up @@ -1109,4 +1109,29 @@ public static function transcribeCaptchaOptions() {
return 'N';
}

/**
* Method to make an approximation on how long a survey will last
* Approx is 3 questions each minute.
* @return int
*/
public function calculateEstimatedTime ()
{
//@TODO make the time_per_question variable user configureable
$time_per_question = 0.5;
$criteria = new CDbCriteria();
$criteria->addCondition('sid = ' . $this->sid);
$criteria->addCondition('parent_qid = 0');
$criteria->addCondition('language = \'' . $this->language . '\'');
$baseQuestions = Question::model()->count($criteria);
// Note: An array questions with one sub question is fetched as 1 base question + 1 sub question
$criteria = new CDbCriteria();
$criteria->addCondition('sid = ' . $this->sid);
$criteria->addCondition('parent_qid != 0');
$criteria->addCondition('language = \'' . $this->language . '\'');
$subQuestions = Question::model()->count($criteria);
// Subquestions are worth less "time" than base questions
$subQuestions = intval(($subQuestions - $baseQuestions) / 2);
$subQuestions = $subQuestions < 0 ? 0 : $subQuestions;
return ceil(($subQuestions + $baseQuestions)*$time_per_question);
}
}

0 comments on commit f83da38

Please sign in to comment.