View on
MetaCPAN
search.cpan.org is shutting down
For details read Perl NOC. After June 25th this page will redirect to MetaCPAN.org
Vick Khera > RWDE-483 > RWDE::CCR

Download:
RWDE-483.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Source   Latest Release: RWDE-510

append_ccr($integer[,$context])

Append the check-character to the integer and return the result. Verify by calling the verify_ccr() method. Zero-pads the integer to a five character minimum length string.

The $context parameter acts as a salt to change the code based on context such as owner ID, user ID, etc.

verify_ccr($string[,$context])

Compares the check-character (last character) of $string to a new one computed against the remaining digits. Returns $string without CCR if they match or undef if not. $string should be of the form \d+[A-Z] and $context is as above.

_compute_ccr($string[,$context])

Internal routine to do the math to compute the Character Checksum characteR (ccr) code for a string.

Basically multiplies the ordinal value of each character of the string by an exponential weight based on its position in the string, and keeps the sum of these modulo 26. Returns the letter corresponding to that value.

The intent of this encoding as opposed to the encode() methods above is to provide a check to prevent typos and quick hack attempts on simple email messages involving the user/owner ID values.

The $context parameter acts as a salt to change the code based on context such as owner ID, user ID, etc.

ccr_to_id($string)

Convert the string to an id number. Returns undef on failure.

get_ccr()

Returns the encoded value of the derived objects id

encode($string)

Returns the value with CCR appended and a hash both based on $ccrcontext appended to that. Useful for passing information from form to form via hidden fields that need to be secured from tampering. The string may not contain a dash (-) or comma character.

This produces a shorter encoded result without funny characters in it that may cause the longer form to break, so is useful for creating links that people may need to cut-and-paste.

get_enc()

Returns the encoded value of the derived objects id

decode($encodedString)

Return the value decoded from the return value of the encode method. Throws 'undef' exception if fails.

syntax highlighting: