Hey::Common 0.01

Hey::Common is a Perl module with common functions used in other Hey::* modules.<br /><br />SYNOPSIS<br /><br /> use Hey::Common;<br /> my $common = Hey::Common->new;<br /> <br /> my $money = $common->formatMoney(524.4); # will return string "524.40"<br /><br />new<br /><br /> my $common = Hey::Common->new;<br /><br />This function provides access to all of these following methods.<br /><br />forceArray<br /><br /> $data->{users} = $common->forceArray($data->{users});<br /><br />The input can either be an array ref or non-array ref. The output will either be that same array ref, or the non-array ref as the only item in an array as a ref.<br /><br />This is useful for items that might or might not be an array ref, but you are expecting an array ref.<br /><br />randomCode<br /><br /> $someRandomCode = $common->randomCode($lengthOfCodeRequested, $keyStringOfPermittedCharacters);<br /><br /> $someRandomCode = $common->randomCode(); # defaults for length and key<br /> $someRandomCode = $common->randomCode(8); # choose a specific length, but default key<br /> $someRandomCode = $common->randomCode(12, 'abcdefg'); # choose a specific length and key<br /><br />$lengthOfCodeRequested defaults to 16.<br /><br />$keyStringOfPermittedCharacters defaults to 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'.<br /><br />deepCopy<br /><br /> my $newCopyOfSomeHashRef = $common->deepCopy($someHashRef);<br /><br />It makes a copy of a reference instead of making a reference to it. There's some usefulness there.<br /><br />isAffirmative<br /><br /> if ($common->isAffirmative('y')) {<br /> print "'y' is affirmative, so you'll see this.";<br /> }<br /> <br /> if ($common->isAffirmative('no')) {<br /> print "'no' is not affirmative, so you won't see this";<br /> }<br /><br />This checks to see if the value is affirmative.<br /><br />Things that are affirmative are: 'y', 'yes', 't', 'true', or any true numerical value.<br />isNegative<br /><br /> if ($common->isNegative('y')) {<br /> print "'y' is not negative, so you won't see this.";<br /> }<br /> <br /> if ($common->isNegative('no')) {<br /> print "'no' is negative, so you'll see this";<br /> }<br /><br />This checks to see if the value is negative.<br /><br />Things that are negative are: 'n', 'no', 'f', 'false', any false numerical value (zero), or undef/null.<br /><br />smtpClient<br /><br /> my @aListOfRecipientEmailAddresses = ('george@somewhere.com', 'ed@server.com', 'ralph@elsewhere.com');<br /><br /> my $contentOfEmailIncludingHeader = 'smtp.server.someplace.com',<br /> From => 'fred@someplace.com',<br /> To => @aListOfRecipientEmailAddresses,<br /> Content => $contentOfEmailIncludingHeader });<br /><br />'Host' is optional and defaults to 'localhost'. Of course, you would need to be able to send email through whatever host you specify.<br /><br />'From' is a single email address that is used as the envelope address.<br /><br />'To' can be a single email address or a list of email addresses as a scalar or an array ref.<br /><br />'Content' is the content of the email, with header and body included.<br /><br />formatMoney<br /><br /> my $money = 515.3;<br /> $money = $common->formatMoney($money);<br /><br />$money is the non-formatted money amount. It will be returned as a formatted string, but with no currency symbol.<br /><br />sha1<br /><br /> my $something = 'This is something that will be hashed.';<br /> my $sha1Hash = $common->sha1($something);<br /><br />$something is any value that you want hashed. It can be a binary value or a simple scalar.<br /><br />$sha1Hash is a simple sha1 hex of whatever you passed in.<br /><br />Requirements:<br /><br />?*A* Perl<br />

Requirements:	No special requirements
Platforms:	*nix, Linux
Keyword:	Address,  Affirmative,  Array,  Checks,  Choose,  Common,  Defaults,  Email,  Formatmoney,  Isaffirmative,  Isnegative,  Length,  Money,  Negative,  Print,  Quot,  Randomcode,  Reference,  Single,  Somerandomcode,  Specific,  Thisquot
Users rating:	0/10