Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Référence de l'interface UriInterface
+ Graphe d'héritage de UriInterface:

Fonctions membres publiques

 __toString ()
 
 toString (array $parts=array('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 anchor string Everything after the "#".

Renvoie
string The URI anchor string.
Depuis
1.0

Implémenté dans AbstractUri.

◆ getHost()

getHost ( )

Get URI host Returns the hostname/ip or null if no hostname/ip was specified.

Renvoie
string The URI host.
Depuis
1.0

Implémenté dans AbstractUri.

◆ getPass()

getPass ( )

Get URI password Returns the password, or null if no password was specified.

Renvoie
string The URI password.
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 URI port Returns the port number, or null if no port was specified.

Renvoie
integer The URI port number.
Depuis
1.0

Implémenté dans AbstractUri.

◆ getQuery()

getQuery (   $toArray = false)

Returns flat query string.

Paramètres
boolean$toArrayTrue to return the query as a key => value pair array.
Renvoie
string Query string.
Depuis
1.0

Implémenté dans AbstractUri.

◆ getScheme()

getScheme ( )

Get URI scheme (protocol) ie. http, https, ftp, etc...

Renvoie
string The URI scheme.
Depuis
1.0

Implémenté dans AbstractUri.

◆ getUser()

getUser ( )

Get URI username Returns the username, or null if no username was specified.

Renvoie
string The URI username.
Depuis
1.0

Implémenté dans AbstractUri.

◆ getVar()

getVar (   $name,
  $default = null 
)

Returns a query variable by name.

Paramètres
string$nameName of the query variable to get.
string$defaultDefault value to return if the variable is not set.
Renvoie
array Query variables.
Depuis
1.0

Implémenté dans AbstractUri.

◆ hasVar()

hasVar (   $name)

Checks if variable exists.

Paramètres
string$nameName 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 ( array  $parts = array('scheme', 'user', 'pass', 'host', 'port', 'path', 'query', 'fragment'))

Returns full uri string.

Paramètres
array$partsAn 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 :