HTMLPurifier_URIScheme_ftp Class Reference

Validates ftp (File Transfer Protocol) URIs as defined by generic RFC 1738. More...

Inheritance diagram for HTMLPurifier_URIScheme_ftp:

Collaboration diagram for HTMLPurifier_URIScheme_ftp:

Public Member Functions
	doValidate (&$uri, $config, $context)
Public Member Functions inherited from HTMLPurifier_URIScheme
	validate (&$uri, $config, $context)
	Public interface for validating components of a URI.

Data Fields
	$default_port = 21
	int
	$browsable = true
	bool
	$hierarchical = true
	bool
Data Fields inherited from HTMLPurifier_URIScheme
	$default_port = null
	Scheme's default port (integer).
	$browsable = false
	Whether or not URIs of this scheme are locatable by a browser http and ftp are accessible, while mailto and news are not.
	$secure = false
	Whether or not data transmitted over this scheme is encrypted.
	$hierarchical = false
	Whether or not the URI always uses <hier_part>, resolves edge cases with making relative URIs absolute bool.
	$may_omit_host = false
	Whether or not the URI may omit a hostname when the scheme is explicitly specified, ala file:///path/to/file.

Detailed Description

Validates ftp (File Transfer Protocol) URIs as defined by generic RFC 1738.

Definition at line 6 of file ftp.php.

Member Function Documentation

HTMLPurifier_URIScheme_ftp::doValidate	(	&	$uri,
			$config,
			$context
	)

Parameters

HTMLPurifier_URI	$uri
HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns

bool

Reimplemented from HTMLPurifier_URIScheme.

Definition at line 29 of file ftp.php.

    {
        $uri->query = null;

        // typecode check
        $semicolon_pos = strrpos($uri->path, ';'); // reverse
        if ($semicolon_pos !== false) {
            $type = substr($uri->path, $semicolon_pos + 1); // no semicolon
            $uri->path = substr($uri->path, 0, $semicolon_pos);
            $type_ret = '';
            if (strpos($type, '=') !== false) {
                // figure out whether or not the declaration is correct
                list($key, $typecode) = explode('=', $type, 2);
                if ($key !== 'type') {
                    // invalid key, tack it back on encoded
                    $uri->path .= '%3B' . $type;
                } elseif ($typecode === 'a' || $typecode === 'i' || $typecode === 'd') {
                    $type_ret = ";type=$typecode";
                }
            } else {
                $uri->path .= '%3B' . $type;
            }
            $uri->path = str_replace(';', '%3B', $uri->path);
            $uri->path .= $type_ret;
        }
        return true;
    }

Field Documentation

HTMLPurifier_URIScheme_ftp::$browsable = true

bool

Definition at line 16 of file ftp.php.

HTMLPurifier_URIScheme_ftp::$default_port = 21

int

Definition at line 11 of file ftp.php.

HTMLPurifier_URIScheme_ftp::$hierarchical = true

bool

Definition at line 21 of file ftp.php.

---

The documentation for this class was generated from the following file:

• Services/Html/HtmlPurifier/library/HTMLPurifier/URIScheme/ftp.php