Référence de l'interface UriInterface

Graphe d'héritage de UriInterface:

Fonctions membres publiques
	__toString ()
	toString ($parts=['scheme', 'user', 'pass', 'host', 'port', 'path', 'query', 'fragment'])
	hasVar ($name)
	getVar ($name, $default=null)
	getQuery ($toArray=false)
	getScheme ()
	getUser ()
	getPass ()
	getHost ()
	getPort ()
	getPath ()
	getFragment ()
	isSsl ()

Champs de données
const	SCHEME = 1
const	USER = 2
const	PASS = 4
const	HOST = 8
const	PORT = 16
const	PATH = 32
const	QUERY = 64
const	FRAGMENT = 128
const	ALL = 255

Description détaillée

Uri Interface

Interface for read-only access to URIs.

Depuis

1.0

Documentation des fonctions membres

__toString()

__toString

(

)

Magic method to get the string representation of the URI object.

Renvoie

string

Depuis

1.0

Implémenté dans AbstractUri.

getFragment()

getFragment

(

)

Get the URI archor string

Renvoie

string The URI anchor string.

Depuis

1.0

Implémenté dans AbstractUri.

getHost()

getHost

(

)

Get the URI host

Renvoie

string The hostname/IP or null if no hostname/IP was specified.

Depuis

1.0

Implémenté dans AbstractUri.

getPass()

getPass

(

)

Get the URI password

Renvoie

string The password, or null if no password was specified.

Depuis

1.0

Implémenté dans AbstractUri.

getPath()

getPath

(

)

Gets the URI path string

Renvoie

string The URI path string.

Depuis

1.0

Implémenté dans AbstractUri.

getPort()

getPort

(

)

Get the URI port

Renvoie

integer The port number, or null if no port was specified.

Depuis

1.0

Implémenté dans AbstractUri.

getQuery()

getQuery

(

$toArray = false

)

Returns flat query string.

Paramètres

boolean

$toArray

True to return the query as a key => value pair array.

Renvoie

array|string Query string, optionally as an array.

Depuis

1.0

Implémenté dans AbstractUri.

getScheme()

getScheme

(

)

Get the URI scheme (protocol)

Renvoie

string The URI scheme.

Depuis

1.0

Implémenté dans AbstractUri.

getUser()

getUser

(

)

Get the URI username

Renvoie

string The username, or null if no username was specified.

Depuis

1.0

Implémenté dans AbstractUri.

getVar()

getVar	(		$name,
			$default = null
	)

Returns a query variable by name.

Paramètres

string	$name	Name of the query variable to get.
string	$default	Default value to return if the variable is not set.

Renvoie

mixed Requested query variable if present otherwise the default value.

Depuis

1.0

Implémenté dans AbstractUri.

hasVar()

hasVar

(

$name

)

Checks if variable exists.

Paramètres

string

$name

Name of the query variable to check.

Renvoie

boolean True if the variable exists.

Depuis

1.0

Implémenté dans AbstractUri.

isSsl()

isSsl

(

)

Checks whether the current URI is using HTTPS.

Renvoie

boolean True if using SSL via HTTPS.

Depuis

1.0

Implémenté dans AbstractUri.

toString()

toString	(		$parts = ['scheme',
		'user'	,
		'pass'	,
		'host'	,
		'port'	,
		'path'	,
		'query'	,
		'fragment']
	)

Returns full URI string.

Paramètres

array

$parts

An array of strings specifying the parts to render.

Renvoie

string The rendered URI string.

Depuis

1.0

Implémenté dans AbstractUri.

Documentation des champs

ALL

const ALL = 255

FRAGMENT

const FRAGMENT = 128

HOST

const HOST = 8

PASS

const PASS = 4

PATH

const PATH = 32

PORT

const PORT = 16

QUERY

const QUERY = 64

SCHEME

const SCHEME = 1

USER

const USER = 2

---

La documentation de cette interface a été générée à partir du fichier suivant :

• joomla/uri/src/UriInterface.php