Question signature - Revision history

C schmitz: Text replacement - " enclose="div"" to ""

2022-02-16T12:58:37Z

Text replacement - " enclose="div"" to ""

← Older revision		Revision as of 14:58, 16 February 2022
Line 15:		Line 15:
	An example of a signature is shown below:		An example of a signature is shown below:

	<syntaxhighlight lang="php~~" enclose="div~~">		<syntaxhighlight lang="php">

	protected static $signature = array(		protected static $signature = array(
Line 31:		Line 31:
	Note that you are free to use any format / data type you want. The GUID is derived using the following code:		Note that you are free to use any format / data type you want. The GUID is derived using the following code:

	<syntaxhighlight lang="php~~" enclose="div~~">		<syntaxhighlight lang="php">

	/**		/**

Ollehar at 12:54, 21 June 2021

2021-06-21T12:54:06Z

← Older revision		Revision as of 14:54, 21 June 2021
Line 1:		Line 1:
			TODO: Still used?

	==Question signature==		==Question signature==

Ollehar at 12:53, 21 June 2021

2021-06-21T12:53:54Z

← Older revision		Revision as of 14:53, 21 June 2021
Line 1:		Line 1:
			==Question signature==
	=Question signature=

	Since question types can no longer be uniquely identified by their object names, we have created a signature scheme.		Since question types can no longer be uniquely identified by their object names, we have created a signature scheme.

LimeAJ: added missing "by"

2017-06-29T17:29:25Z

added missing "by"

← Older revision		Revision as of 19:29, 29 June 2017
Line 2:		Line 2:
	=Question signature=		=Question signature=

	Since question types can no longer be uniquely identified their object names, we have created a signature scheme.		Since question types can no longer be uniquely identified by their object names, we have created a signature scheme.

	While in a single limesurvey instance question objects must be uniquely named, there might be different plugins defining the question objects with the same name.		While in a single limesurvey instance question objects must be uniquely named, there might be different plugins defining the question objects with the same name.

LimeAJ: /* Question signature */

2017-06-05T18:29:52Z

Question signature

← Older revision		Revision as of 20:29, 5 June 2017
Line 10:		Line 10:
	Each question object MUST therefore define a protected static $signature field. This field is used to derive the signature using a hashing approach.		Each question object MUST therefore define a protected static $signature field. This field is used to derive the signature using a hashing approach.

	It is the ~~developers~~ task to make this signature as unique as possible, yet, it MUST never change. If the signature of a question object changes it is recognized as a new question type, while this is not necessarily a problem, the fact that the old question type is no longer available is. Since LimeSurvey cannot find the old question type it will not be able to execute, import, or maybe even edit, surveys containing this now unknown question type.		It is the developer's task to make this signature as unique as possible, yet, it MUST never change. If the signature of a question object changes it is recognized as a new question type, while this is not necessarily a problem, the fact that the old question type is no longer available is. Since LimeSurvey cannot find the old question type it will not be able to execute, import, or maybe even edit, surveys containing this now unknown question type.

	An example of a signature is shown below:		An example of a signature is shown below:

C schmitz: Text replace - "Limesurvey" to "LimeSurvey"

2013-06-06T13:21:04Z

Text replace - "Limesurvey" to "LimeSurvey"

← Older revision		Revision as of 15:21, 6 June 2013
Line 10:		Line 10:
	Each question object MUST therefore define a protected static $signature field. This field is used to derive the signature using a hashing approach.		Each question object MUST therefore define a protected static $signature field. This field is used to derive the signature using a hashing approach.

	It is the developers task to make this signature as unique as possible, yet, it MUST never change. If the signature of a question object changes it is recognized as a new question type, while this is not necessarily a problem, the fact that the old question type is no longer available is. Since ~~Limesurvey~~ cannot find the old question type it will not be able to execute, import, or maybe even edit, surveys containing this now unknown question type.		It is the developers task to make this signature as unique as possible, yet, it MUST never change. If the signature of a question object changes it is recognized as a new question type, while this is not necessarily a problem, the fact that the old question type is no longer available is. Since LimeSurvey cannot find the old question type it will not be able to execute, import, or maybe even edit, surveys containing this now unknown question type.

	An example of a signature is shown below:		An example of a signature is shown below:

Sammousa at 22:25, 25 February 2013

2013-02-25T22:25:17Z

New page

=Question signature=

Since question types can no longer be uniquely identified their object names, we have created a signature scheme.

While in a single limesurvey instance question objects must be uniquely named, there might be different plugins defining the question objects with the same name.

To make sure we can identify what the type of a question is, we derive a unique identifier (GUID) from a signature.

Each question object MUST therefore define a protected static $signature field. This field is used to derive the signature using a hashing approach.

It is the developers task to make this signature as unique as possible, yet, it MUST never change. If the signature of a question object changes it is recognized as a new question type, while this is not necessarily a problem, the fact that the old question type is no longer available is. Since Limesurvey cannot find the old question type it will not be able to execute, import, or maybe even edit, surveys containing this now unknown question type.

An example of a signature is shown below:

<syntaxhighlight lang="php" enclose="div">

protected static $signature = array(

'orignalAuthor' => 'Sam Mousa',

'originalName' => 'Yes / No',

'startDev' => '2013-30-1'

);

</syntaxhighlight>

Note that you are free to use any format / data type you want. The GUID is derived using the following code:

<syntaxhighlight lang="php" enclose="div">

/**
* This function derives a unique identifier for identifying a question type.
*/

public static function getGUID()

{

// We use json_encode because it is faster than serialize.

return md5(json_encode(static::$signature));

}

</syntaxhighlight>