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
Custom translation
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:Wtyczki - zaawansowane}}<languages /> <span id="Overview"></span> == Przegląd == Począwszy od LimeSurvey 2.05, LimeSurvey będzie oficjalnie wspierać wtyczki. Niektóre wtyczki będą obsługiwane przez zespół LimeSurvey i zostaną włączone do rdzenia. Niektórzy będą wspierani przez innych spoza zespołu LimeSurvey. Aby pomóc je znaleźć, sprawdź [[Dostępne wtyczki innych firm]] i dodaj do niej własną wtyczkę! Wtyczki umożliwiają użytkownikom dostosowanie funkcjonalności ich instalacji, jednocześnie umożliwiając korzystanie z regularnych aktualizacji oprogramowania. Niniejsza dokumentacja jest przeznaczona dla programistów, którzy rozszerzają LimeSurvey na własny użytek lub dla swoich klientów; ta dokumentacja nie pomoże użytkownikom końcowym. Wtyczki muszą implementować interfejs [https://github.com/LimeSurvey/LimeSurvey/blob/master/application/libraries/PluginManager/iPlugin.php iPlugin]. Zalecamy rozszerzenie klasy wtyczki z klasy [https://github.com/LimeSurvey/LimeSurvey/blob/master/application/libraries/PluginManager/PluginBase.php PluginBase]. Wtyczki są opracowywane w oparciu o mechanizm [http://manual.limesurvey.org/Plugin_events event]. <span id="Plugin_settings"></span> == Ustawienia wtyczki == Rozszerzając, zyskujesz wspólną funkcjonalność wymaganą przez wtyczki, które już dla Ciebie wdrożyliśmy. Jedną z takich funkcji jest implementacja funkcji getPluginSettings. Funkcja ta musi zwrócić tablicę opisującą opcje konfiguracyjne dla użytkownika. Przykładowa wtyczka udostępnia tylko 1 konfigurowalne ustawienie, komunikat, który wyświetli. <syntaxhighlight lang="php"> protected $settings = array( 'logo' => array( 'type' => 'logo', 'path' => 'assets/logo.png' ) , 'message' => array( 'type' => 'string', 'label' => 'Wiadomość' ) ); </syntaxhighlight> Tablica zawiera nazwę każdego ustawienia jako klucz. Wartości to tablice zawierające wymagane metadane. Obsługiwane typy to: * logo * int (liczba całkowita) * string (alfanumeryczny) * tekst * html * znaczenie * info * hasło * data * wybierz Oprócz typu dostępnych jest wiele innych klawiszy: * label, definiuje etykietę * default, definiuje wartość wyświetlaną, jeśli nie określono żadnej wartości (tylko dla ustawień globalnych, nie dla ustawień ankiety) * current, definiuje aktualną wartość. * readOnly : pokazał ustawienia jako tylko do odczytu * htmlOptions, htmlOptions części wejściowej (zobacz podręcznik Yii [[https://www.yiiframework.com/doc/api/1.1/CHtml]]) * pluginOptions, dla niektóre ustawienia (html lub wybierz): ustaw opcję widgetu * labelOptions : htmlOpcje etykiety * controlOptions : htmlOpcje opakowania etykiety i danych wejściowych Przykład wtyczki wykorzystującej wszystkie aktualne ustawienia można znaleźć pod adresem [https://gitlab.com/SondagesPro/SampleAndDemo/exampleSettings exampleSettings] === Odczyt i zapis ustawień wtyczki === Możliwe jest odczytywanie i zapisywanie ustawień wtyczki bezpośrednio z kodu wtyczki. Przykład: <syntaxhighlight lang="php"> $mySetting = $this->get('mySetting'); $this->set('mySetting', $mojeSetting + 1); </syntaxhighlight> Możesz uzyskać wartość domyślną, jeśli ustawienie ma wartość null: <syntaxhighlight lang="php"> $mySetting = $this->get('mySetting', null, null, 10); // 10 jest wartością domyślną </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> == Wydarzenia == Wtyczki subskrybują zdarzenia i mogą wchodzić w interakcję z LimeSurvey po uruchomieniu zdarzenia. Listę aktualnie dostępnych wydarzeń znajdziesz w [[Wydarzenia wtyczek]]. == API == Wtyczki powinny rozszerzać LimeSurvey wyłącznie poprzez jego „publiczne” API. Oznacza to, że bezpośrednie używanie klas znajdujących się w kodzie źródłowym jest złą praktyką. Chociaż nie możemy Cię do tego zmusić, ryzykujesz uszkodzeniem wtyczki przy każdej drobnej aktualizacji, którą przeprowadzamy. W miarę możliwości korzystaj z LimeSurvey wyłącznie metodami opisanymi [http://api.limesurvey.org/classes/LimeSurvey.PluginManager.LimesurveyApi.html tutaj]. Podobnie jak w przypadku wydarzeń. Obiekt API jest dostępny poprzez <code>$this->api</code> podczas rozszerzania z PluginBase, w przeciwnym razie można go pobrać z instancji PluginManager, która jest przekazywana do konstruktora wtyczek. Na życzenie do obiektu API można dodać nowe funkcje. <span id="Form_extension{{NewIn|v=6}}"></span> == Rozszerzenie formularza{{NewIn|v=6}} == <span id="Introduction"></span> === Wprowadzenie === System rozszerzania formularzy to bardziej ogólny sposób rozszerzania formularzy w rdzeniu LimeSurvey bez dodawania nowego zdarzenia dla każdego formularza. Składa się z następujących elementów: * Globalny moduł o nazwie „FormExtensionService” * Biblioteka „klas wejściowych”, które wtyczki mogą dodawać do powyższej inicjalizacji modułu * „Widżet” wraz z niestandardowe moduły renderujące, które są używane w plikach widoku LimeSurvey Każdy formularz jest identyfikowany przez „ciąg pozycji”, np<form name><dot><tab name> . Przykład: <code>globalsettings.general</code> lub <code>globalsettings.security</code> . Ideą systemu opartego na klasach bez HTML jest umożliwienie autorom wtyczek aktualizacji HTML, gdy zmienia się rdzeń HTML. Mimo to autor może w razie potrzeby użyć typu <code>RawHtmlInput</code> . Jednej rzeczy, której nie można zrobić w tym systemie, to dodać „nowe karty formularzy”. <span id="Example"></span> === Przykład === Aby dodać nowe dane wejściowe do formularza z wtyczki, użyj następującego kodu z funkcji <code>init()</code> : DO ZROBIENIA: Zapisz w ustawieniach wtyczki zamiast globalnie <syntaxhighlight lang="php"> // Na górze pliku użyj LimeSurvey\Libraries\FormExtension\Inputs\TextInput; użyj LimeSurvey\Libraries\FormExtension\SaveFailedException; // Wewnątrz init() Yii::app()->formExtensionService->add( 'globalsettings.general', new TextInput([ 'name' => 'moje wejście', 'label' => 'Etykieta', 'disabled' => true, 'tooltip' => 'Muu moo moo', 'help' => 'Tekst pomocy', 'save' => funkcja($żądanie, $połączenie) { $wartość = $żądanie->getPost('moje wejście'); if ($wartość === 'jakaś niepoprawna wartość') { rzucaj nowy SaveFailedException("Nie można zapisać niestandardowego wejścia 'moje wejście'"); } else { SettingGlobal::setSetting('moje wejście', $wartość); } } , 'load' => funkcja () { return getGlobalSetting('myinput'); } ]) ); </syntaxhighlight> <span id="Validation"></span> === Walidacja === Walidacja danych wejściowych odbywa się w funkcji <code>save</code> (patrz przykład powyżej). Jeśli opublikowana wartość jest nieprawidłowa, zgłoś <code>SaveFailedException</code> , a użytkownikowi zostanie wyświetlony ostrzegawczy komunikat flash. <span id="Supported_forms"></span> === Obsługiwane formularze === Można rozszerzyć następujące formy: * globalsettings.general{{NewIn|v=6.0.0}} Jeśli chcesz dodać obsługę innego formularza podstawowego, musisz zastosować następującą zmianę w żądaniu ściągnięcia: W pliku widoku dodaj: <syntaxhighlight lang="php"> <?php use LimeSurvey\Libraries\FormExtension\FormExtensionWidget; use LimeSurvey\Libraries\FormExtension\Inputs\DefaultBaseRenderer; ?> ... więcej HTML <?= FormExtensionWidget::render( App()-> formExtensionService->getAll('globalsettings.security'), nowy DefaultBaseRenderer() ); ?> </syntaxhighlight> Być może będziesz musiał utworzyć nową klasę renderującą opartą na <code>DefaultBaseRenderer</code> , jeśli formularz HTML różni się od innych formularzy. Może być także konieczne rozszerzenie domyślnej klasy modułu renderującego o typy danych wejściowych, które nie zostały jeszcze dodane. Drugą zmianą, którą musisz wykonać, jest dodanie wywołania klasy usługi rozszerzenia formularza w akcji kontrolera, która zapisuje formularz: <syntaxhighlight lang="php"> $request = App()->request; Yii::app()->formExtensionService->applySave('globalsettings', $request); </syntaxhighlight> Otóż to! <span id="Localization_{{NewIn|v=3}}"></span> == Lokalizacja {{NewIn|v=3}} == Wtyczki mogą dodawać własne pliki regionalne. Używany format pliku to .mo, taki sam jak w przypadku podstawowych tłumaczeń. Pliki muszą być przechowywane w formacie <plugin root folder>/widownia/<language> /<language> .mo Gdzie "<language> " to dwuliterowe słowo, takie jak "de" lub "fr". Aby użyć określonego pliku ustawień regionalnych, użyj funkcji wtyczki gT: <syntaxhighlight lang="php"> $this->gT("Tekst wtyczki do przetłumaczenia"); </syntaxhighlight> Jeśli podanego ciągu nie można znaleźć w pliku ustawień regionalnych wtyczki, funkcja przeszuka podstawowe pliki ustawień regionalnych. Można więc bezpiecznie używać ciągów takich jak „Anuluj”: <syntaxhighlight lang="php"> $this->gT("Anuluj"); // Zostanie przetłumaczone, nawet jeśli w pliku ustawień regionalnych wtyczki nie ma opcji „Anuluj” </syntaxhighlight> Jeśli używasz widoków razem ze swoją wtyczką, powinieneś użyć <syntaxhighlight lang="php"> $plugin->gT("Przetłumacz mi"); </syntaxhighlight> aby w Twoim widoku wykonać tłumaczenie specyficzne dla wtyczki. Możesz użyć pliku [https://github.com/LimeSurvey/LimeSurvey/blob/master/locale/_template/limesurvey.pot limesurvey.pot] jako przykładu wyglądu pliku pot. Zostanie to zaimportowane do Twojego narzędzia do tłumaczenia. <span id="Tools"></span> === Narzędzia === Jednym z narzędzi typu open source do edycji plików po i mo jest [https://poedit.net/Poedit]. <span id="Logging_{{NewIn|v=3}}"></span> == Rejestrowanie {{NewIn|v=3}} == Jeśli chcesz zalogować coś ze swojej wtyczki, po prostu napisz <syntaxhighlight lang="php"> $this->log("Twoja wiadomość"); </syntaxhighlight> Domyślny poziom rejestrowania to śledzenie, ale możesz podać inny poziom rejestrowania jako opcjonalny drugi argument: <syntaxhighlight lang="php"> $this->log("Coś poszło nie tak!", CLogger::LEVEL_ERROR); </syntaxhighlight> Plik dziennika można znaleźć w folderze <limesurvey root folder>/tmp/runtime/plugin.log Nazwa Twojej wtyczki zostanie automatycznie użyta jako kategoria. Dobrym sposobem na wyświetlenie tylko błędów z wtyczki jest użycie grep (w systemie Linux): $ tail -f tmp/runtime/plugin.log | grep<your plugin name> Więcej informacji na temat konfiguracji logowania w Yii 1: [[Optional_settings#Logging_settings]]. <span id="Extension_updates_{{NewIn|v=4}}"></span> == Aktualizacje rozszerzeń {{NewIn|v=4}} == Od wersji LimeSurvey 4.0.0 dostępny jest system obsługujący aktualizacje wtyczek i innych rozszerzeń. Aby móc korzystać z tego systemu, plik rozszerzenia config.xml musi zawierać konfigurację aktualizatora. <syntaxhighlight lang="xml"> <updaters> <updater> <stable> 1</stable> <type> odpoczynek</type> <source> https://comfortupdate.limesurvey.org/index.php?r=limestorerest</source> <manualUpdateUrl> https://somedownloadlink.com/maybegithub</manualUpdateUrl> </updater> </updaters> </syntaxhighlight> (Powyższy tag źródłowy wskazuje na interfejs API REST LimeStore, który będzie używany we wszystkich rozszerzeniach dostępnych w naszym LimeStore.) {| class="wikitable" |+ Opisy znaczników aktualizacji |- ! Oznacz ! Opis |- | stabilny | „1”, jeśli to źródło podaje tylko stabilne numery wersji; „0”, jeśli źródło będzie również dostarczać wersje niestabilne, np. <code>0.3.3-beta</code> . |- | wpisz | Na razie obsługiwany jest tylko typ <code>rest</code> . Dodawanie nowych typów aktualizacji (wersji sprawdzających), takich jak git, wget itp., jest łatwe |- | źródło | Adres URL, z którego można pobrać nowe wersje. |- | manualUpdateUrl | Adres URL, pod który użytkownik może przejść, aby zaktualizować najnowszą wersję rozszerzenia. |- | automatycznyUpdateUrl | DO ZROBIENIA |} Jeśli nie chcesz dostarczać aktualizatora, powinieneś umieścić następujący tekst w pliku konfiguracyjnym XML: <syntaxhighlight lang="xml"> <updaters disabled="disabled"> </updaters> </syntaxhighlight> W ten sposób informujesz system, że celowo wyłączyłeś system aktualizacji i nie zapomniałeś go dodać. Nowa wtyczka „UpdateCheck” – domyślnie zainstalowana i aktywowana – sprawdza dostępność nowych aktualizacji dla „wszystkich” zainstalowanych rozszerzeń, gdy superadministrator loguje się asynchronicznie, maksymalnie raz na 24 godziny. Jeśli zostaną znalezione nowe wersje, zostanie wyświetlone powiadomienie. [[File:availableupdates.png||Dostępne aktualizacje]] Jeśli zostanie znaleziona nowa aktualizacja zabezpieczeń, powiadomienie zostanie otwarte automatycznie i będzie oznaczone klasą „niebezpieczeństwo”. [[File:availablesecurityupdates.png||Dostępne aktualizacje zabezpieczeń]] Możesz ręcznie sprawdzić dostępność aktualizacji, przechodząc do widoku menedżera wtyczek i klikając „Sprawdź aktualizacje”. Pamiętaj, że ten przycisk jest widoczny tylko wtedy, gdy wtyczka UpdateCheck jest aktywna. [[File:manuallycheckforupdates.png||Ręcznie sprawdź dostępność aktualizacji]] <span id="Under_the_hood"></span> === Pod maską === Ta sekcja zawiera krótki przegląd implementacji aktualizatora rozszerzeń. Aktualizator rozszerzeń jest częścią biblioteki ExtensionInstaller. Poniżej znajduje się diagram UML dla klas związanych z procesem aktualizacji. [[File:extensionupdateruml.png||Schemat UML aktualizatora rozszerzeń]] Przebieg programu po uruchomieniu Yii: <pre> Yii init VersionFetcherServiceLocator->init() Dodaj moduł pobierania wersji REST ExtensionUpdaterServiceLocator->init() Dodaj PluginUpdater DO ZROBIENIA: Dodaj aktualizator dla każdego typu rozszerzenia (motyw, szablon pytania, ...) </pre> Przebieg programu podczas uruchamiania wtyczki UpdaterCheck: <pre> Pobierz wszystkie aktualizacje z ExtensionUpdaterServiceLocator Zapętlaj każdy aktualizator Dla każdego aktualizatora przejrzyj moduły pobierania wersji skonfigurowane przez<updater> XML W przypadku każdego modułu pobierania wersji skontaktuj się ze zdalnym źródłem i uzyskaj informacje o wersji Skomponuj wszystkie wersje w powiadomienie </pre> Metoda [https://github.com/LimeSurvey/LimeSurvey/blob/develop/application/core/plugins/UpdateCheck/UpdateCheck.php#L130 checkAll] we wtyczce UpdateCheck stanowi przykład sprawdzania wszystkich rozszerzeń w celu uzyskania nowych wersji . <span id="Adding_new_version_fetchers"></span> ==== Dodawanie nowych modułów pobierania wersji ==== Aby dodać nowy, niestandardowy moduł pobierania wersji, uruchom to podczas inicjalizacji Yii: <syntaxhighlight lang="php"> $service = \Yii::app()->versionFetcherServiceLocator $service->addVersionFetcherType( 'myNewVersionFetcherType', funkcja (\SimpleXMLElement $updaterXml) { zwróć nowy MyNewVersionFetcher( $updaterXml); } ); </syntaxhighlight> Oczywiście klasa <code>MyNewVersionFetcher</code> musi być podklasą <code>VersionFetcher</code> . Aby użyć modułu pobierania nowej wersji, skonfiguruj znacznik <code>type</code> w pliku XML aktualizatora tak, aby używał <code>myNewVersionFetcherType</code> (zamiast np. <code>rest</code> ). <span id="Adding_new_extension_updaters"></span> ==== Dodawanie nowych aktualizacji rozszerzeń ==== Aby dodać nowy, niestandardowy aktualizator rozszerzeń, uruchom to podczas inicjalizacji Yii: <syntaxhighlight lang="php"> $service = \Yii::app()->extensionUpdaterServiceLocator; $service->addUpdaterType( 'myNewExtensionUpdater', funkcja () { return MyNewExtensionUpdater::createUpdaters() ; } ); </syntaxhighlight> Klasa <code>MyNewExtensionUpdater</code> musi być podklasą <code>ExtensionUpdater</code> . Znacznik najwyższego <code>type</code> w pliku config.xml („wtyczka”, „motyw”, ...) będzie kontrolował, który aktualizator rozszerzenia będzie używany dla tego rozszerzenia. System nie jest jeszcze w pełni konfigurowalny, ponieważ trzeba także dodać niestandardowy ExtensionInstaller, elementy menu itp. Jednak teoretycznie i być może w przyszłości powinno być możliwe dodanie w ten sposób nowego typu rozszerzenia. <span id="Extension_installer"></span> == Instalator rozszerzenia == Biblioteka instalatora rozszerzeń składa się z dwóch klas abstrakcyjnych: * ExtensionInstaller * FileFetcher ExtensionInstaller jest podklasą dla każdego typu rozszerzenia, takiego jak PluginInstaller, questionThemeInstaller itp. FileFetcher jest podklasą dla każdego innego sposobu pobierania plików. Obecnie obsługiwane są tylko przesłane pliki ZIP, ale w przyszłości może pojawić się także moduł pobierania Github lub LimeStore. [[File: extensioninstalleruml.png]] <span id="Special_plugins"></span> == Specjalne wtyczki == * [[Rozwój wtyczki uwierzytelniającej]] * [[Rozwój wtyczki eksportowej]] <div class="mw-translate-fuzzy"> == Dostępne wtyczki == * [[Wtyczki uwierzytelniające]] * [[Dziennik audytu]] * [[CintLink]] * [[Dostępne wtyczki innych firm]] </div> == Samouczek == [https://medium.com/@evently/creating-limesurvey-plugins-adcdf8d7e334 Ten] samouczek krok po kroku pokazuje, jak utworzyć wtyczkę, która wysyła żądanie opublikowania każdej odpowiedzi w ankiecie przedłożona praca. W tym samouczku dowiesz się, jak tworzyć i zapisywać ustawienia globalne i dotyczące poszczególnych ankiet, jak rejestrować zdarzenia i nie tylko. [[Kategoria:Rozwój]] [[Kategoria:Wtyczki]]