Validate/Hostname.php

category: Zend
copyright: Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Validate
version: $Id: Hostname.php 23972 2011-05-03 16:26:36Z ralph $
Classes: Zend_Validate_Hostname

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Validate_Hostname
jump to top

Extends from: Zend_Validate_Abstract
category: Zend
copyright: Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Validate
Constants: CANNOT_DECODE_PUNYCODE; INVALID; INVALID_DASH; INVALID_HOSTNAME; INVALID_HOSTNAME_SCHEMA; INVALID_LOCAL_NAME; INVALID_URI; IP_ADDRESS_NOT_ALLOWED; LOCAL_NAME_NOT_ALLOWED; UNDECIPHERABLE_TLD; UNKNOWN_TLD; ALLOW_DNS; ALLOW_IP; ALLOW_LOCAL; ALLOW_ALL; ALLOW_URI
Properties: $_messageTemplates; $_messageVariables; $_validTlds; $_tld; $_validIdns; $_idnLength; $_options
Methods: __construct; getOptions; setOptions; getIpValidator; setIpValidator; getAllow; setAllow; getValidateIdn; setValidateIdn; getValidateTld; setValidateTld; isValid; decodePunycode

Description

Please note there are two standalone test scripts for testing IDN characters due to problems with file encoding.

The first is tests/Zend/Validate/HostnameTestStandalone.php which is designed to be run on the command line.

The second is tests/Zend/Validate/HostnameTestForm.php which is designed to be run via HTML to allow users to test entering UTF-8 characters in a form.

Constants

CANNOT_DECODE_PUNYCODE
jump to class

 CANNOT_DECODE_PUNYCODE = 'hostnameCannotDecodePunycode'

Details

value: hostnameCannotDecodePunycode

INVALID
jump to class

 INVALID = 'hostnameInvalid'

Details

value: hostnameInvalid

INVALID_DASH
jump to class

 INVALID_DASH = 'hostnameDashCharacter'

Details

value: hostnameDashCharacter

INVALID_HOSTNAME
jump to class

 INVALID_HOSTNAME = 'hostnameInvalidHostname'

Details

value: hostnameInvalidHostname

INVALID_HOSTNAME_SCHEMA
jump to class

 INVALID_HOSTNAME_SCHEMA = 'hostnameInvalidHostnameSchema'

Details

value: hostnameInvalidHostnameSchema

INVALID_LOCAL_NAME
jump to class

 INVALID_LOCAL_NAME = 'hostnameInvalidLocalName'

Details

value: hostnameInvalidLocalName

INVALID_URI
jump to class

 INVALID_URI = 'hostnameInvalidUri'

Details

value: hostnameInvalidUri

IP_ADDRESS_NOT_ALLOWED
jump to class

 IP_ADDRESS_NOT_ALLOWED = 'hostnameIpAddressNotAllowed'

Details

value: hostnameIpAddressNotAllowed

LOCAL_NAME_NOT_ALLOWED
jump to class

 LOCAL_NAME_NOT_ALLOWED = 'hostnameLocalNameNotAllowed'

Details

value: hostnameLocalNameNotAllowed

UNDECIPHERABLE_TLD
jump to class

 UNDECIPHERABLE_TLD = 'hostnameUndecipherableTld'

Details

value: hostnameUndecipherableTld

UNKNOWN_TLD
jump to class

 UNKNOWN_TLD = 'hostnameUnknownTld'

Details

value: hostnameUnknownTld

ALLOW_DNS
jump to class

 ALLOW_DNS = '1'

Allows Internet domain names (e.g., example.com)

Details

value: 1

ALLOW_IP
jump to class

 ALLOW_IP = '2'

Allows IP addresses

Details

value: 2

ALLOW_LOCAL
jump to class

 ALLOW_LOCAL = '4'

Allows local network names (e.g., localhost, www.localdomain)

Details

value: 4

ALLOW_ALL
jump to class

 ALLOW_ALL = '7'

