Zend Framework  3.0
Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
Mailto Class Reference

"Mailto" URI handler More...

Public Member Functions

 isValid ()
 Check if the URI is a valid Mailto URI.
 
 setEmail ($email)
 Set the email address.
 
 getEmail ()
 Get the email address.
 
 setValidator (ValidatorInterface $validator)
 Set validator to use when validating email address.
 
 getValidator ()
 Retrieve validator for use with validating email address.
 
- Public Member Functions inherited from Uri
 __construct ($uri=null)
 Create a new URI object.
 
 isValid ()
 Check if the URI is valid.
 
 isValidRelative ()
 Check if the URI is a valid relative URI.
 
 isAbsolute ()
 Check if the URI is an absolute or relative URI.
 
 parse ($uri)
 Parse a URI string.
 
 toString ()
 Compose the URI into a string.
 
 normalize ()
 Normalize the URI.
 
 resolve ($baseUri)
 Convert a relative URI into an absolute URI using a base absolute URI as a reference.
 
 makeRelative ($baseUri)
 Convert the link to a relative link by substracting a base URI.
 
 getScheme ()
 Get the scheme part of the URI.
 
 getUserInfo ()
 Get the User-info (usually user:password) part.
 
 getHost ()
 Get the URI host.
 
 getPort ()
 Get the URI port.
 
 getPath ()
 Get the URI path.
 
 getQuery ()
 Get the URI query.
 
 getQueryAsArray ()
 Return the query string as an associative array of key => value pairs.
 
 getFragment ()
 Get the URI fragment.
 
 setScheme ($scheme)
 Set the URI scheme.
 
 setUserInfo ($userInfo)
 Set the URI User-info part (usually user:password)
 
 setHost ($host)
 Set the URI host.
 
 setPort ($port)
 Set the port part of the URI.
 
 setPath ($path)
 Set the path.
 
 setQuery ($query)
 Set the query string.
 
 setFragment ($fragment)
 Set the URI fragment part.
 
 __toString ()
 Magic method to convert the URI to a string.
 

Protected Attributes

 $emailValidator
 
- Protected Attributes inherited from Uri
 $scheme
 
 $userInfo
 
 $host
 
 $port
 
 $path
 
 $query
 
 $fragment
 
 $validHostTypes = self::HOST_ALL
 

Static Protected Attributes

static $validSchemes = ['mailto']
 
- Static Protected Attributes inherited from Uri
static $validSchemes = []
 
static $defaultPorts = []
 
static $escaper
 

Additional Inherited Members

- Static Public Member Functions inherited from Uri
static setEscaper (Escaper $escaper)
 Set Escaper instance.
 
static getEscaper ()
 Retrieve Escaper instance.
 
static validateScheme ($scheme)
 Encoding and Validation Methods.
 
static validateUserInfo ($userInfo)
 Check that the userInfo part of a URI is valid.
 
static validateHost ($host, $allowed=self::HOST_ALL)
 Validate the host part.
 
static validatePort ($port)
 Validate the port.
 
static validatePath ($path)
 Validate the path.
 
static validateQueryFragment ($input)
 Check if a URI query or fragment part is valid or not.
 
static encodeUserInfo ($userInfo)
 URL-encode the user info part of a URI.
 
static encodePath ($path)
 Encode the path.
 
static encodeQueryFragment ($input)
 URL-encode a query string or fragment based on RFC-3986 guidelines.
 
static parseScheme ($uriString)
 Extract only the scheme part out of a URI string.
 
static removePathDotSegments ($path)
 Remove any extra dot segments (/../, /.
 
static merge ($baseUri, $relativeUri)
 Merge a base URI and a relative URI into a new URI object.
 
- Public Attributes inherited from Uri
const CHAR_UNRESERVED = 'a-zA-Z0-9_\-\.~'
 Character classes defined in RFC-3986.
 
const CHAR_GEN_DELIMS = ':\/\?#\[\]@'
 
const CHAR_SUB_DELIMS = '!\$&\'\(\)\*\+,;='
 
const CHAR_RESERVED = ':\/\?#\[\]@!\$&\'\(\)\*\+,;='
 
const CHAR_QUERY_DELIMS = '!\$\'\(\)\*\,'
 Not in the spec - those characters have special meaning in urlencoded query parameters.
 
const HOST_IPV4 = 0x01
 Host part types represented as binary masks The binary mask consists of 5 bits in the following order: <RegName> | <DNS> | <IPvFuture> | <IPv6> | <IPv4> Place 1 or 0 in the different positions for enable or disable the part.
 
const HOST_IPV6 = 0x02
 
const HOST_IPVFUTURE = 0x04
 
const HOST_IPVANY = 0x07
 
const HOST_DNS = 0x08
 
const HOST_DNS_OR_IPV4 = 0x09
 
const HOST_DNS_OR_IPV6 = 0x0A
 
const HOST_DNS_OR_IPV4_OR_IPV6 = 0x0B
 
const HOST_DNS_OR_IPVANY = 0x0F
 
const HOST_REGNAME = 0x10
 
const HOST_DNS_OR_IPV4_OR_IPV6_OR_REGNAME = 0x1B
 
const HOST_ALL = 0x1F
 
- Protected Member Functions inherited from Uri
 reset ()
 Reset URI parts.
 
- Static Protected Member Functions inherited from Uri
static isValidIpAddress ($host, $allowed)
 Check if a host name is a valid IP address, depending on allowed IP address types.
 
static isValidDnsHostname ($host)
 Check if an address is a valid DNS hostname.
 
static isValidRegName ($host)
 Check if an address is a valid registered name (as defined by RFC-3986) address.
 
static normalizeScheme ($scheme)
 Part normalization methods.
 
static normalizeHost ($host)
 Normalize the host part.
 
static normalizePort ($port, $scheme=null)
 Normalize the port.
 
static normalizePath ($path)
 Normalize the path.
 
static normalizeQuery ($query)
 Normalize the query part.
 
static normalizeFragment ($fragment)
 Normalize the fragment part.
 
static decodeUrlEncodedChars ($input, $allowed= '')
 Decode all percent encoded characters which are allowed to be represented literally.
 

Detailed Description

"Mailto" URI handler

The 'mailto:...' scheme is loosely defined in RFC-1738

Member Function Documentation

getEmail ( )

Get the email address.

This is infact equivalent to getPath() - but provides a more clear interface

Returns
string
getValidator ( )

Retrieve validator for use with validating email address.

If none is currently set, an EmailValidator instance with default options will be used.

Returns
ValidatorInterface
isValid ( )

Check if the URI is a valid Mailto URI.

This applies additional specific validation rules beyond the ones required by the generic URI syntax

Returns
bool
See Also
Uri::isValid()

Implements UriInterface.

setEmail (   $email)

Set the email address.

This is in fact equivalent to setPath() - but provides a more clear interface

Parameters
string$email
Returns
Mailto
setValidator ( ValidatorInterface  $validator)

Set validator to use when validating email address.

Parameters
ValidatorInterface$validator
Returns
Mailto

Member Data Documentation

$emailValidator
protected
$validSchemes = ['mailto']
staticprotected