LimeSurvey Manual
Menu
Navigation
Main page
Recent changes
Random page
Help
Search
Special pages
Printable version
Recent changes
Help
English
Log in
Actions
Translate
Language statistics
Message group statistics
Export
Special
Export translations
Settings
Group
Activating a survey
Adding answers or subquestions
Administering LimeSurvey
Alternatives to the LimeSurvey import function
Assessments
Backup entire database
Batch deletion
Category:Advanced Question Settings
Category:General Question Options
Category:Question Settings
Central Participant Database
Changing an active survey
Check data integrity
Check question logic
Check survey logic - Advanced
Closing a survey
ComfortUpdate
Copy question
Data encryption
Data entry
Data policy settings
DateFunctions
Default answers
Delete question
Delete survey
Display/Export survey
Edit question
Email bounce tracking system
Email templates
Export question
Export responses
Exporting results
Expression Manager
Expression Manager sample surveys
ExpressionScript - Presentation
ExpressionScript Engine - Quick start guide
ExpressionScript examples
ExpressionScript How-tos
ExpressionScript sample surveys
Extension compatibility
Failed email notifications
First login - your user preferences
General FAQ
General settings
Getting started
Global settings
Google API howto
Home page settings
How to design a good survey (guide)
Import responses
Importing a survey
Installation - LimeSurvey CE
Installation FAQ
Installation of the LimeSurvey XAMPP package
Installation security hints
Installation using a command line interface (CLI)
Installation Version 1.92 or older
Iterate survey
Label sets
LDAP settings
License
LimeSurvey Manual
LimeSurvey PRO vs LimeSurvey CE
LimeSurvey Users
LimeSurvey Video-Tutorial
LimeSurvey-compatible hosting companies
List question groups
List questions
Localization
Major version upgrade
Make your plugin compatible with LS4
Manage user groups
Manage users
Menu configuration
Menu entries configuration
Multilingual survey
New Template System in LS3.x
Not categorized and advanced features
Notifications & data
Optional settings
Overview
Panel integration
Participant settings
Plugin manager
Plugin menu
Plugins - advanced
Presentation
Preview function
Problems & solutions
Publication & access
QS:Allowed filetypes
QS:Alphasort
QS:Answer width
QS:Array filter
QS:Array filter exclude
QS:Array filter style
QS:Assessment value
QS:Autocheck exclusive option
QS:Category separator
QS:Chart type
QS:Choice column width
QS:Choice header
QS:Code filter
QS:Commented checkbox
QS:CSS Class
QS:Date max
QS:Date min
QS:Date time format
QS:Display chart
QS:Display columns
QS:Display map
QS:Display rows
QS:Display type
QS:Dropdown dates
QS:Dropdown dates year max
QS:Dropdown dates year min
QS:Dropdown prefix
QS:Dropdown prepostfix
QS:Dropdown separators
QS:Dropdown size
QS:Dualscale headerA
QS:Dualscale headerB
QS:Em validation q
QS:Em validation q tip
QS:Em validation sq
QS:Em validation sq tip
QS:Encryption
QS:Equals num value
QS:Equation
QS:Exclusive option
QS:Get order previous q
QS:Hidden
QS:Hide tip
QS:Input box size
QS:Input boxes
QS:Input max characters
QS:Label column width
QS:Location city
QS:Location country
QS:Location defaultcoordinates
QS:Location mapheight
QS:Location mapservice
QS:Location mapwidth
QS:Location mapzoom
QS:Location nodefaultfromip
QS:Location postal
QS:Location state
QS:Mandatory
QS:Max answers
QS:Max filesize
QS:Max num value
QS:Max num value n
QS:Max num value sgqa
QS:Max subquestions
QS:Maximum chars
QS:Maximum number of files
QS:Min answers
QS:Min num value
QS:Min num value n
QS:Minimum number of files
QS:Minute step interval
QS:Month display style
QS:Multiflexible checkbox
QS:Multiflexible max
QS:Multiflexible min
QS:Multiflexible step
QS:Num value int only
QS:Numbers only
QS:Other
QS:Other comment mandatory
QS:Other numbers only
QS:Other Position
QS:Other replace text
QS:Page break
QS:Prefix
QS:Preg validation
QS:Printable survey relevance help
QS:Public statistics
QS:Question theme
QS:Random group
QS:Random order
QS:Rank header
QS:Relevance
QS:Remove text or uncheck checkbox
QS:Repeat headers
QS:Reverse
QS:Samechoiceheight
QS:Samelistheight
QS:Scale export
QS:Show comment
QS:Show grand total
QS:Show title
QS:Show totals
QS:Showpopups
QS:Slider accuracy
QS:Slider default
QS:Slider handle shape
QS:Slider handle Unicode shape
QS:Slider initial value
QS:Slider layout
QS:Slider max
QS:Slider middlestart
QS:Slider min
QS:Slider orientation
QS:Slider rating
QS:Slider reset
QS:Slider reverse
QS:Slider separator
QS:Slider showminmax
QS:Subquestion width
QS:Suffix
QS:Text input width
QS:Theme editor - advanced options
QS:Time limit
QS:Time limit action
QS:Time limit countdown message
QS:Time limit disable next
QS:Time limit disable prev
QS:Time limit message
QS:Time limit message delay
QS:Time limit message style
QS:Time limit timer style
QS:Time limit warning
QS:Time limit warning display time
QS:Time limit warning message
QS:Time limit warning style
QS:Use dropdown
QS:Value range allows missing
Question groups - introduction
Question toolbar options
Question type - 5 point choice
Question type - Array
Question type - Array (10 point choice)
Question type - Array (5 point choice)
Question type - Array (Increase-Same-Decrease)
Question type - Array (Numbers)
Question type - Array (Texts)
Question type - Array (Yes-No-Uncertain)
Question type - Array by column
Question type - Array dual scale
Question type - Date
Question type - Equation
Question type - File upload
Question type - Gender
Question type - Huge free text
Question type - Language switch
Question type - List (Dropdown)
Question type - List (Radio)
Question type - List with comment
Question type - Long free text
Question type - Multiple choice
Question type - Multiple choice with comments
Question type - Multiple numerical input
Question type - Multiple short text
Question type - Numerical input
Question type - Ranking
Question type - Short free text
Question type - Text display
Question type - Yes-No
Question types
Questions - introduction
QueXML PDF Export
Quick start guide - LimeSurvey 2.50+
Quick start guide - LimeSurvey 3.0+
Quick-translation
Regenerate question codes
Reorder questions and question groups
Reset conditions
Resources
Responses & statistics
Responses (survey results)
Running a survey safely
Setting conditions
SGQA identifier
Statistics
Survey group permissions
Survey menu
Survey participants
Survey permissions
Survey quotas
Survey settings
Survey settings version 2
Survey structure
Survey toolbar options
Surveys - introduction
Surveys - management
Tab Separated Value survey structure
Template:Deprecated
Template:DeprecatedIn
Template:Example
Template:FeatureChange
Template:FeatureStarting
Template:Hint
Template:NewIn
Template:UpdatedIn
Testing a survey
Text elements
Theme editor
Theme options
Themes
Timing statistics
Tools
Transferring an installation
Translating LimeSurvey
Troubleshooting
TwoFactorAdminLogin
Upgrading from a previous version
URL fields
Using regular expressions
Version change log
Version guide
View saved but not submitted responses
Workarounds
Language
aa - Afar
ab - Abkhazian
abs - Ambonese Malay
ace - Achinese
acm - Iraqi Arabic
ady - Adyghe
ady-cyrl - Adyghe (Cyrillic script)
aeb - Tunisian Arabic
aeb-arab - Tunisian Arabic (Arabic script)
aeb-latn - Tunisian Arabic (Latin script)
af - Afrikaans
aln - Gheg Albanian
alt - Southern Altai
am - Amharic
ami - Amis
an - Aragonese
ang - Old English
ann - Obolo
anp - Angika
ar - Arabic
arc - Aramaic
arn - Mapuche
arq - Algerian Arabic
ary - Moroccan Arabic
arz - Egyptian Arabic
as - Assamese
ase - American Sign Language
ast - Asturian
atj - Atikamekw
av - Avaric
avk - Kotava
awa - Awadhi
ay - Aymara
az - Azerbaijani
azb - South Azerbaijani
ba - Bashkir
ban - Balinese
ban-bali - Balinese (Balinese script)
bar - Bavarian
bbc - Batak Toba
bbc-latn - Batak Toba (Latin script)
bcc - Southern Balochi
bci - Baoulé
bcl - Central Bikol
bdr - West Coast Bajau
be - Belarusian
be-tarask - Belarusian (Taraškievica orthography)
bew - Betawi
bg - Bulgarian
bgn - Western Balochi
bh - Bhojpuri
bho - Bhojpuri
bi - Bislama
bjn - Banjar
blk - Pa'O
bm - Bambara
bn - Bangla
bo - Tibetan
bpy - Bishnupriya
bqi - Bakhtiari
br - Breton
brh - Brahui
bs - Bosnian
btm - Batak Mandailing
bto - Iriga Bicolano
bug - Buginese
bxr - Russia Buriat
ca - Catalan
cbk-zam - Chavacano
cdo - Min Dong Chinese
ce - Chechen
ceb - Cebuano
ch - Chamorro
cho - Choctaw
chr - Cherokee
chy - Cheyenne
ckb - Central Kurdish
co - Corsican
cps - Capiznon
cpx - Pu-Xian Min
cpx-hans - Pu-Xian Min (Simplified Han script)
cpx-hant - Pu-Xian Min (Traditional Han script)
cpx-latn - Pu-Xian Min (Latin script)
cr - Cree
crh - Crimean Tatar
crh-cyrl - Crimean Tatar (Cyrillic script)
crh-latn - Crimean Tatar (Latin script)
crh-ro - Crimean Tatar (Romania)
cs - Czech
csb - Kashubian
cu - Church Slavic
cv - Chuvash
cy - Welsh
da - Danish
dag - Dagbani
de - German
de-at - Austrian German
de-ch - Swiss High German
de-formal - German (formal address)
dga - Dagaare
din - Dinka
diq - Zazaki
dsb - Lower Sorbian
dtp - Central Dusun
dty - Doteli
dv - Divehi
dz - Dzongkha
ee - Ewe
egl - Emilian
el - Greek
eml - Emiliano-Romagnolo
en - English
en-ca - Canadian English
en-gb - British English
eo - Esperanto
es - Spanish
es-419 - Latin American Spanish
es-formal - Spanish (formal address)
et - Estonian
eu - Basque
ext - Extremaduran
fa - Persian
fat - Fanti
ff - Fula
fi - Finnish
fit - Tornedalen Finnish
fj - Fijian
fo - Faroese
fon - Fon
fr - French
frc - Cajun French
frp - Arpitan
frr - Northern Frisian
fur - Friulian
fy - Western Frisian
ga - Irish
gaa - Ga
gag - Gagauz
gan - Gan Chinese
gan-hans - Gan (Simplified)
gan-hant - Gan (Traditional)
gcr - Guianan Creole
gd - Scottish Gaelic
gl - Galician
gld - Nanai
glk - Gilaki
gn - Guarani
gom - Goan Konkani
gom-deva - Goan Konkani (Devanagari script)
gom-latn - Goan Konkani (Latin script)
gor - Gorontalo
got - Gothic
gpe - Ghanaian Pidgin
grc - Ancient Greek
gsw - Alemannic
gu - Gujarati
guc - Wayuu
gur - Frafra
guw - Gun
gv - Manx
ha - Hausa
hak - Hakka Chinese
haw - Hawaiian
he - Hebrew
hi - Hindi
hif - Fiji Hindi
hif-latn - Fiji Hindi (Latin script)
hil - Hiligaynon
hno - Northern Hindko
ho - Hiri Motu
hr - Croatian
hrx - Hunsrik
hsb - Upper Sorbian
hsn - Xiang Chinese
ht - Haitian Creole
hu - Hungarian
hu-formal - Hungarian (formal address)
hy - Armenian
hyw - Western Armenian
hz - Herero
ia - Interlingua
id - Indonesian
ie - Interlingue
ig - Igbo
igl - Igala
ii - Sichuan Yi
ik - Inupiaq
ike-cans - Eastern Canadian (Aboriginal syllabics)
ike-latn - Eastern Canadian (Latin script)
ilo - Iloko
inh - Ingush
io - Ido
is - Icelandic
it - Italian
iu - Inuktitut
ja - Japanese
jam - Jamaican Creole English
jbo - Lojban
jut - Jutish
jv - Javanese
ka - Georgian
kaa - Kara-Kalpak
kab - Kabyle
kai - Karekare
kbd - Kabardian
kbd-cyrl - Kabardian (Cyrillic script)
kbp - Kabiye
kcg - Tyap
kea - Kabuverdianu
kg - Kongo
khw - Khowar
ki - Kikuyu
kiu - Kirmanjki
kj - Kuanyama
kjh - Khakas
kjp - Eastern Pwo
kk - Kazakh
kk-arab - Kazakh (Arabic script)
kk-cn - Kazakh (China)
kk-cyrl - Kazakh (Cyrillic script)
kk-kz - Kazakh (Kazakhstan)
kk-latn - Kazakh (Latin script)
kk-tr - Kazakh (Turkey)
kl - Kalaallisut
km - Khmer
kn - Kannada
ko - Korean
ko-kp - Korean (North Korea)
koi - Komi-Permyak
kr - Kanuri
krc - Karachay-Balkar
kri - Krio
krj - Kinaray-a
krl - Karelian
ks - Kashmiri
ks-arab - Kashmiri (Arabic script)
ks-deva - Kashmiri (Devanagari script)
ksh - Colognian
ksw - S'gaw Karen
ku - Kurdish
ku-arab - Kurdish (Arabic script)
ku-latn - Kurdish (Latin script)
kum - Kumyk
kus - Kʋsaal
kv - Komi
kw - Cornish
ky - Kyrgyz
la - Latin
lad - Ladino
lb - Luxembourgish
lbe - Lak
lez - Lezghian
lfn - Lingua Franca Nova
lg - Ganda
li - Limburgish
lij - Ligurian
liv - Livonian
lki - Laki
lld - Ladin
lmo - Lombard
ln - Lingala
lo - Lao
loz - Lozi
lrc - Northern Luri
lt - Lithuanian
ltg - Latgalian
lus - Mizo
luz - Southern Luri
lv - Latvian
lzh - Literary Chinese
lzz - Laz
mad - Madurese
mag - Magahi
mai - Maithili
map-bms - Basa Banyumasan
mdf - Moksha
mg - Malagasy
mh - Marshallese
mhr - Eastern Mari
mi - Māori
min - Minangkabau
mk - Macedonian
ml - Malayalam
mn - Mongolian
mnc - Manchu
mnc-latn - Manchu (Latin script)
mnc-mong - Manchu (Mongolian script)
mni - Manipuri
mnw - Mon
mo - Moldovan
mos - Mossi
mr - Marathi
mrh - Mara
mrj - Western Mari
ms - Malay
ms-arab - Malay (Jawi script)
mt - Maltese
mus - Muscogee
mwl - Mirandese
my - Burmese
myv - Erzya
mzn - Mazanderani
na - Nauru
nah - Nāhuatl
nan - Min Nan Chinese
nap - Neapolitan
nb - Norwegian Bokmål
nds - Low German
nds-nl - Low Saxon
ne - Nepali
new - Newari
ng - Ndonga
nia - Nias
niu - Niuean
nl - Dutch
nl-informal - Dutch (informal address)
nmz - Nawdm
nn - Norwegian Nynorsk
no - Norwegian
nod - Northern Thai
nog - Nogai
nov - Novial
nqo - N’Ko
nrm - Norman
nso - Northern Sotho
nv - Navajo
ny - Nyanja
nyn - Nyankole
nys - Nyungar
oc - Occitan
ojb - Northwestern Ojibwa
olo - Livvi-Karelian
om - Oromo
or - Odia
os - Ossetic
pa - Punjabi
pag - Pangasinan
pam - Pampanga
pap - Papiamento
pcd - Picard
pcm - Nigerian Pidgin
pdc - Pennsylvania German
pdt - Plautdietsch
pfl - Palatine German
pi - Pali
pih - Norfuk / Pitkern
pl - Polish
pms - Piedmontese
pnb - Western Punjabi
pnt - Pontic
prg - Prussian
ps - Pashto
pt - Portuguese
pt-br - Brazilian Portuguese
pwn - Paiwan
qu - Quechua
qug - Chimborazo Highland Quichua
rgn - Romagnol
rif - Riffian
rki - Arakanese
rm - Romansh
rmc - Carpathian Romani
rmy - Vlax Romani
rn - Rundi
ro - Romanian
roa-tara - Tarantino
rsk - Pannonian Rusyn
ru - Russian
rue - Rusyn
rup - Aromanian
ruq - Megleno-Romanian
ruq-cyrl - Megleno-Romanian (Cyrillic script)
ruq-latn - Megleno-Romanian (Latin script)
rw - Kinyarwanda
ryu - Okinawan
sa - Sanskrit
sah - Yakut
sat - Santali
sc - Sardinian
scn - Sicilian
sco - Scots
sd - Sindhi
sdc - Sassarese Sardinian
sdh - Southern Kurdish
se - Northern Sami
se-fi - Northern Sami (Finland)
se-no - Northern Sami (Norway)
se-se - Northern Sami (Sweden)
sei - Seri
ses - Koyraboro Senni
sg - Sango
sgs - Samogitian
sh - Serbo-Croatian
sh-cyrl - Serbo-Croatian (Cyrillic script)
sh-latn - Serbo-Croatian (Latin script)
shi - Tachelhit
shi-latn - Tachelhit (Latin script)
shi-tfng - Tachelhit (Tifinagh script)
shn - Shan
shy - Shawiya
shy-latn - Shawiya (Latin script)
si - Sinhala
simple - Simple English
sjd - Kildin Sami
sje - Pite Sami
sk - Slovak
skr - Saraiki
skr-arab - Saraiki (Arabic script)
sl - Slovenian
sli - Lower Silesian
sm - Samoan
sma - Southern Sami
smn - Inari Sami
sms - Skolt Sami
sn - Shona
so - Somali
sq - Albanian
sr - Serbian
sr-ec - Serbian (Cyrillic script)
sr-el - Serbian (Latin script)
srn - Sranan Tongo
sro - Campidanese Sardinian
ss - Swati
st - Southern Sotho
stq - Saterland Frisian
sty - Siberian Tatar
su - Sundanese
sv - Swedish
sw - Swahili
syl - Sylheti
szl - Silesian
szy - Sakizaya
ta - Tamil
tay - Tayal
tcy - Tulu
tdd - Tai Nuea
te - Telugu
tet - Tetum
tg - Tajik
tg-cyrl - Tajik (Cyrillic script)
tg-latn - Tajik (Latin script)
th - Thai
ti - Tigrinya
tk - Turkmen
tl - Tagalog
tly - Talysh
tly-cyrl - Talysh (Cyrillic script)
tn - Tswana
to - Tongan
tok - Toki Pona
tpi - Tok Pisin
tr - Turkish
tru - Turoyo
trv - Taroko
ts - Tsonga
tt - Tatar
tt-cyrl - Tatar (Cyrillic script)
tt-latn - Tatar (Latin script)
tum - Tumbuka
tw - Twi
ty - Tahitian
tyv - Tuvinian
tzm - Central Atlas Tamazight
udm - Udmurt
ug - Uyghur
ug-arab - Uyghur (Arabic script)
ug-latn - Uyghur (Latin script)
uk - Ukrainian
ur - Urdu
uz - Uzbek
uz-cyrl - Uzbek (Cyrillic script)
uz-latn - Uzbek (Latin script)
ve - Venda
vec - Venetian
vep - Veps
vi - Vietnamese
vls - West Flemish
vmf - Main-Franconian
vmw - Makhuwa
vo - Volapük
vot - Votic
vro - Võro
wa - Walloon
wal - Wolaytta
war - Waray
wls - Wallisian
wo - Wolof
wuu - Wu Chinese
wuu-hans - Wu Chinese (Simplified)
wuu-hant - Wu Chinese (Traditional)
xal - Kalmyk
xh - Xhosa
xmf - Mingrelian
xsy - Saisiyat
yi - Yiddish
yo - Yoruba
yrl - Nheengatu
yue - Cantonese
yue-hans - Cantonese (Simplified)
yue-hant - Cantonese (Traditional)
za - Zhuang
zea - Zeelandic
zgh - Standard Moroccan Tamazight
zh - Chinese
zh-cn - Chinese (China)
zh-hans - Simplified Chinese
zh-hant - Traditional Chinese
zh-hk - Chinese (Hong Kong)
zh-mo - Chinese (Macau)
zh-my - Chinese (Malaysia)
zh-sg - Chinese (Singapore)
zh-tw - Chinese (Taiwan)
zu - Zulu
Format
Export for off-line translation
Export in native format
Export in CSV format
Fetch
{{DISPLAYTITLE:Les greffons - avancé}}<languages /> <span id="Overview"></span> == Vue d'ensemble == À partir de LimeSurvey 2.05, LimeSurvey prendra officiellement en charge les plugins. Certains plugins seront supportés par l'équipe LimeSurvey et entreront dans le noyau. Certains seront soutenus par d'autres en dehors de l'équipe LimeSurvey. Pour vous aider à les trouver, consultez les [[Plugins tiers disponibles]] et ajoutez-y votre propre plugin ! Les plugins permettent aux utilisateurs de personnaliser les fonctionnalités de leur installation tout en bénéficiant de mises à jour logicielles régulières. Cette documentation est destinée aux développeurs qui étendent LimeSurvey pour leur propre usage ou pour leurs clients ; les utilisateurs finaux ne seront pas aidés par cette documentation. Les plugins doivent implémenter l'interface [https://github.com/LimeSurvey/LimeSurvey/blob/master/application/libraries/PluginManager/iPlugin.php iPlugin]. Nous vous recommandons d'étendre votre classe de plugin à partir de la classe [https://github.com/LimeSurvey/LimeSurvey/blob/master/application/libraries/PluginManager/PluginBase.php PluginBase]. Les plugins sont développés autour d'un mécanisme [http://manual.limesurvey.org/Plugin_events event]. <span id="Plugin_settings"></span> == Paramètres du plugin == En étendant, vous bénéficiez des fonctionnalités communes requises par les plugins que nous avons déjà implémentés pour vous. L'une de ces fonctions est l'implémentation de la fonction getPluginSettings. Cette fonction doit renvoyer un tableau décrivant les options de configuration pour l'utilisateur. L'exemple de plugin expose un seul paramètre configurable, le message qu'il affichera. <syntaxhighlight lang="php"> protected $settings = array( 'logo' => array( 'type' => 'logo', 'path' => 'assets/logo.png' ) , 'message' => array( 'type' => 'string', 'label' => 'Message' ) ); </syntaxhighlight> Le tableau contient un nom pour chaque paramètre sous forme de clé. Les valeurs sont des tableaux contenant les métadonnées requises. Les types pris en charge sont : * logo * int (nombre entier) * chaîne (alphanumérique) * texte * html * pertinence * info * mot de passe * date! * sélectionner Outre le type, un certain nombre d'autres clés sont disponibles : * label, définit une étiquette * par défaut, définit une valeur à afficher si aucune valeur n'est spécifiée (uniquement pour les paramètres globaux, pas pour les paramètres d'enquête) * current, définit la valeur actuelle. * readOnly : affiché les paramètres en lecture seule * htmlOptions, les htmlOptions de la partie d'entrée (voir le manuel Yii [[https://www.yiiframework.com/doc/api/1.1/CHtml]]) * pluginOptions, pour quelques paramètres (html ou select) : définissez l'option du widget * labelOptions : htmlOptions du label * controlOptions : htmlOptions du wrapper de label et input Vous pouvez trouver un exemple de plugin utilisant tous les paramètres réels sur [https://gitlab.com/SondagesPro/SampleAndDemo/exampleSettings exampleSettings] === Lire et écrire les paramètres du plugin === Il est possible de lire et d'écrire les paramètres du plugin directement à partir du code de votre plugin. Exemple: <syntaxhighlight lang="php"> $mySetting = $this->get('mySetting'); $this->set('mySetting', $mySetting + 1); </syntaxhighlight> Vous pouvez obtenir une valeur par défaut si le paramètre est nul : <syntaxhighlight lang="php"> $mySetting = $this->get('mySetting', null, null, 10); // 10 est la valeur par défaut </syntaxhighlight> === Survey specific plugin settings === Two events are used to create survey specific plugin settings: * newSurveySettings * beforeSurveySettings Example to disable a plugin for a specific survey: <syntaxhighlight lang="php"> public function init() { $this->subscribe('beforeSurveySettings'); $this->subscribe('newSurveySettings'); // Other events... } public function beforeSurveySettings() { $event = $this->event; $surveyId = intval($event->get('survey')); $event->set( "surveysettings.{$this->id}", [ 'name' => get_class($this), 'settings' => [ 'isActive' => [ 'type' => 'boolean', 'label' => 'isActive', 'current' => $this->getIsActive($surveyId), 'help' => 'Activate plugin for this survey' ], ] ] ); } public function newSurveySettings() { $event = $this->event; foreach ($event->get('settings') as $name => $value) { $this->set($name, $value, 'Survey', $event->get('survey'), false); } } private function getIsActive(int $sid): bool { return (bool) $this->get('isActive', 'Survey', $sid, false); } </syntaxhighlight> <span id="Events"></span> == Événements == Les plugins s'abonnent aux événements et peuvent interagir avec LimeSurvey lorsque l'événement est déclenché. Pour une liste des événements actuellement disponibles, consultez [[Événements du plugin]]. == API == Les plugins ne doivent étendre LimeSurvey que via son API "publique". Cela signifie qu’utiliser directement les classes trouvées dans le code source est une mauvaise pratique. Bien que nous ne puissions pas vous y obliger, vous risquez d'avoir un plugin défectueux à chaque mise à jour mineure que nous effectuons. Dans la mesure du possible, interagissez avec LimeSurvey uniquement via les méthodes décrites [http://api.limesurvey.org/classes/LimeSurvey.PluginManager.LimesurveyApi.html ici]. Idem pour les événements. L'objet API est disponible via <code>$this->api</code> lors de l'extension depuis PluginBase, sinon vous pouvez l'obtenir à partir de l'instance PluginManager qui est transmise au constructeur de vos plugins. De nouvelles fonctions peuvent être ajoutées à l'objet API sur demande. <span id="Form_extension{{NewIn|v=6}}"></span> == Extension de formulaire{{NewIn|v=6}} == <span id="Introduction"></span> === Présentation === Le système d'extension de formulaire est un moyen plus général d'étendre les formulaires dans le noyau de LimeSurvey sans ajouter de nouvel événement pour chaque formulaire. Il se compose des éléments suivants : * Un module global appelé '''FormExtensionService''' * Une bibliothèque de '''classes d'entrée''' que les plugins peuvent ajouter à l'initialisation du module ci-dessus * Un '''widget''', ainsi que moteurs de rendu personnalisés, utilisés dans les fichiers de vue LimeSurvey Chaque formulaire est identifié par une '''chaîne de position''', comme<form name><dot><tab name> . Exemple : <code>globalsettings.general</code> ou <code>globalsettings.security</code> . L'objectif d'un système basé sur des classes sans HTML est de libérer les auteurs de plugins de l'œuvre pour qu'ils mettent à jour le code HTML lorsque le code HTML principal change. Néanmoins, l'auteur peut utiliser le type <code>RawHtmlInput</code> si nécessaire. Une chose que vous ne pouvez pas faire dans ce système est d'ajouter de « nouveaux onglets de formulaire ». <span id="Example"></span> === Exemple === Pour ajouter une nouvelle entrée à un formulaire à partir d'un plugin, utilisez le code suivant de votre fonction <code>init()</code> : TODO : Enregistrer dans les paramètres du plugin au lieu de global <syntaxhighlight lang="php"> // En haut du fichier utilisez LimeSurvey\Libraries\FormExtension\Inputs\TextInput; utilisez LimeSurvey\Libraries\FormExtension\SaveFailedException; // À l'intérieur de init() Yii::app()->formExtensionService->add( 'globalsettings.general', new TextInput([ 'name' => 'myinput', 'label' => 'Label', 'disabled' => true, 'tooltip' => 'Moo moo moo', 'help' => 'Un texte d'aide', 'save' => function($request, $connection) { $value = $request->getPost('myinput'); if ($value === 'une valeur invalide') { throw new SaveFailedException("Impossible d'enregistrer l'entrée personnalisée 'myinput'"); } else { SettingGlobal::setSetting('myinput', $value); } } , 'load' => function () { return getGlobalSetting('myinput'); } ]) ); </syntaxhighlight> === Validation === La validation de la saisie se fait dans la fonction <code>save</code> (voir exemple ci-dessus). Si la valeur publiée n'est pas valide, lancez une <code>SaveFailedException</code> et un message flash d'avertissement sera affiché à l'utilisateur. <span id="Supported_forms"></span> === Formulaires pris en charge === Les formulaires suivants peuvent être étendus : * globalsettings.general{{NewIn|v=6.0.0}} Si vous souhaitez ajouter la prise en charge d'un autre formulaire principal, vous devez appliquer la modification suivante dans une pull-request : Dans le fichier de vue, ajoutez : <syntaxhighlight lang="php"> <?php use LimeSurvey\Libraries\FormExtension\FormExtensionWidget; use LimeSurvey\Libraries\FormExtension\Inputs\DefaultBaseRenderer; ?> ... plus HTML <?= FormExtensionWidget::render( App()-> formExtensionService->getAll('globalsettings.security'), nouveau DefaultBaseRenderer() ); ?> </syntaxhighlight> Vous devrez peut-être créer une nouvelle classe de rendu basée sur <code>DefaultBaseRenderer</code> , si le formulaire HTML est différent des autres formulaires. Vous devrez peut-être également étendre la classe de rendu par défaut avec des types d'entrée non encore ajoutés. La deuxième modification que vous devez effectuer est d'ajouter un appel à la classe de service d'extension de formulaire dans l'action du contrôleur qui enregistre le formulaire : <syntaxhighlight lang="php"> $request = App()->request; Yii::app()->formExtensionService->applySave('globalsettings', $request); </syntaxhighlight> C'est ça! <span id="Localization_{{NewIn|v=3}}"></span> == Localisation {{NewIn|v=3}} == Il est possible pour les plugins d'ajouter leurs propres fichiers de paramètres régionaux. Le format de fichier utilisé est .mo, identique aux traductions principales. Les fichiers doivent être stockés dans <plugin root folder>/lieu/<language> /<language> .mo où "<language> " est un mot de deux lettres comme "de" ou "fr". Pour utiliser le fichier de paramètres régionaux spécifique, utilisez la fonction plugin gT : <syntaxhighlight lang="php"> $this->gT("Un texte de plugin à traduire"); </syntaxhighlight> Si la chaîne donnée ne peut pas être trouvée dans le fichier de paramètres régionaux spécifique au plugin, la fonction recherchera dans les fichiers de paramètres régionaux principaux. Il est donc prudent d'utiliser des chaînes telles que « Annuler » : <syntaxhighlight lang="php"> $this->gT("Annuler"); // Sera traduit même si "Annuler" n'est pas dans le fichier de paramètres régionaux du plugin </syntaxhighlight> Si vous utilisez des vues avec votre plugin, vous devez utiliser <syntaxhighlight lang="php"> $plugin->gT("Traduisez-moi"); </syntaxhighlight> pour faire une traduction spécifique au plugin à votre avis. Vous pouvez utiliser le fichier [https://github.com/LimeSurvey/LimeSurvey/blob/master/locale/_template/limesurvey.pot limesurvey.pot] comme exemple de ce à quoi peut ressembler un fichier pot. Celui-ci est importé dans votre outil de traduction. <span id="Tools"></span> === Outils === Un outil open source pour éditer les fichiers po et mo est [https://poedit.net/ Poedit]. <span id="Logging_{{NewIn|v=3}}"></span> == Journalisation {{NewIn|v=3}} == Si vous souhaitez enregistrer quelque chose depuis votre plugin, écrivez simplement <syntaxhighlight lang="php"> $this->log("Votre message"); </syntaxhighlight> Le niveau de journalisation par défaut est trace, mais vous pouvez donner un autre niveau de journalisation comme deuxième argument facultatif : <syntaxhighlight lang="php"> $this->log("Quelque chose s'est mal passé !", CLogger::LEVEL_ERROR); </syntaxhighlight> Le fichier journal se trouve dans le dossier <limesurvey root folder>/tmp/runtime/plugin.log Le nom de votre plugin est automatiquement utilisé comme catégorie. Une bonne façon de voir uniquement les erreurs de votre plugin consiste à utiliser grep (sous Linux) : $ tail -f tmp/runtime/plugin.log | grep<your plugin name> Plus d'informations sur la configuration de la journalisation dans Yii 1 : [[Optional_settings#Logging_settings]]. <span id="Extension_updates_{{NewIn|v=4}}"></span> == Mises à jour de l'extension {{NewIn|v=4}} == Depuis la version 4.0.0 de LimeSurvey, un système est en place pour gérer les mises à jour des plugins et autres extensions. Pour utiliser ce système, votre fichier d'extension config.xml doit inclure la configuration du programme de mise à jour. <syntaxhighlight lang="xml"> <updaters> <updater> <stable> 1</stable> <type> repos</type> <source> https://comfortupdate.limesurvey.org/index.php?r=limestorest</source> <manualUpdateUrl> https://somedownloadlink.com/maybegithub</manualUpdateUrl> </updater> </updaters> </syntaxhighlight> (La balise source ci-dessus pointe vers l'API REST LimeStore, qui sera utilisée pour toutes les extensions disponibles dans notre LimeStore.) {| class="wikitable" |+ Descriptions des balises du programme de mise à jour |- ! Marquez ! Description |- | stable | "1" si cette source ne vous donne que des numéros de version stables ; "0" si la source fournira également des versions instables, comme <code>0.3.3-beta</code> . |- | tapez | Pour l’instant, seul le type <code>rest</code> est pris en charge. Il est facile d'ajouter de nouveaux types de programmes de mise à jour (vérificateurs de versions), comme git, wget, etc. |- | source | L'URL à partir de laquelle récupérer les nouvelles versions. |- | manualUpdateUrl | URL vers laquelle l'utilisateur peut accéder pour mettre à jour la dernière version de l'extension. |- | URL de mise à jour automatique | À FAIRE |} Si vous ne souhaitez pas fournir de programme de mise à jour, vous devez mettre le texte suivant dans votre fichier XML de configuration : <syntaxhighlight lang="xml"> <updaters disabled="disabled"> </updaters> </syntaxhighlight> De cette façon, vous indiquez au système que vous avez délibérément désactivé le système de mise à jour et que vous n'avez pas simplement oublié de l'ajouter. Le nouveau plugin '''UpdateCheck''' - installé et activé par défaut - vérifie les nouvelles mises à jour pour ''toutes'' les extensions installées lorsqu'un super administrateur se connecte, de manière asynchrone, au maximum une fois toutes les 24 heures. Si de nouvelles versions sont trouvées, une notification est envoyée. [[File:availableupdates.png||Mises à jour disponibles]] Si une nouvelle mise à jour de sécurité est trouvée, la notification s'ouvrira automatiquement et sera classée en classe « danger ». [[File:availablesecurityupdates.png||Mises à jour de sécurité disponibles]] Vous pouvez vérifier manuellement les mises à jour en accédant à la vue du gestionnaire de plugins et en cliquant sur « Vérifier les mises à jour ». Notez que ce bouton n'est visible que si le plugin UpdateCheck est activé. [[File:manuallycheckforupdates.png||Vérifier manuellement les mises à jour]] <span id="Under_the_hood"></span> === Sous le capot === Cette section fournit un bref aperçu de l'implémentation du programme de mise à jour de l'extension. Le programme de mise à jour de l'extension fait partie de la bibliothèque ExtensionInstaller. Vous trouverez ci-dessous un diagramme UML pour les classes liées au processus de mise à jour. [[File:extensionupdateruml.png||Diagramme UML du programme de mise à jour d'extension]] Déroulement du programme au démarrage de Yii : <pre> Yii init VersionFetcherServiceLocator->init() Ajoutez un outil de récupération de version REST ExtensionUpdaterServiceLocator->init() Ajoutez PluginUpdater TODO : Ajouter un updater pour chaque type d'extension (thème, modèle de question, ...) </pre> Déroulement du programme lors de l'exécution du plugin UpdaterCheck : <pre> Obtenez toutes les mises à jour de ExtensionUpdaterServiceLocator Bouclez chaque programme de mise à jour Pour chaque programme de mise à jour, parcourez les récupérateurs de versions configurés par<updater> XML Pour chaque outil de récupération de version, contactez la source distante et obtenez des informations sur la version Composez toutes les versions dans une notification </pre> La méthode [https://github.com/LimeSurvey/LimeSurvey/blob/develop/application/core/plugins/UpdateCheck/UpdateCheck.php#L130 checkAll] du plugin UpdateCheck fournit un exemple de la façon d'interroger toutes les extensions pour les nouvelles versions. <span id="Adding_new_version_fetchers"></span> ==== Ajout de nouveaux récupérateurs de version ==== Pour ajouter un nouveau récupérateur de version personnalisé, exécutez ceci lors de l'initialisation de Yii : <syntaxhighlight lang="php"> $service = \Yii::app()->versionFetcherServiceLocator $service->addVersionFetcherType( 'myNewVersionFetcherType', function (\SimpleXMLElement $updaterXml) { return new MyNewVersionFetcher( $updaterXml); } ); </syntaxhighlight> Bien entendu, la classe <code>MyNewVersionFetcher</code> doit sous-classer <code>VersionFetcher</code> . Pour utiliser votre nouveau récupérateur de version, configurez la balise <code>type</code> dans le XML du programme de mise à jour pour utiliser <code>myNewVersionFetcherType</code> (au lieu par exemple <code>rest</code> ). <span id="Adding_new_extension_updaters"></span> ==== Ajout de nouveaux programmes de mise à jour d'extension ==== Pour ajouter un nouveau programme de mise à jour d'extension personnalisé, exécutez ceci lors de l'initialisation de Yii : <syntaxhighlight lang="php"> $service = \Yii::app()->extensionUpdaterServiceLocator; $service->addUpdaterType( 'myNewExtensionUpdater', function () { return MyNewExtensionUpdater::createUpdaters() ; } ); </syntaxhighlight> La classe <code>MyNewExtensionUpdater</code> doit sous-classer <code>ExtensionUpdater</code> . La balise <code>type</code> supérieure dans config.xml (« plugin », « thème », ...) contrôlera quel programme de mise à jour d'extension est utilisé pour cette extension. Le système n'est pas encore entièrement personnalisable, puisque vous devez également ajouter un ExtensionInstaller personnalisé, des éléments de menu, etc. Mais en théorie, et peut-être dans le futur, il devrait être possible d'ajouter un nouveau type d'extension de cette façon. <span id="Extension_installer"></span> == Installateur d'extensions == La bibliothèque d'installation d'extension se compose de deux classes abstraites : * ExtensionInstaller * FileFetcher ExtensionInstaller est une sous-classe pour chaque type d'extension, comme PluginInstaller, QuestionThemeInstaller, etc. Le FileFetcher est sous-classé pour chaque manière différente de récupérer des fichiers. Actuellement, seuls les fichiers zip téléchargés sont pris en charge, mais à l'avenir, il pourrait également y avoir un outil de récupération Github ou LimeStore. [[File: extensioninstalleruml.png]] <span id="Special_plugins"></span> == Plugins spéciaux == * [[Développement de plugin d'authentification]] * [[Développement de plugin d'exportation]] <div class="mw-translate-fuzzy"> == Plugins disponibles == * [[Plugins d'authentification]] * [[Journal d'audit]] * [[CintLink]] * [[Plugins tiers disponibles]] </div> == Tutoriel == [https://medium.com/@evently/creating-limesurvey-plugins-adcdf8d7e334 Ce] tutoriel étape par étape montre comment créer un plugin qui envoie une demande de publication à chaque réponse à une enquête soumission. Le didacticiel vous montre comment créer et enregistrer des paramètres globaux et par enquête, comment enregistrer des événements et bien plus encore. [[Catégorie:Développement]] [[Catégorie:Plugins]]