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

 parse ($uri)
 
- Fonctions membres publiques hérités de Uri
 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 ()
 

Fonctions membres publiques statiques

static getInstance ($uri='SERVER')
 
static base ($pathonly=false)
 
static root ($pathonly=false, $path=null)
 
static current ()
 
static reset ()
 
static isInternal ($url)
 
static buildQuery (array $params)
 

Attributs protégés statiques

static $instances = array()
 
static $base = array()
 
static $root = array()
 
static $current
 

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 serves two purposes. First it parses a URI and provides a common interface for the Joomla Platform to access and manipulate a URI. Second it obtains the URI of the current executing script from the server regardless of server.

Depuis
1.7.0

Documentation des fonctions membres

◆ base()

◆ buildQuery()

static buildQuery ( array  $params)
static

Build a query from an array (reverse of the PHP parse_str()).

Paramètres
array$paramsThe array of key => value pairs to return as a query string.
Renvoie
string The resulting query string.
Voir également
parse_str()
Depuis
1.7.0
Note
The parent method is protected, this exposes it as public for B/C

Références $params.

Référencé par ItemController\setType().

◆ current()

static current ( )
static

Returns the URL for the request, minus the query.

Renvoie
string
Depuis
1.7.0

Références $uri.

Référencé par SiteApplication\dispatch().

◆ getInstance()

◆ isInternal()

◆ parse()

parse (   $uri)

Parse a given URI and populate the class fields.

Paramètres
string$uriThe URI string to parse.
Renvoie
boolean True on success.
Depuis
1.7.0
Note
The parent method is protected, this exposes it as public for B/C

Références $uri.

◆ reset()

static reset ( )
static

Method to reset class static members for testing and other various issues.

Renvoie
void
Depuis
1.7.0

Références $base, et $root.

◆ root()

static root (   $pathonly = false,
  $path = null 
)
static

Returns the root URI for the request.

Paramètres
boolean$pathonlyIf false, prepend the scheme, host and port information. Default is false.
string$pathThe path
Renvoie
string The root URI string.
Depuis
1.7.0
Exemples:
C:/laragon/www/_install/Joomla_422-Stable-Full_Package_French_v1/libraries/src/HTML/HTMLHelper.php.

Références $path, $root, et $uri.

Référencé par InstallationApplication\__construct(), ApiApplication\__construct(), AdministratorApplication\__construct(), HtmlView\addToolbar(), Tag\ajaxfield(), AdministratorRouter\build(), SiteRouter\buildBase(), ContentSerializer\category(), ContactSerializer\category(), NewsfeedSerializer\category(), Email\cloak(), MailHelper\convertRelativeToAbsoluteUrls(), HTMLHelper\convertToRelativePath(), ContentSerializer\createdBy(), ContactSerializer\createdBy(), NewsfeedSerializer\createdBy(), UrlFilter\filter(), LanguageStringsCollector\getAssets(), InfoCollector\getAssets(), LanguageErrorsCollector\getAssets(), LanguageFilesCollector\getAssets(), QueryCollector\getAssets(), TemplateModel\getFont(), TemplateModel\getImage(), Authentication\getKnownAuthenticators(), LocalAdapter\getUrl(), Users\image(), Joomla\Plugin\Editors\TinyMCE\PluginTraits\includeRelativeFiles(), ContentSerializer\languageAssociations(), ContactSerializer\languageAssociations(), NewsfeedSerializer\languageAssociations(), UserController\logout(), UserController\menulogout(), ContentSerializer\modifiedBy(), ContactSerializer\modifiedBy(), NewsfeedSerializer\modifiedBy(), CoreAssetItem\onAttachCallback(), Joomla\Plugin\Editors\TinyMCE\PluginTraits\onDisplay(), RegistrationModel\register(), ContentHelper\resolve(), Joomla\Plugin\Editors\TinyMCE\PluginTraits\resolveFileUrl(), ApplicationModel\save(), Templates\thumb(), Templates\thumbModal(), et ContactSerializer\userId().

Documentation des champs

◆ $base

$base = array()
staticprotected

◆ $current

$current
staticprotected

◆ $instances

$instances = array()
staticprotected

◆ $root

$root = array()
staticprotected

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