SoSciSurvey - en:create:functions

accessCount()

Anonymous (anonymous@undisclosed.example.com) — 2025-05-15T06:22:39+00:00

accessCount() The accessCount() function is used to limit incorrect entries in a code query. Without a parameter, the function returns the number of previous attempts. If the parameter ban time is specified, the counter is incremented by one. int accessCount

SoSci Survey PHP Sandbox Context

Anonymous (anonymous@undisclosed.example.com) — 2025-12-08T20:49:32+00:00

SoSci Survey PHP Sandbox Context CRITICAL: Environment Constraints You are writing PHP code for “SoSci Survey”. This is a restricted sandbox environment. * NO Standard Output: echo or print do NOT work as expected. Use html() to output text/

answers()

Anonymous (anonymous@undisclosed.example.com) — 2024-04-21T18:17:08+00:00

answers() The function answers() shows the participant's responses to an individual question. A print preview of the questionnaire can be created with the help of this function. void answers(string questionID, [array items, array options]) * questionID

answersOption()

Anonymous (anonymous@undisclosed.example.com) — 2018-07-24T18:44:06+00:00

answersOption() answersOption() allows for the modification of the presentation of questions by answers() and answersPrint(). void answersOption(string Option, mixed Setting) * Option The possible options are listed below. The possible values for Setting vary according to the respective option.

answersPrint()

Anonymous (anonymous@undisclosed.example.com) — 2022-03-09T09:28:18+00:00

answersPrint() A whole range of questions that are asked in the questionnaire can be displayed with the help of the answersPrint() function. This means the participant can be shown a print view of their own questionnaire. Use the option() function to define a section of the questionnaire (see example).

buttonCode()

Anonymous (anonymous@undisclosed.example.com) — 2020-08-25T09:24:35+00:00

buttonCode() string buttonCode(string buttonID) The HTML code which displays a Next or Back button is generated with buttonCode(). Normally, a Next button and (depending on the settings) also a Back button are displayed at the end of every questionnaire page. This function assists in repositioning these buttons.

buttonDataCode() and buttonDataGet()

Anonymous (anonymous@undisclosed.example.com) — 2024-04-09T14:23:11+00:00

buttonDataCode() and buttonDataGet() The two functions buttonDataCode() and buttonDataGet() allow buttons to be placed on a questionnaire page which repeat the current page and can trigger functions there. The buttonDataCode() function creates a button, stores data and returns the

buttonHide()

Anonymous (anonymous@undisclosed.example.com) — 2015-01-15T19:28:38+00:00

buttonHide() void buttonHide() The function buttonHide() stops the Next and/or Back button being automatically inserted at the end of the questionnaire page. This is useful, for example, if certain participants are not allowed to participate (Filters: Screen Out) or if the questionnaire should be suspended until the next survey date (see below).

buttonToPage()

Anonymous (anonymous@undisclosed.example.com) — 2025-01-16T21:16:56+00:00

buttonToPage() string buttonToPage(string page, [mixed annotation, mixed placeholder, mixed CSS-class]) With this function you can create buttons to navigate within the questionaire. The function returns the HTML-code of the button and saves it (optinal) in a placeholder, e.g. to use it in the

calcMean(), calcSD(), ...

Anonymous (anonymous@undisclosed.example.com) — 2019-10-16T18:06:51+00:00

calcMean(), calcSD(), ... These functions perform simple statistical calculations within the questionnaire, they all follow the same syntax: calcXYZ(array Data, [boolean Filter]) * Data An array of numeric values. The values false and null are ignored in the calculation. Numbers that are stored as strings are converted to numbers.

caseData()

Anonymous (anonymous@undisclosed.example.com) — 2021-10-15T20:43:40+00:00

caseData() array caseData() array caseData(array Filter, [boolean EmptyValues]) array caseData(string Filter, [boolean EmptyValues]) The function caseData() returns all answer codes and text inputs from the current interview or a part of it. *

caseNumber()

Anonymous (anonymous@undisclosed.example.com) — 2015-01-24T14:23:16+00:00

caseNumber() int caseNumber() Each questionnaire in the survey project has a unique number, which also appears as the variable CASE in the data record (Addition Variables in the Data Set). This number can be called up with the function caseNumber(). Example 1 The participant should maybe note down the number of their questionnaire so they can request an individual analysis later on.

caseSerial()

Anonymous (anonymous@undisclosed.example.com) — 2024-04-21T18:18:30+00:00

