From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

SKIM / Data-Message-Simple-0.05 / README 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

              
NAME
    Data::Message::Simple - Data object for simple message.
SYNOPSIS
     use Data::Message::Simple;
     my $obj = Data::Message::Simple->new(%params);
     my $lang = $obj->lang;
     my $text = $obj->text;
     my $type = $obj->type;
METHODS
  "new"
     my $obj = Data::Message::Simple->new(%params);
    Constructor.
    *       "lang"
            Message language. It's optional. If defined, possible values are
            ISO 639-1 language codes.
            Default value is undef.
    *       "text"
            Message text. Maximum length of text is 4096 characters. It's
            required.
    *       "type"
            Message type. Possible value are 'error' and 'info'. It's
            required. Default value is 'info'.
    Returns instance of object.
  "lang"
     my $lang = $obj->lang;
    Get ISO 639-1 language code of text.
    Returns string.
  "text"
     my $text = $obj->text;
    Get message text.
    Returns string.
  "type"
     my $type = $obj->type;
    Get message type.
    Returns string.
ERRORS
     new():
             From Mo::utils:
                     Parameter 'text' has length greater than '4096'.
                             Value: %s
                     Parameter 'text' is required.
                             Value: %s
                     Parameter 'type' must be one of defined strings.
                             String: %s
                             Possible strings: %s
             From Mo::utils::Language:
                     Parameter 'lang' doesn't contain valid ISO 639-1 code.
                             Codeset: %s
                             Value: %s
EXAMPLE
     use strict;
     use warnings;
     use Data::Message::Simple;
     my $obj = Data::Message::Simple->new(
             'lang' => 'en',
             'text' => 'This is text message.',
     );
     # Print out.
     print 'Message type: '.$obj->type."\n";
     print 'ISO 639-1 language code: '.$obj->lang."\n";
     print 'Text: '.$obj->text."\n";
     # Output:
     # Message type: info
     # ISO 639-1 language code: en
     # Text: This is text message.
DEPENDENCIES
    Mo, Mo::utils, Mo::utils::Language, Readonly.
REPOSITORY
    <https://github.com/michal-josef-spacek/Data-Message-Simple>
AUTHOR
    Michal Josef Špaček <mailto:skim@cpan.org>
    <http://skim.cz>
LICENSE AND COPYRIGHT
    © 2023-2025 Michal Josef Špaček
    BSD 2-Clause License
VERSION
    0.05