CGI::Listman::dictionary::term - element of a CGI::Listman::dictionary
use CGI::Listman::dictionary::term;
A CGI::Listman::dictionary::term is what an instance of CGI::Listman::dictionary is made of. In our terminology, a "term" is made of a "key" and a "definition". The similarity with the words in a lingual dictionary is not innocent.
Within a CGI script, you are most certainly receiving and transmitting variables to a form. A couple of those variables will be of internal use only while the others will be part of the interactivity with your users. Generally, those variables will have names that are explicit to you as a programmer; however they might mean nothing or little to a normal user.
Now, in the context of CGI::Listman, those variables are juste fields of a database row and it makes even less sense to give them a user-explicit name (imagine a name such as "Your father's forename"). So the key of a CGI::Listman::dictionary::line will represent a database column and the definition will be its user representation. This is mostly useful when you have to represent those variables in the sight of your users; for example when validating user input (see CGI::Listman's method check_params).
A CGI::Listman::dictionary::term also contains validation information. Currently it only supports a flag indicating whether the field is mandatory or not but it will probably contain other flags in a later release.
This method is to instantiate a term. It optionnally takes arguments for the term's key, definition and mandatory flag. All the parameters are optional with this method.
A string representing the term's key.
A string representing the term's definition.
A boolean (0 or 1) integer defining whether user input is required or not for this term.
This method returns a blessed reference to a CGI::Listman::dictionary::term.
This method set the term's key to the provided value.
This method returns nothing.
This method set the term's definition to the provided value.
This method declares that user input is required for this term.
This method take no parameter.
This method returns the definition for the specified instance of CGI::Listman::dictionary::term.
This method returns a string representing either the term's definition.
This method returns the definition for the specified instance of CGI::Listman::dictionary::term. If the definition is not existing, the key is returned instead.
This method returns a string representing either the term's definition or its key whenever its definition is void.
Wolfgang Sourdeau, <Wolfgang@Contre.COM>
Copyright (C) 2002 iScream multimédia <info@iScream.ca>
This package is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
CGI::Listman(3) CGI::Listman::dictionary(3)
1 POD Error
The following errors were encountered while parsing the POD:
Non-ASCII character seen before =encoding in 'multimédia'. Assuming CP1252
To install CGI::Listman, copy and paste the appropriate command in to your terminal.
cpanm
cpanm CGI::Listman
CPAN shell
perl -MCPAN -e shell install CGI::Listman
For more information on module installation, please visit the detailed CPAN module installation guide.