x

Main chapters

  1. LimeSurvey Cloud vs LimeSurvey CE
  2. LimeSurvey Cloud - Quick start guide
  3. LimeSurvey CE - Installation
  4. How to design a good survey (Guide)
  5. Getting started
  6. LimeSurvey configuration
  7. Introduction - Surveys
  8. View survey settings
  9. View survey menu
  10. View survey structure
  11. Introduction - Questions
  12. Introduction - Question Groups
  13. Introduction - Surveys - Management
  14. Survey toolbar options
  15. Multilingual survey
  16. Quick start guide - ExpressionScript
  17. Advanced features
  18. General FAQ
  19. Troubleshooting
  20. Workarounds
  21. License
  22. Version change log
  23. Plugins - Advanced
 Actions

NewQuestionAttributes: Difference between revisions

From LimeSurvey Manual

DenisChenu (talk | contribs)
m New attribute definition: min/max or float
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{FeatureStarting|2.50}}  
{{FeatureStarting|2.50}}
 
=The event=
=The event=


'''When'''
'''When'''


This settings happen each time the attribute definition is read for the installation. In general : it happen one time only.
This event happens each time the attribute definition is read for the installation. In general it happens one time only.


'''Input'''
'''Input'''
Line 37: Line 36:
==Input type==
==Input type==


* switch : Switch (on|off) value send 0 or 1
* switch - Switch (on|off) value send 0 or 1
* buttongroup : Button group, need options array
* buttongroup - Button group, need options array
* singleselect : Single select in a DropDown
* singleselect - Single select in a DropDown
* text : a short text witout line feed
* text - Short text without line feed
* integer : an integer
* integer - Integer value
* float : an float
* float - Float value
* columns : An integer between 1 to 12 (can be empty)
* columns - Integer value between 1 to 12 (can be empty)
* textarea : text with line feed
* textarea - Text with line feed


=Exemple of usage=
=Usage example=


<source lang="php">
<source lang="php">
Line 95: Line 94:


   /**
   /**
   * We can use the attribute like this , for example
   * We can use the attribute like this, for example
   */
   */
     public function beforeQuestionRender()
     public function beforeQuestionRender()

Latest revision as of 14:35, 19 November 2024

 Hint: This features is available starting in version 2.50

The event

When

This event happens each time the attribute definition is read for the installation. In general it happens one time only.

Input

None.

Possible output

  • Adding new attribute : $this->getEvent()->append('questionAttributes', $array); where arry is the new attribute.

Detail on definition

New attribute definition

It's an array:

attributeName=>[
    'types' : Apply to this question type
    'category' : Where to put it
    'sortorder' : Sort order in this category
    'inputtype' : type of input : [buttongroup,columns,integer,float,singleselect,switch,text,textarea]
    'options' : optionnal options if input type need it (for singleselect and buttongroup)
    'default' : the default value
    'i18n' : (optionnal) set to true for translatable attribute
    'caption' : the label
    'help' : an help
    'min' : (optionnal) use for integer or float type for min value to be set
    'max' : (optionnal) use for integer or float type for max value to be set
]

Input type

  • switch - Switch (on|off) value send 0 or 1
  • buttongroup - Button group, need options array
  • singleselect - Single select in a DropDown
  • text - Short text without line feed
  • integer - Integer value
  • float - Float value
  • columns - Integer value between 1 to 12 (can be empty)
  • textarea - Text with line feed

Usage example

<?php
class addAnAttribute extends PluginBase
{
    protected $storage = 'DbStorage';

    static protected $name = 'addAnAttribute';
    static protected $description = 'Add an attribute for any question';
    public function init()
    {
        $this->subscribe('newQuestionAttributes');
        $this->subscribe('beforeQuestionRender');
    }
    /**
   * We add the attribute here
   */
    public function newQuestionAttributes()
    {
        $event = $this->getEvent();
        $questionAttributes = array(
            'exampleOne'=>array(
                "types"=>"STU",
                'category'=>gT('Other'),
                'sortorder'=>1,
                'inputtype'=>'text',
                'default'=>'',
                "help"=>'An example for short, long and huge text.',
                "caption"=>'A text attribute'
            ),
            'exampleTwo'=>array(
                "types"=>"L",
                'category'=>gT('Other'),
                'sortorder'=>2,
                'inputtype'=>'singleselect',
                'options'=>array(
                    0=>gT('No'),
                    1=>gT('No'),
                ),
                'default'=>0,
                "help"=>'An example for singleselect.',
                "caption"=>'A dropdown attribute'
            ),
        );
        $event->append('questionAttributes', $questionAttributes);
    }

   /**
  * We can use the attribute like this, for example
  */
    public function beforeQuestionRender()
    {
        $oAttributeOne=QuestionAttribute::model()->find("qid=:qid AND attribute=:attribute",array(":qid"=>$this->getEvent()->get('qid'),":attribute"=>"exampleOne"));
        $oAttributeTwo=QuestionAttribute::model()->find("qid=:qid AND attribute=:attribute",array(":qid"=>$this->getEvent()->get('qid'),":attribute"=>"exampleTwo"));
        /* OR */
        $aAttributes=QuestionAttribute::model()->getQuestionAttributes($this->getEvent()->get('qid'));
        $soAttributeOne=$aAttributes["exampleOne"];
        $soAttributeTwo=$aAttributes["exampleTwo"];
        /**
         * Do something
         */

    }
}