Allows all types of hostnames

Details

value: 7

ALLOW_URI
jump to class

 ALLOW_URI = '8'

Allows all types of hostnames

Details

value: 8

Properties

$_idnLength
jump to class

$_idnLength = 'array'

Details

visibility: protected
default: array
final: false
static: false

$_messageTemplates
jump to class

array $_messageTemplates = 'array'

Details

$_messageTemplates: array
visibility: protected
default: array
final: false
static: false

$_messageVariables
jump to class

array $_messageVariables = 'array'

Details

$_messageVariables: array
visibility: protected
default: array
final: false
static: false

$_options
jump to class

$_options = 'array'

Details

visibility: protected
default: array
final: false
static: false

$_tld
jump to class

string $_tld = ''

Details

$_tld: string
visibility: protected
default
final: false
static: false

$_validIdns
jump to class

array $_validIdns = 'array'

Array for valid Idns

Details

$_validIdns: array
visibility: protected
default: array
final: false
static: false
see: http://www.iana.org/domains/idn-tables/ Official list of supported IDN Chars (.AC) Ascension Island http://www.nic.ac/pdf/AC-IDN-Policy.pdf (.AR) Argentinia http://www.nic.ar/faqidn.html (.AS) American Samoa http://www.nic.as/idn/chars.cfm (.AT) Austria http://www.nic.at/en/service/technical_information/idn/charset_converter/ (.BIZ) International http://www.iana.org/domains/idn-tables/ (.BR) Brazil http://registro.br/faq/faq6.html (.BV) Bouvett Island http://www.norid.no/domeneregistrering/idn/idn_nyetegn.en.html (.CAT) Catalan http://www.iana.org/domains/idn-tables/tables/cat_ca_1.0.html (.CH) Switzerland https://nic.switch.ch/reg/ocView.action?res=EF6GW2JBPVTG67DLNIQXU234MN6SC33JNQQGI7L6#anhang1 (.CL) Chile http://www.iana.org/domains/idn-tables/tables/cl_latn_1.0.html (.COM) International http://www.verisign.com/information-services/naming-services/internationalized-domain-names/index.html (.DE) Germany http://www.denic.de/en/domains/idns/liste.html (.DK) Danmark http://www.dk-hostmaster.dk/index.php?id=151 (.ES) Spain https://www.nic.es/media/2008-05/1210147705287.pdf (.FI) Finland http://www.ficora.fi/en/index/palvelut/fiverkkotunnukset/aakkostenkaytto.html (.GR) Greece https://grweb.ics.forth.gr/CharacterTable1_en.jsp (.HU) Hungary http://www.domain.hu/domain/English/szabalyzat/szabalyzat.html (.INFO) International http://www.nic.info/info/idn (.IO) British Indian Ocean Territory http://www.nic.io/IO-IDN-Policy.pdf (.IR) Iran http://www.nic.ir/Allowable_Characters_dot-iran (.IS) Iceland http://www.isnic.is/domain/rules.php (.KR) Korea http://www.iana.org/domains/idn-tables/tables/kr_ko-kr_1.0.html (.LI) Liechtenstein https://nic.switch.ch/reg/ocView.action?res=EF6GW2JBPVTG67DLNIQXU234MN6SC33JNQQGI7L6#anhang1 (.LT) Lithuania http://www.domreg.lt/static/doc/public/idn_symbols-en.pdf (.MD) Moldova http://www.register.md/ (.MUSEUM) International http://www.iana.org/domains/idn-tables/tables/museum_latn_1.0.html (.NET) International http://www.verisign.com/information-services/naming-services/internationalized-domain-names/index.html (.NO) Norway http://www.norid.no/domeneregistrering/idn/idn_nyetegn.en.html (.NU) Niue http://www.worldnames.net/ (.ORG) International http://www.pir.org/index.php?db=content/FAQs&tbl=FAQs_Registrant&id=2 (.PE) Peru https://www.nic.pe/nuevas_politicas_faq_2.php (.PL) Poland http://www.dns.pl/IDN/allowed_character_sets.pdf (.PR) Puerto Rico http://www.nic.pr/idn_rules.asp (.PT) Portugal https://online.dns.pt/dns_2008/do?com=DS;8216320233;111;+PAGE(4000058)+K-CAT-CODIGO(C.125)+RCNT(100); (.RU) Russia http://www.iana.org/domains/idn-tables/tables/ru_ru-ru_1.0.html (.SA) Saudi Arabia http://www.iana.org/domains/idn-tables/tables/sa_ar_1.0.html (.SE) Sweden http://www.iis.se/english/IDN_campaignsite.shtml?lang=en (.SH) Saint Helena http://www.nic.sh/SH-IDN-Policy.pdf (.SJ) Svalbard and Jan Mayen http://www.norid.no/domeneregistrering/idn/idn_nyetegn.en.html (.TH) Thailand http://www.iana.org/domains/idn-tables/tables/th_th-th_1.0.html (.TM) Turkmenistan http://www.nic.tm/TM-IDN-Policy.pdf (.TR) Turkey https://www.nic.tr/index.php (.VE) Venice http://www.iana.org/domains/idn-tables/tables/ve_es_1.0.html (.VN) Vietnam http://www.vnnic.vn/english/5-6-300-2-2-04-20071115.htm#1.%20Introduction

