Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe Uri
+ Graphe d'héritage de Uri:

Fonctions membres publiques

 setVar ($name, $value)
 
 delVar ($name)
 
 setQuery ($query)
 
 setScheme ($scheme)
 
 setUser ($user)
 
 setPass ($pass)
 
 setHost ($host)
 
 setPort ($port)
 
 setPath ($path)
 
 setFragment ($anchor)
 
- Fonctions membres publiques hérités de AbstractUri
 __construct ($uri=null)
 
 __toString ()
 
 toString ($parts=['scheme', 'user', 'pass', 'host', 'port', 'path', 'query', 'fragment'])
 
 render ($parts=self::ALL)
 
 hasVar ($name)
 
 getVar ($name, $default=null)
 
 getQuery ($toArray=false)
 
 getScheme ()
 
 getUser ()
 
 getPass ()
 
 getHost ()
 
 getPort ()
 
 getPath ()
 
 getFragment ()
 
 isSsl ()
 

Membres hérités additionnels

- Champs de données hérités de UriInterface
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
 
- Fonctions membres protégées hérités de AbstractUri
 parse ($uri)
 
 cleanPath ($path)
 
- Fonctions membres protégées statiques hérités de AbstractUri
static buildQuery (array $params)
 
- Attributs protégés hérités de AbstractUri
 $uri
 
 $scheme
 
 $host
 
 $port
 
 $user
 
 $pass
 
 $path
 
 $query
 
 $fragment
 
 $vars = []
 

Description détaillée

Uri Class

This class parses a URI and provides a common interface for the Joomla Framework to access and manipulate a URI.

Depuis
1.0

Documentation des fonctions membres

◆ delVar()

delVar (   $name)

Removes an item from the query string variables if it exists

Paramètres
string$nameName of variable to remove.
Renvoie
void
Depuis
1.0

Références $name, et null.

◆ setFragment()

setFragment (   $anchor)

Set the URI anchor string

Paramètres
string$anchorThe URI anchor string.
Renvoie
Uri This method supports chaining.
Depuis
1.0

Références $this.

◆ setHost()

setHost (   $host)

Set the URI host

Paramètres
string$hostThe URI host.
Renvoie
Uri This method supports chaining.
Depuis
1.0

Références AbstractUri\$host, et $this.

◆ setPass()

setPass (   $pass)

Set the URI password

Paramètres
string$passThe URI password.
Renvoie
Uri This method supports chaining.
Depuis
1.0

Références AbstractUri\$pass, et $this.

◆ setPath()

setPath (   $path)

Set the URI path string

Paramètres
string$pathThe URI path string.
Renvoie
Uri This method supports chaining.
Depuis
1.0

Références AbstractUri\$path, $this, AbstractUri\cleanPath(), et path.

◆ setPort()

setPort (   $port)

Set the URI port

Paramètres
integer$portThe URI port number.
Renvoie
Uri This method supports chaining.
Depuis
1.0

Références AbstractUri\$port, et $this.

◆ setQuery()

setQuery (   $query)

Sets the query to a supplied string in format foo=bar&x=y

Paramètres
array | string$queryThe query string or array.
Renvoie
void
Depuis
1.0

Références AbstractUri\$query, et null.

◆ setScheme()

setScheme (   $scheme)

Set the URI scheme (protocol)

Paramètres
string$schemeThe URI scheme.
Renvoie
Uri This method supports chaining.
Depuis
1.0

Références AbstractUri\$scheme, et $this.

◆ setUser()

setUser (   $user)

Set the URI username

Paramètres
string$userThe URI username.
Renvoie
Uri This method supports chaining.
Depuis
1.0

Références $this, et AbstractUri\$user.

◆ setVar()

setVar (   $name,
  $value 
)

Adds a query variable and value, replacing the value if it already exists and returning the old value

Paramètres
string$nameName of the query variable to set.
string$valueValue of the query variable.
Renvoie
string Previous value for the query variable.
Depuis
1.0

Références $name, $tmp, $value, et null.


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