PHPXRef 0.7.1 : moodle-2.8 : Detail view of Http.php

HTTP(S) URI handler

__construct($scheme, $schemeSpecific = '') X-Ref

Constructor accepts a string $scheme (e.g., http, https) and a scheme-specific part of the URI
(e.g., example.com/path/to/resource?query=param#fragment)

param: string $scheme The scheme of the URI
param: string $schemeSpecific The scheme-specific part of the URI

fromString($uri) X-Ref

Creates a Zend_Uri_Http from the given string

param: string $uri String to create URI from, must start with
return: Zend_Uri_Http

_parseUri($schemeSpecific) X-Ref

Parse the scheme-specific portion of the URI and place its parts into instance variables.

param: string $schemeSpecific The scheme-specific portion to parse
return: void

getUri() X-Ref

Returns a URI based on current values of the instance variables. If any
part of the URI does not pass validation, then an exception is thrown.

return: string

valid() X-Ref

Validate the current URI from the instance variables. Returns true if and only if all
parts pass validation.

return: boolean

getUsername() X-Ref

Returns the username portion of the URL, or FALSE if none.

return: string

validateUsername($username = null) X-Ref

Returns true if and only if the username passes validation. If no username is passed,
then the username contained in the instance variable is used.

param: string $username The HTTP username
return: boolean

setUsername($username) X-Ref

Sets the username for the current URI, and returns the old username

param: string $username The HTTP username
return: string

getPassword() X-Ref

Returns the password portion of the URL, or FALSE if none.

return: string

validatePassword($password = null) X-Ref

Returns true if and only if the password passes validation. If no password is passed,
then the password contained in the instance variable is used.

param: string $password The HTTP password
return: boolean

setPassword($password) X-Ref

Sets the password for the current URI, and returns the old password

param: string $password The HTTP password
return: string

getHost() X-Ref

Returns the domain or host IP portion of the URL, or FALSE if none.

return: string

validateHost($host = null) X-Ref

Returns true if and only if the host string passes validation. If no host is passed,
then the host contained in the instance variable is used.

param: string $host The HTTP host
return: boolean

setHost($host) X-Ref

Sets the host for the current URI, and returns the old host

param: string $host The HTTP host
return: string

getPort() X-Ref

Returns the TCP port, or FALSE if none.

return: string

validatePort($port = null) X-Ref

Returns true if and only if the TCP port string passes validation. If no port is passed,
then the port contained in the instance variable is used.

param: string $port The HTTP port
return: boolean

setPort($port) X-Ref

Sets the port for the current URI, and returns the old port

param: string $port The HTTP port
return: string

getPath() X-Ref

Returns the path and filename portion of the URL, or FALSE if none.

return: string

validatePath($path = null) X-Ref

Returns true if and only if the path string passes validation. If no path is passed,
then the path contained in the instance variable is used.

param: string $path The HTTP path
return: boolean

setPath($path) X-Ref

Sets the path for the current URI, and returns the old path

param: string $path The HTTP path
return: string

getQuery() X-Ref

Returns the query portion of the URL (after ?), or FALSE if none.

return: string

getQueryAsArray() X-Ref

Returns the query portion of the URL (after ?) as a
key-value-array. If the query is empty an empty array
is returned

return: array

validateQuery($query = null) X-Ref

Returns true if and only if the query string passes validation. If no query is passed,
then the query string contained in the instance variable is used.

param: string $query The query to validate
return: boolean

addReplaceQueryParameters(array $queryParams) X-Ref

Add or replace params in the query string for the current URI, and
return the old query.

param: array $queryParams
return: string Old query string

removeQueryParameters(array $queryParamKeys) X-Ref

Remove params in the query string for the current URI, and
return the old query.

param: array $queryParamKeys
return: string Old query string

setQuery($query) X-Ref

Set the query string for the current URI, and return the old query
string This method accepts both strings and arrays.

param: string|array $query The query string or array
return: string Old query string

getFragment() X-Ref

Returns the fragment portion of the URL (after #), or FALSE if none.

return: string|false

validateFragment($fragment = null) X-Ref

Returns true if and only if the fragment passes validation. If no fragment is passed,
then the fragment contained in the instance variable is used.

param: string $fragment Fragment of an URI
return: boolean

setFragment($fragment) X-Ref

Sets the fragment for the current URI, and returns the old fragment

param: string $fragment Fragment of the current URI
return: string

Copyright:	Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License:	http://framework.zend.com/license/new-bsd New BSD License
Version:	$Id$
File Size:	769 lines (24 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of moodle-2.8

/lib/zend/Zend/Uri/ -> Http.php (summary)

Defines 1 class