$_validTlds
jump to class

array $_validTlds = 'array'

Array of valid top-level-domains

Details

$_validTlds: array
visibility: protected
default: array
final: false
static: false
see: ftp://data.iana.org/TLD/tlds-alpha-by-domain.txt List of all TLDs by domain
see: http://www.iana.org/domains/root/db/ Official list of supported TLDs

Methods

__construct
jump to class

__construct(
           $options
              =
              array
          )
        
        :
        void

Sets validator options

Arguments

$options

Details

visibility: public
final: false
static: false
see: http://www.iana.org/cctld/specifications-policies-cctlds-01apr02.htm Technical Specifications for ccTLDs

decodePunycode
jump to class

decodePunycode(
          string $encoded
          )
        
        :
        string

Decodes a punycode encoded string to it's original utf8 string In case of a decoding failure the original string is returned

Arguments

$encoded: string
Punycode encoded string to decode

Output

string

Details

visibility: protected
final: false
static: false

getAllow
jump to class

getAllow(
          
          )
        
        :
        integer

Returns the allow option

Output

integer

Details

visibility: public
final: false
static: false

getIpValidator
jump to class

getIpValidator(
          
          )
        
        :
        Zend_Validate_Ip

Returns the set ip validator

Output

Zend_Validate_Ip

Details

visibility: public
final: false
static: false

getOptions
jump to class

getOptions(
          
          )
        
        :
        array

Returns all set options

Output

array

Details

visibility: public
final: false
static: false

getValidateIdn
jump to class

getValidateIdn(
          
          )
        
        :
        boolean

Returns the set idn option

Output

boolean

Details

visibility: public
final: false
static: false

getValidateTld
jump to class

getValidateTld(
          
          )
        
        :
        boolean

Returns the set tld option

Output

boolean

Details

visibility: public
final: false
static: false

isValid
jump to class

isValid(
          string $value
          )
        
        :
        boolean

Defined by Zend_Validate_Interface

Returns true if and only if the $value is a valid hostname with respect to the current allow option

Arguments

$value: string

Output

boolean

Details

visibility: public
final: false
static: false
throws: if a fatal error occurs for validation process

setAllow
jump to class

setAllow(
          integer $allow
          )
        
        :
        Zend_Validate_Hostname

Sets the allow option

Arguments

$allow: integer

Output

Zend_Validate_Hostname: Provides a fluent interface

Details

visibility: public
final: false
static: false

setIpValidator
jump to class

setIpValidator(
          Zend_Validate_Ip $ipValidator
              =
              null
          )
        
        :
        void;

