GetValidScreenFiles: Difference between revisions
From LimeSurvey Manual
DenisChenu (talk | contribs) Page create |
DenisChenu (talk | contribs) mNo edit summary |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{FeatureStarting|3.13.0}} | {{FeatureStarting|3.13.0}} | ||
{{Alert|This event is broken since LimeSurvey 5.5.}} | |||
== Usage == | == Usage == | ||
| Line 5: | Line 7: | ||
This event allow plugin to add twig file inside the template edito | This event allow plugin to add twig file inside the template edito | ||
== Input == | |||
* type : the file type : view (twig) , css or js | * type : the file type : view (twig) , css or js | ||
* screen : the screen currently edited (null mean all screen) | * screen : the screen currently edited (null mean all screen, when save : screen is not set) | ||
== Possible output == | |||
* remove : array of file to be removed | * remove : array of file to be removed | ||
* add : array of file to be removed | * add : array of file to be removed | ||
== Sample == | |||
<syntaxhighlight lang="php"> | <syntaxhighlight lang="php"> | ||
public function getPluginTwigPath() | public function getPluginTwigPath() | ||
{ | { | ||
if ($this->getEvent()->get("screen") | if( | ||
$this->getEvent()->get("type")!='view' || | |||
($this->getEvent()->get("screen") && $this->getEvent()->get("screen")!="register") | |||
){ | |||
return; | |||
} | |||
if($this->getEvent()->get("screen")) { | |||
$this->getEvent()->append('remove', array("subviews/registration/register_form.twig")); | $this->getEvent()->append('remove', array("subviews/registration/register_form.twig")); | ||
} | } | ||
$this->getEvent()->append('add', array( | |||
"subviews/registration/registerquick_form.twig", | |||
"subviews/registration/registerquick_token_form.twig" | |||
)); | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
* [https://gitlab.com/SondagesPro/SurveyAccess/registerQuick registerQuick] with usage of replace and add | * [https://gitlab.com/SondagesPro/SurveyAccess/registerQuick registerQuick] with usage of replace and add | ||
[[Category:Plugins events]] | [[Category:Plugins events]] | ||
Latest revision as of 17:18, 4 July 2023
Hint: This features is available starting in version 3.13.0
This event is broken since LimeSurvey 5.5.
Usage
This event allow plugin to add twig file inside the template edito
Input
- type : the file type : view (twig) , css or js
- screen : the screen currently edited (null mean all screen, when save : screen is not set)
Possible output
- remove : array of file to be removed
- add : array of file to be removed
Sample
public function getPluginTwigPath()
{
if(
$this->getEvent()->get("type")!='view' ||
($this->getEvent()->get("screen") && $this->getEvent()->get("screen")!="register")
){
return;
}
if($this->getEvent()->get("screen")) {
$this->getEvent()->append('remove', array("subviews/registration/register_form.twig"));
}
$this->getEvent()->append('add', array(
"subviews/registration/registerquick_form.twig",
"subviews/registration/registerquick_token_form.twig"
));
}
- registerQuick with usage of replace and add