Docs For Class I18N_Punycode

Description

Class for encoding/decoding on international domainnames using Punycode; ASCII-mode

!! Please note that Punycode is meant to be used with Unicode-strings. This ASCII-class is just provided for convenience if you can be sure you just need to encode strings with usual ASCII-characters. If possible (e.g. supported by your webserver) it's highly recommended that you use I18N_Punycode_Unicode. !!

see: I18N_Punycode_Unicode
access: public
author: Stefan Neufeind <pear.neufeind@speedpartner.de>

Located in /Punycode.php (line 55)

Direct descendents

Class	Description
I18N_Punycode_Unicode	Class for encoding/decoding on international domainnames using Punycode; Unicode-mode

Method Summary

string decode (string $domainname)

string encode (string $domainname)

mixed &factory ()

Methods

decode (line 427)

Decode the given string/domainname from Punycode

!! Please note that this class does not use full punycode encoding. This is caused by using only a limited set of characters that can be represented using ASCII. If possible on your system we strongly suggest to use I18N_Punycode_Unicode instead. !!

return: Decoded form of the given string/name
see: I18N_Punycode_Unicode
access: public

string decode (string $domainname)

string $domainname: String/name to be decoded

Redefined in descendants as:

I18N_Punycode_Unicode::decode() : Decode the given string/domainname from Punycode

encode (line 401)

Encode the given string/domainname using Punycode

As a first step "nameprep" is applied to the input-string. Then all non-basic code-points using the Punycode-algorithm. !! Please note that this class does not use full nameprep/punycode encoding. This is caused by using only a limited set of characters that can be represented using ASCII. If possible on your system we strongly suggest to use I18N_Punycode_Unicode instead. !!

return: Encoded form of the given string/name
see: I18N_Punycode_Unicode
access: public

string encode (string $domainname)

string $domainname: String/name to be encoded

Redefined in descendants as:

I18N_Punycode_Unicode::encode() : Encode the given string/domainname using Punycode

factory (line 96)

Create a new I18N_Punycode_ASCII object

This function exists because the Unicode-version of this class (I18N_Punycode_Unicode) can interface with various unicode-extensions and needs to be able to return error-objects when a new object is created.

return: newly created I18N_Punycode_ASCII object, or a I18N_Punycode error code
access: public

mixed &factory ()

Redefined in descendants as:

I18N_Punycode_Unicode::factory() : Create a new I18N_Punycode_Unicode object