App::CELL::Message - handle messages the user might see
Version 0.164
use App::CELL::Message; # server messages: pass message code only, message text # will be localized to the site default language, if # assertainable, or, failing that, in English my $message = App::CELL::Message->new( code => 'FOOBAR' ) # and then we pass $message as an argument to # App::CELL::Status->new # client messages: pass message code and session id, # message text will be localized according to the user's language # preference setting my $message = App::CELL::Message->new( code => 'BARBAZ', session => $s_obj ); $msg_to_display = $message->App::CELL::Message->text; # a message may call for one or more arguments. If so, # include an 'args' hash element in the call to 'new': args => [ 'FOO', 'BAR' ] # they will be included in the message text via a call to # sprintf
This module provides the following public functions and methods:
new
App::CELL::Message
text
max_size
An App::CELL::Message object is a reference to a hash containing some or all of the following keys (attributes):
code
error
language
truncated
The information in the hash is sourced from two places: the $mesg hashref in this module (see "CONSTANTS") and the SQL database. The former is reserved for "system critical" messages, while the latter contains messages that users will come into contact with on a daily basis. System messages are English-only; only user messages are localizable.
$mesg
The App::CELL::Message module stores messages in a package variable, $mesg (which is a hashref).
Get reference to list of supported languages.
Determine if a given language is supported.
Construct a message object. Takes a message code and, optionally, a reference to an array of arguments. Returns a status object. If the status is ok, then the message object will be in the payload. See "SYNOPSIS".
Clones the message into another language. Returns a status object. On success, the new message object will be in the payload.
Generate a string representation of a message object using Data::Dumper.
Accessor method for the 'code' attribute.
Accessor method for the 'args' attribute.
Accessor method for the 'text' attribute. Returns content of 'text' attribute, or "<NO_TEXT>" if it can't find any content.
To install App::CELL, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::CELL
CPAN shell
perl -MCPAN -e shell install App::CELL
For more information on module installation, please visit the detailed CPAN module installation guide.