Arguments

$ipValidator: Zend_Validate_Ip
OPTIONAL

Output

void;

Details

visibility: public
final: false
static: false

setOptions
jump to class

setOptions(
          array $options
          )
        
        :
        Zend_Validate_Hostname

Sets the options for this validator

Arguments

$options: array

Output

Zend_Validate_Hostname

Details

visibility: public
final: false
static: false

setValidateIdn
jump to class

setValidateIdn(
          boolean $allowed
          )
        
        :

Set whether IDN domains are validated

This only applies when DNS hostnames are validated

Arguments

$allowed: boolean
Set allowed to true to validate IDNs, and false to not validate them

Details

visibility: public
final: false
static: false

setValidateTld
jump to class

setValidateTld(
          boolean $allowed
          )
        
        :

Set whether the TLD element of a hostname is validated

This only applies when DNS hostnames are validated

Arguments

$allowed: boolean
Set allowed to true to validate TLDs, and false to not validate them

Details

visibility: public
final: false
static: false

API Documentation

Validate/Hostname.php

Description

Zend_Validate_Hostnamejump to top

Description

Constants

CANNOT_DECODE_PUNYCODEjump to class

Details

INVALIDjump to class

Details

INVALID_DASHjump to class

Details

INVALID_HOSTNAMEjump to class

Details

INVALID_HOSTNAME_SCHEMAjump to class

Details

INVALID_LOCAL_NAMEjump to class

Details

INVALID_URIjump to class

Details

IP_ADDRESS_NOT_ALLOWEDjump to class

Details

LOCAL_NAME_NOT_ALLOWEDjump to class

Details

UNDECIPHERABLE_TLDjump to class

Details

UNKNOWN_TLDjump to class

Details

ALLOW_DNSjump to class

Details

ALLOW_IPjump to class

Details

ALLOW_LOCALjump to class

Details

ALLOW_ALLjump to class

Details

ALLOW_URIjump to class

Details

Properties

$_idnLengthjump to class

Details

$_messageTemplatesjump to class

Details

$_messageVariablesjump to class

Details

$_optionsjump to class

Details

$_tldjump to class

Details

$_validIdnsjump to class

Details

$_validTldsjump to class

Details

Methods

__constructjump to class

Arguments

Details

decodePunycodejump to class

Arguments

Output

Details

getAllowjump to class

Output

Details

getIpValidatorjump to class

Output

Details

getOptionsjump to class

Output

Details

getValidateIdnjump to class

Output

Details

getValidateTldjump to class

Output

Details

isValidjump to class

Arguments

Output

Details

Zend_Validate_Hostname
jump to top

CANNOT_DECODE_PUNYCODE
jump to class

INVALID
jump to class

INVALID_DASH
jump to class

INVALID_HOSTNAME
jump to class

INVALID_HOSTNAME_SCHEMA
jump to class

INVALID_LOCAL_NAME
jump to class

INVALID_URI
jump to class

IP_ADDRESS_NOT_ALLOWED
jump to class

LOCAL_NAME_NOT_ALLOWED
jump to class

UNDECIPHERABLE_TLD
jump to class

UNKNOWN_TLD
jump to class

ALLOW_DNS
jump to class

ALLOW_IP
jump to class

ALLOW_LOCAL
jump to class

ALLOW_ALL
jump to class

ALLOW_URI
jump to class

$_idnLength
jump to class

$_messageTemplates
jump to class

$_messageVariables
jump to class

$_options
jump to class

$_tld
jump to class

$_validIdns
jump to class

$_validTlds
jump to class

__construct
jump to class

decodePunycode
jump to class

getAllow
jump to class

getIpValidator
jump to class

getOptions
jump to class

getValidateIdn
jump to class

getValidateTld
jump to class

isValid
jump to class

setAllow
jump to class

setIpValidator
jump to class

setOptions
jump to class

setValidateIdn
jump to class

setValidateTld
jump to class