Class: Net_IDNA_php5

Source Location: /Net_IDNA-0.7.0/IDNA/php5.php

Class Overview

Encode/decode Internationalized Domain Names.

Author(s):

Matthias Sommerfeld <mso at phlylabs.de>
Markus Nix <mnix at docuverse.de>

Version:

$Id: IDNA.php,v 0.4.1 2005/08/07 18:35 phlylabs_de Exp $

Inherited Variables

Inherited Methods

Class Details

[line 57]
Encode/decode Internationalized Domain Names.

The class allows to convert internationalized domain names (see RFC 3490 for details) as they can be used with various registries worldwide to be translated between their original (localized) form and their encoded form as it will be used in the DNS (Domain Name System).

The class provides two public methods, encode() and decode(), which do exactly what you would expect them to do. You are allowed to use complete domain names, simple strings and complete email addresses as well. That means, that you might use any of the following notations:

xn--nrgler-wxa
xn--brse-5qa.xn--knrz-1ra.info

Unicode input might be given as either UTF-8 string, UCS-4 string or UCS-4 array. Unicode output is available in the same formats. You can select your preferred format via set_paramter().

ACE input and output is always expected to be ASCII.

Author: Matthias Sommerfeld <mso@phlylabs.de>
Author: Markus Nix <mnix@docuverse.de>
Version: $Id: IDNA.php,v 0.4.1 2005/08/07 18:35 phlylabs_de Exp $

[ Top ]

Class Variables

$_error = false

[line 2201]

In case of error (not caught by Exception handling), the error message can be found here

Access: public

Type:

string

[ Top ]

Method Detail

__construct (Constructor) [line 2213]

Net_IDNA_php5 __construct(
[array
$options = null])

Constructor

See: Net_IDNA_php5::setParams()
Access: public

Parameters:

array $options —

[ Top ]

decode [line 2376]

string decode(

$input, [
$one_time_encoding = false], string
$encoded)

Decode a given ACE domain name.

Return: Decoded Domain name (UTF-8 or UCS-4)
Throws: Exception
Access: public

Parameters:

string	`$encoded`	—	Domain name (ACE string) [@param string $encoding Desired output encoding, see set_parameter]
	`$input`	—
	`$one_time_encoding`	—

[ Top ]

encode [line 2288]

string encode(
string
$decoded, [
$one_time_encoding = false])

Encode a given UTF-8 domain name.

Return: Encoded Domain name (ACE string)
Throws: Exception
Access: public

Parameters:

string	`$decoded`	—	Domain name (UTF-8 or UCS-4) [@param string $encoding Desired input encoding, see set_parameter]
	`$one_time_encoding`	—

[ Top ]

setParams [line 2240]

boolean setParams(
mixed
$option, [string
$value = false])

Sets a new option value. Available options and values:

[encoding - Use either UTF-8, UCS4 as array or UCS4 as string as input ('utf8' for UTF-8, 'ucs4_string' and 'ucs4_array' respectively for UCS4); The output is always UTF-8] [overlong - Unicode does not allow unnecessarily long encodings of chars, to allow this, set this parameter to true, else to false; default is false.] [strict - true: strict mode, good for registration purposes - Causes errors on failures; false: loose mode, ideal for "wildlife" applications by silently ignoring errors and returning the original input instead

Return: true on success, false otherwise
Access: public

Parameters:

mixed	`$option`	—	Parameter to set (string: single parameter; array of Parameter => Value pairs)
string	`$value`	—	Value to use (if parameter 1 is a string)

[ Top ]