caseSerial() string caseSerial() The function caseSerial() returns the value saved in the data record in the variable SERIAL. This is useful, for example, if you would like to show the respondent a personalized link to another questionnaire. * If the participant was invited via

caseTime()

Anonymous (anonymous@undisclosed.example.com) — 2020-08-25T09:42:35+00:00

caseTime() int caseTime(string pageID) Determines the amount of time spent on a particular page, or the time the participant has spent on the questionnaire so far. The time for each one is determined in seconds. * pageID ID of the page for which the amount of time spent on it should be determined (), or one of the following special IDs:

caseToken()

Anonymous (anonymous@undisclosed.example.com) — 2026-03-30T12:45:41+00:00

caseToken() string caseToken() Each questionnaire has an internal ID (token), which enables it to be identified during the course of the survey. The ID also appears after „Next“ has been clicked on for the first time in the browser's address bar (e.g.

convertDateTime()

Anonymous (anonymous@undisclosed.example.com) — 2020-08-25T09:47:02+00:00

convertDateTime() mixed convertDateTime(mixed dateTime, [string formatDateTime], [string formatOutput]) The function convertDateTime() converts a date or a timestamp into a different date or timestamp. * dateTime A Unix timestamp (e.g. 1418045461

dbDelete()

Anonymous (anonymous@undisclosed.example.com) — 2025-05-15T06:15:22+00:00

dbDelete() The dbDelete() function deletes all entries that match the specified prefix. void dbDelete(string prefix) Warning: Use this function with great care if you are collecting user data in the Database for Contents. The deletion cannot be undone. Note: The database entries are deleted regardless of the language version and regardless of whether they were imported or created using

dbGet()

Anonymous (anonymous@undisclosed.example.com) — 2025-01-29T12:29:36+00:00

dbGet() dbGet() can be used to retrieve data from the content database. For details and examples, see Using data fragments in PHP code and dbSet(). array|false dbGet(string key) * key The database key for which data has been stored. Important: dbGet() can only retrieve data that has been imported as a table or entered into the content database using

dbKeys()

Anonymous (anonymous@undisclosed.example.com) — 2025-01-29T12:38:26+00:00

dbKeys() The function dbKeys() lists all keys stored in the Database for Contents. If a subKey is specified, the function returns all keys beginning with this subkey (prefix) and are stored with the current interview language or with the base language of the survey project.

dbLoad()

Anonymous (anonymous@undisclosed.example.com) — 2025-01-29T07:40:09+00:00

dbLoad() The function dbLoad() retrieves from the Database for Contents all entries with the specified prefix and returns them as a two-dimensional array. The entries can be sorted according to their content optionally. array[] dbData(string Prefix, [int Column1], [int

dbRetrieve()

Anonymous (anonymous@undisclosed.example.com) — 2025-05-15T06:19:15+00:00

dbRetrieve() The dbRetrieve() function reads a data object from the Database for Contents, which was stored there using dbStore(). mixed dbRetrieve(string key) * key The database key to be created, updated or deleted. The key must be between 2 and 63 characters long. Special characters (e.g., ä ö ü) may require more than one character.

dbSet()

Anonymous (anonymous@undisclosed.example.com) — 2022-03-09T10:02:44+00:00

dbSet() Data can be written into the Database for Contents during the survey with dbSet(). If an entry already exists with the same key, it will be updated -- otherwise, a new entry will be created. An entry can also be deleted from the database with this function.

dbStore()

Anonymous (anonymous@undisclosed.example.com) — 2025-05-15T06:21:22+00:00

dbStore() The dbStore() function stores a data object in the Database for Contents. void dbStore(string key, mixed data object) * key The database key to be created, updated or deleted. The key must be between 2 and 63 characters long. Special characters (e.g., ä ö ü) may require more than one character.

dbTouch()

Anonymous (anonymous@undisclosed.example.com) — 2015-01-24T13:46:07+00:00

dbTouch() Each entry in the Database for Contents has a timestamp with the date and time of the most recent change. This timestamp is updated with dbTouch(), without the saved contents being changed. void dbTouch(string key) This function can be used, for example, in combination with an

debug()

Anonymous (anonymous@undisclosed.example.com) — 2020-08-25T10:13:55+00:00

debug() void debug(mixed object) The function debug() conveniently shows the project manager the content of a PHP or data variable or a placeholder in debug mode. * object * The ID of a data variable or a placeholder, or * A PHP variable (

diagram()

Anonymous (anonymous@undisclosed.example.com) — 2021-05-26T14:13:26+00:00

diagram() string diagram(string Typ, string Variable, [string options]) The function diagram() evaluates all data collected so far and displays a diagram directly in the questionnaire. The function returns HTML code which can be displayed e.g. using

diagram2()

Anonymous (anonymous@undisclosed.example.com) — 2020-01-19T15:11:32+00:00

diagram2() string diagram2(string Type, array Data, [array Options]) With the function diagram2() data can be visualized which have been calculated before in the questionnaire -- e.g. from the user's data via value() or via statistic(). Currently this function can only display a polarity profile.

dropCase()

Anonymous (anonymous@undisclosed.example.com) — 2021-05-26T14:18:55+00:00

dropCase() void dropCase() The function dropCase() marks the current interview or the corresponding case in the data set to be deleted. If the function is called up in the questionnaire, the Next button is hidden so that the respondent is unable to enter any more data. After a few minutes to a few hours, the case is then deleted from the data set.

dropHistory()

Anonymous (anonymous@undisclosed.example.com) — 2021-05-26T14:22:00+00:00

dropHistory() void dropHistory() During an interview, the sequence of pages is stored in the background, along with additional information that allows navigating back through the questionnaire. For very long questionnaires and when using setPageOrder() and loopToPage() the maximum memory capacity can be exceeded in some cases. This is noticeable by an error message with termination of the interview.

dropValue()

Anonymous (anonymous@undisclosed.example.com) — 2021-05-19T18:58:12+00:00

dropValue() voiddropValue(String variableID) The function dropValue() deletes the current value of a variable with the specified variableID. * variableID The variable identification as specified in the variables overview. Caveat: A value deleted by means of

getAnswerMissing()

Anonymous (anonymous@undisclosed.example.com) — 2015-01-24T12:12:56+00:00

getAnswerMissing() boolean getAnswerMissing() The function getAnswerMissing() can be used to determine whether a page is repeatedly displayed because a response was missing, or because the specified format was not adhered to. This function can be used, for example, to display additional information.

getItems()

Anonymous (anonymous@undisclosed.example.com) — 2022-06-01T17:47:29+00:00

getItems() array getItems(string question ID, string comparison, [int answer code]) With the help of the function getItems(), you can determine which items in a question are available, or which items have been checked off. The function returns an array of question IDs, e.g. (1,2,4,5,6,9,10). These IDs can be added directly to another question by using the command

getItemtext()

Anonymous (anonymous@undisclosed.example.com) — 2020-08-26T20:14:13+00:00

getItemtext() string getItemtext(string questionID, int item) string getItemtext(string ItemID) An item's or option's label can be determined with this function -- e.g. to use the text in another question or to display in the print view for the participant. The function can also determine the text in the question.

getLanguage()

Anonymous (anonymous@undisclosed.example.com) — 2015-01-24T12:41:46+00:00

getLanguage() string getLanguage() Determines which language the questionnaire is currently shown in. This function is particularly helpful if the participant is able to choose from different language versions at the beginning of the survey (Multilingual Surveys). The function returns the three letter language code as specified in

getQRCodeImage()

Anonymous (anonymous@undisclosed.example.com) — 2020-11-26T19:33:33+00:00

getQRCodeImage() string getQRCodeImage(string content, [int width]) Creates a QR Code with the given content and returns the HTML code for a tag with this QR Code. * content The text to be encoded in the QR Code, e.g. an internet address *

getQuestions()

Anonymous (anonymous@undisclosed.example.com) — 2015-01-24T14:48:09+00:00

getQuestions() array getQuestions(string sectionID) The function getQuestions() returns a list of all question IDs in a particular section. * sectionID The two-figure ID of a section Return Value The function returns an array with complete questions IDs as e.g.

getRoute()

Anonymous (anonymous@undisclosed.example.com) — 2016-07-28T12:14:23+00:00

getRoute() string getRoute() By using getRoute(), how the participant came to be on the current page in the questionnaire can be determined. Possible return values are: * 'start' -- The questionnaire has just begun. This is the first page the participant is presented with (and also shown for the first time).

getTextElement()

Anonymous (anonymous@undisclosed.example.com) — 2020-09-26T11:50:38+00:00

getTextElement() string getTextElement(string textID, [string output format]) Returns the HTML code for the text element with the ID textID as a string. * textID ID of the text element whose content is to be returned. Note: If the text element is output in the questionnaire with a title and/or formatting, this is also included in the

getValueText()

Anonymous (anonymous@undisclosed.example.com) — 2021-04-30T07:46:29+00:00

getValueText() string getValueText(string variable, int answercode, [string format])) The function getValueText() returns the verbal response (label) to an answer code. For a selection question, this is the text of the corresponding selection option (also determined with

getVariables()

Anonymous (anonymous@undisclosed.example.com) — 2021-11-29T08:06:57+00:00

getVariables() array getVariables() array getVariables(string Filter) array getVariables(array Filter) The function getVariables() returns a list of variable names matching the filter $filter. If no filter is specified, the function returns a list of all variables in the question catalogue.

goToPage()

Anonymous (anonymous@undisclosed.example.com) — 2017-06-27T06:45:51+00:00

goToPage() void goToPage(string pageID) This function jumps directly to another page in the questionnaire (without executing other commands on the current page) and shows the questions there. If questions or text have already been output on the current page, the content of the other page is directly attached. Therefore, in some cases, the contents of multiple questionnaire pages are output on one page with

goToParent()

Anonymous (anonymous@undisclosed.example.com) — 2020-08-25T09:03:13+00:00

goToParent() The function goToParent() redirects the respondent back to the questionnaire (and record) from which he was redirected to the current questionnaire using goToQuestionnaire(). void|string goToParent([string Mode], [mixed Data]) The function either redirects the respondent directly to the parent questionnaire or (if

goToQuestionnaire()

Anonymous (anonymous@undisclosed.example.com) — 2023-09-05T21:34:54+00:00

goToQuestionnaire() By calling goToQuestionnaire() the participant is redirected directly to another questionnaire in the same survey project. Thereby an additional record is created, which carries the number (CASE) of the original record as reference (REF).

html()

Anonymous (anonymous@undisclosed.example.com) — 2022-03-09T14:48:37+00:00

html() void html(string text) Outputs HTML code in the questionnaire. This means text can be output or images can be embedded. However, it is more sensible to use HTML for designing layouts (Placing Elements Side by Side). * text The HTML code which shall be displayed. Example

id()

Anonymous (anonymous@undisclosed.example.com) — 2019-02-18T10:15:39+00:00

id() string id(string category, integer question) string id(string category, integer question, integer Item) string id(string question identifier, integer Item) The function id() is generating a formally correct question- or item identifier out of single statements about the category, question and (optional) item. This question- or item identifier can be used e.g. in

imagepng_embed()

Anonymous (anonymous@undisclosed.example.com) — 2014-12-12T09:08:07+00:00

imagepng_embed() void imagepng_embed(resource image) PHP has a range of image functions available to create or edit graphics dynamically. Custom diagrams can be created in this way. The problem when using images is that they must be saved in a separate file before they can be displayed in the questionnaire

info()

Anonymous (anonymous@undisclosed.example.com) — 2026-02-02T19:33:23+00:00

info() The function info() returns meta-information about the current interview or illustration. mixed info(string Attribut) Depending on the parameter Attribut, the function returns the following data or information. * Date and time * 'time'

library()

Anonymous (anonymous@undisclosed.example.com) — 2023-08-30T20:15:11+00:00

library() void library(string id) The function library() embeds the JavaScript- or (if defined on the Server) PHP-Library including the defined identifier id in the questionnaire-site and makes it available for scripts. * id identifier of the embedded library

listFails()

Anonymous (anonymous@undisclosed.example.com) — 2015-01-24T12:20:17+00:00

listFails() array listFails() The function listFails() reveals which variables are responsible for the page having to be revisited. The function returns an array with the respective variable IDs. Note: Some reasons for the page being redisplayed are not able to displayed as variable IDs, e.g. if fewer options than requested were selected in a multiple choice selection, or if the page is repeated due to a separate filter.

loopPage()

Anonymous (anonymous@undisclosed.example.com) — 2023-09-05T21:00:49+00:00

loopPage() int loopPage(int startValue, int endValue, [int Increment]) int loopPage(int Repetitions) mixed loopPage(array Elements) Repeats the page -- starting with the startValue -- in a loop until the endValue is reached. The current value is returned in each case.

loopToPage()

Anonymous (anonymous@undisclosed.example.com) — 2018-12-29T15:53:35+00:00

loopToPage() int loopToPage(string pageID, int repititions) The function loopToPage() is used to show the pages of the current page with the ID pageID multiple times, as often as the number of repititions are set. This function specifies how often the pages have been repeated. In the first round = 0, second round = 1 etc.

mailResume()

Anonymous (anonymous@undisclosed.example.com) — 2024-04-21T18:27:02+00:00

mailResume() void mailResume(string personID, int mailing, int time, [string C1, string C2, string C3, string C4, string C5]) This function sends an email during the current questionnaire with a link in order to resume the questionnaire at a later point in time. This is particularly useful when combined with a specific break in multi-wave surveys (

mailRevoke()

Anonymous (anonymous@undisclosed.example.com) — 2020-08-29T08:49:39+00:00

mailRevoke() void mailRevoke([string personID], [int mailing]) By using the function mailRevoke(), all continuation emails in the current interview prepared using mailResume() are deleted, as well as selective mailings prepared using mailSchedule(). * personID The personal ID of the addressee who should receive the email. If the participant began the questionnaire after receiving an invitation via mailing, you can fill in

mailSchedule()

Anonymous (anonymous@undisclosed.example.com) — 2024-12-15T14:53:20+00:00

mailSchedule() void mailSchedule(string personID, int mailing, int time, [array settings]) This function prepares the sending of a mailing directly in the questionnaire -- for example, the invitation to the second questionnaire. In contrast to mailResume(), the current interview will not be resumed. Instead, the mailing is sent in the same way as if it had been prepared manually.

mailSend()

Anonymous (anonymous@undisclosed.example.com) — 2025-02-12T13:38:40+00:00

mailSend() void mailSend(string email, int mailingID, [int time], [string link], [string C1, string C2, string C3, string C4, string C5]) void mailSend(string email, int serialmailID, array settings) The mailSend() function sends the mailing with the

markFail()

Anonymous (anonymous@undisclosed.example.com) — 2021-06-28T16:05:04+00:00

markFail() void markFail(string variableID) The function markFail() is used in conjunction with a individual response check (Check Responses: Customized Response Check) and the function repeatPage(). This means an input field is highlighted in such a way so that the participant can recognize where information is not correct.

multiLevelData()

Anonymous (anonymous@undisclosed.example.com) — 2020-01-25T18:34:28+00:00

multiLevelData() mixed multiLevelData() The function multiLevelData() gives back the data of the subordinated questionnaire, which were marked as second parameters in multiLevelDown(). Details to the Multi-Level-Function are found here: Multi-Level-Design.

multiLevelDown()

Anonymous (anonymous@undisclosed.example.com) — 2023-09-05T21:07:57+00:00

multiLevelDown() void multiLevelDown(string QuestionnaireIdentifier, [mixed Data]) The function multiLevelDown() starts the questionnaire with the identifier questionnaireID and passes any specified data to the child questionnaire. Note: The multiLevelDown()

multiLevelPrepare()

Anonymous (anonymous@undisclosed.example.com) — 2024-04-09T14:14:18+00:00

multiLevelPrepare() int multiLevelPrepare(string questionnaire, [array data]) The multiLevelPrepare() function creates a subordinate case in the data set (Multi-Level Structure). Variables in the new case can be pre-assigned. This function is particularly useful in conjunction with a

multiLevelResponse()

Anonymous (anonymous@undisclosed.example.com) — 2020-01-25T18:52:44+00:00

multiLevelResponse() mixed multiLevelResponse() The function multiLevelResponse() gives back data in the main questionnaire, which were named as parameters in multiLevelReturn() . Details to the Multi-Level-Funktion here: Multi-Level-Design.

multiLevelReturn()

Anonymous (anonymous@undisclosed.example.com) — 2020-01-25T18:58:53+00:00

multiLevelReturn() multiLevelReturn([mixed Daten]) Was the user forwarded from a main questionnaire to a subordinated questionnaire through multiLevelDown() he can return to the main questionnaire through multiLevelReturn() . There data can be transported optionally , which can be read in the main questionnaire through

multiLevelURL()

Anonymous (anonymous@undisclosed.example.com) — 2024-04-09T14:30:33+00:00

multiLevelURL() string multiLevelURL(string questionnaire, [mixed data, mixed Hash]) The function multiLevelURL() works like multiLevelDown(), but does not lead the respondents directly to the subordinate questionnaire (Multi-Level Structure), but generates a URL with which the questionnaire can be called up later. The function is particularly useful in connection with sending emails, e.g. using

option()

Anonymous (anonymous@undisclosed.example.com) — 2025-01-29T07:50:24+00:00

option() void option(string option, mixed setting) The appearance of a page in the questionnaire can be altered with option(). The command option() can be put on every page in the questionnaire where the appearance should be altered simply by using

pageCSS()

Anonymous (anonymous@undisclosed.example.com) — 2023-12-07T11:02:08+00:00

pageCSS() void pageCSS(string CSS) The command pageCSS() adds CSS instructions to the HTML of the questionnaire page, within a