Class::Usul::Constants - Definitions of constant values
use Class::Usul::Constants qw( FALSE SEP TRUE ); my $bool = TRUE; my $slash = SEP;
Exports a list of subroutines each of which returns a constants value
Defines the following class attributes;
Assert
Config_Extn
Config_Key
Exception_Class
Log_Levels
These are accessor / mutators for class attributes of the same name. The constants with uppercase names return these values. At compile time they can be used to set values the are then constant at runtime
String ARRAY
ARRAY
Returns a hash reference containing the keys and values that causes the auto formatting output subroutine to clear left, fill paragraphs, and append an extra newline
Returns a list of arguments for get_line which causes it to prompt for a password
Return a code reference which is imported by Class::Usul::Functions into the callers namespace as the assert function. By default this will be the empty subroutine, sub {}. Change this by setting the Assert class attribute
assert
sub {}
Separate leader from message with the characters colon space
String CODE
CODE
The comma character
The default configuration file extension, .json. Change this by setting the Config_Extn class attribute
Default directory for the config file. The function find_apphome defaults to returning this value if it cannot find a more suitable one. Returns the temporary directory
find_apphome
String UTF-8
UTF-8
An array reference which if passed to catdir is the directory which will contain the applications installation information. Directory defaults to /etc/default
String default. The name of the default message catalogue
default
List of algorithms to try as args to Digest
List of supported IO encodings
The name of the class used to throw exceptions. Defaults to Class::Usul::Exception but can be changed by setting the Exception_Class class attribute
Non zero exit code indicating program failure
Digit 0
0
String HASH
HASH
Default language code, en
en
The left brace character, {
{
The character sequence that introduces a localisation substitution parameter, [_
[_
List of methods the log object is expected to support
The letter n
n
Empty (zero length) string
Returns good program exit code, zero
List of possible file suffixes used on Perl scripts
The default phase number used to select installation specific config, 2
Array reference representing the default parent path for a normal install. Defaults to /opt
The character q
The regular expression to match a quoted string. Lifted from Regexp::Common which now has installation and indexing issues
Slash / character
/
Space character
Digit 1
1
Default file creation mask, 027 octal, that's rw-r-----
rw-r-----
Digit -1. Indicates that a method wrapped in a try/catch block failed to return a defined value
-1
Regular expression used to untaint command line strings
Regular expression used to untaint identifier strings
Regular expression used to untaint path strings
Default configuration hash key, Plugin::Usul. Change this by setting the Config_Key class attribute
Plugin::Usul
An array reference which if passed to catdir is the path which will return a unique identifier if opened and read
Default terminal screen width in characters
The character y
None
There are no known incompatibilities in this module
There are no known bugs in this module. Please report problems to the address below. Patches are welcome
Peter Flanigan, <pjfl@cpan.org>
<pjfl@cpan.org>
Copyright (c) 2018 Peter Flanigan. All rights reserved
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic
This program is distributed in the hope that it will be useful, but WITHOUT WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
To install Class::Usul, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Class::Usul
CPAN shell
perl -MCPAN -e shell install Class::Usul
For more information on module installation, please visit the detailed CPAN module installation guide.