NAME

Labyrinth::Plugin::Survey - YAPC Surveys plugin for the Labyrinth framework

DESCRIPTION

Provides all the core survey management functionality for YAPC Surveys.

PUBLIC INTERFACE METHODS

General Survey Methods

LoadSurvey

Load the current survey configuration.

AnalyseSurvey

Analyses the survey configuration, to determine the mandatory and optional fields to be applied when the survey is submitted.

CheckQuestion

Check the configuration of a specific survey question set.

CheckParam

Check the specific question parameter.

CreateID

Create a unique ID to be used when collating questions.

User Interface Methods

Login

Enable an automatic login, providing the keycode is correct.

Welcome

Provides the supporting data for the initial welcome page. This includes all the courses attributed to the current user, and all the talks held during the conference.

CheckOpenTimes

Check the configured start and end times, and set the appropriate template variables to enable or disable access to surveys and evaluations as appropriate.

Admin Interface Methods

Admin

Loads the data when presenting the survey management pages.

Internal Object Methods

Both the following methods are defined by configuration settings.

CourseFixes

Specific configuration to fix course or talk titles.

Use a list of key/value pairs in the configuration file:

title_fixes=<<LIST
Mishpselt=Misspelt
LIST

Note that for title_fixes, the values should be the full replacement string.

TutorFixes

Specific configuration to fix names used by tutors.

Two configurable lists used here. The first is a simple list, while the second uses a list of key/value pairs in the configuration file:

single_names=<<LIST
Barbie
LIST

tutor_fixes=<<LIST
Mishpselt=Misspelt
LIST

Note that for tutor_fixes, the values should be the full replacement string.

ConfigureFixes

Creates the internal hashes for fixes from loaded settings.

SEE ALSO

Labyrinth

http://yapc-surveys.org

BUGS, PATCHES & FIXES

There are no known bugs at the time of this release. However, if you spot a bug or are experiencing difficulties that are not explained within the POD documentation, please submit a bug report and/or patch via RT [1], or raise an issue or submit a pull request via GitHub [2]. Note that it helps immensely if you are able to pinpoint problems with examples, or supply a patch.

[1] http://rt.cpan.org/Public/Dist/Display.html?Name=Labyrinth-Plugin-Survey [2] http://github.com/barbie/labyrinth-plugin-survey

Fixes are dependent upon their severity and my availability. Should a fix not be forthcoming, please feel free to (politely) remind me.

AUTHOR

Barbie, <barbie@cpan.org> Miss Barbell Productions, http://www.missbarbell.co.uk/

COPYRIGHT

Copyright (C) 2006-2014 Barbie for Miss Barbell Productions
All Rights Reserved.

This distribution is free software; you can redistribute it and/or
modify it under the Artistic License 2.0.