Joomla CMS  2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Fonctions membres publiques | Fonctions membres publiques statiques | Fonctions membres protégées | Attributs protégés | Attributs protégés statiques
Référence de la classe JURI
+ Graphe d'héritage de JURI:
+ Graphe de collaboration de JURI:

Liste de tous les membres

Fonctions membres publiques

 __construct ($uri=null)
 __toString ()
 parse ($uri)
 toString ($parts=array('scheme', 'user', 'pass', 'host', 'port', 'path', 'query', 'fragment'))
 setVar ($name, $value)
 hasVar ($name)
 getVar ($name, $default=null)
 delVar ($name)
 setQuery ($query)
 getQuery ($toArray=false)
 getScheme ()
 setScheme ($scheme)
 getUser ()
 setUser ($user)
 getPass ()
 setPass ($pass)
 getHost ()
 setHost ($host)
 getPort ()
 setPort ($port)
 getPath ()
 setPath ($path)
 getFragment ()
 setFragment ($anchor)
 isSSL ()
- Fonctions membres publiques inherited from JObject
 def ($property, $default=null)
 get ($property, $default=null)
 getProperties ($public=true)
 getError ($i=null, $toString=true)
 getErrors ()
 set ($property, $value=null)
 setProperties ($properties)
 setError ($error)
 toString ()

Fonctions membres publiques statiques

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

Fonctions membres protégées

 _cleanPath ($path)

Attributs protégés

 $_uri = null
 $_scheme = null
 $_host = null
 $_port = null
 $_user = null
 $_pass = null
 $_path = null
 $_query = null
 $_fragment = null
 $_vars = array()
- Attributs protégés inherited from JObject
 $_errors = array()

Attributs protégés statiques

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

Documentation des constructeurs et destructeur

JURI::__construct (   $uri = null)

Constructor. You can pass a URI string to the constructor to initialise a specific URI.

Paramètres:
string$uriThe optional URI string
Depuis:
11.1

Réimplémentée à partir de JObject.

Références $uri.

Documentation des fonctions membres

JURI::__toString ( )

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

Renvoie:
string
Depuis:
11.1

Réimplémentée à partir de JObject.

JURI::_cleanPath (   $path)
protected

Resolves //, ../ and ./ from a path and returns the result. Eg:

/foo/bar/../boo.php => /foo/boo.php /foo/bar/../../boo.php => /boo.php /foo/bar/.././/boo.php => /foo/boo.php

Paramètres:
string$pathThe URI path to clean.
Renvoie:
string Cleaned and resolved URI path.
Depuis:
11.1

Références $i, $n, $path, et elseif.

static JURI::base (   $pathonly = false)
static

Returns the base URI for the request.

Paramètres:
boolean$pathonlyIf false, prepend the scheme, host and port information. Default is false.
Renvoie:
string The base URI string
Depuis:
11.1

Références $base, $config, $uri, JFactory\getConfig(), JPATH_ADMINISTRATOR, et JPATH_BASE.

Référencé par JAdministrator\__construct(), JDocumentOpensearch\__construct(), JView\__construct(), plgEditorNone\_displayButtons(), JDocumentHTML\_fetchTemplate(), JButtonPopup\_getCommand(), JDocumentHTML\_loadTemplate(), JDocumentRendererRSS\_relToAbs(), ContactControllerContact\_sendEmail(), JHtmlImage\administrator(), JRouterAdministrator\build(), JRouterSite\build(), SearchViewSearch\display(), JoomlaupdateViewUpdate\display(), TemplatesViewPrevuuw\display(), FinderViewSearch\display(), FinderIndexerHelper\getContentPath(), modRandomImageHelper\getFolder(), WeblinksControllerWeblink\getReturnPage(), ContentControllerArticle\getReturnPage(), JHtml\includeRelativeFiles(), JAdministrator\login(), JSite\login(), plgSystemSef\onAfterRender(), plgQuickiconExtensionupdate\onGetIcons(), plgQuickiconJoomlaupdate\onGetIcons(), JRouterSite\parse(), plgSystemLanguageFilter\parseRule(), JApplication\redirect(), JDocumentError\render(), MenusModelItem\save(), et JHtmlImage\site().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

static JURI::buildQuery (   $params)
static

Build a query from a 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:
11.1

Références $params.

Référencé par JRouter\_createURI(), et MenusControllerItem\setType().

+ Voici le graphe des appelants de cette fonction :

static JURI::current ( )
static

Returns the URL for the request, minus the query.

Renvoie:
string
Depuis:
11.1

Références $uri.

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

+ Voici le graphe des appelants de cette fonction :

JURI::delVar (   $name)

Removes an item from the query string variables if it exists.

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

Références $name, et null.

JURI::getFragment ( )

Get the URI archor string Everything after the "#".

Renvoie:
string The URI anchor string.
Depuis:
11.1
JURI::getHost ( )

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

Renvoie:
string The URI host.
Depuis:
11.1
static JURI::getInstance (   $uri = 'SERVER')
static

Returns the global JURI object, only creating it if it doesn't already exist.

Paramètres:
string$uriThe URI to parse. [optional: if null uses script URI]
Renvoie:
JURI The URI object.
Depuis:
11.1

Références $uri.

Référencé par JRoute\_(), UsersModelRegistration\activate(), JInstallationController\display(), JHtmlIcon\email(), JForm\filterField(), FinderViewSearch\getFields(), ModFinderHelper\getGetFields(), JFactory\getURI(), plgSystemRedirect\handleError(), plgSystemLanguageFilter\onAfterDispatch(), JApplication\redirect(), JApplicationWeb\redirect(), UsersModelRegistration\register(), JAdministrator\route(), JApplication\route(), MenusModelItem\save(), SearchController\search(), et FinderIndexerQuery\toURI().

+ Voici le graphe des appelants de cette fonction :

JURI::getPass ( )

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

Renvoie:
string The URI password.
Depuis:
11.1
JURI::getPath ( )

Gets the URI path string.

Renvoie:
string The URI path string.
Depuis:
11.1
JURI::getPort ( )

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

Renvoie:
integer The URI port number.
Depuis:
11.1

Références null.

JURI::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:
11.1
JURI::getScheme ( )

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

Renvoie:
string The URI scheme.
Depuis:
11.1
JURI::getUser ( )

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

Renvoie:
string The URI username.
Depuis:
11.1
JURI::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:
11.1

Références $name.

JURI::hasVar (   $name)

Checks if variable exists.

Paramètres:
string$nameName of the query variable to check.
Renvoie:
boolean True if the variable exists.
Depuis:
11.1

Références $name.

static JURI::isInternal (   $url)
static

Checks if the supplied URL is internal

Paramètres:
string$urlThe URL to check.
Renvoie:
boolean True if Internal.
Depuis:
11.1

Références $base, $uri, et $url.

Référencé par UsersModelLogin\loadFormData(), UsersControllerUser\logout(), LoginModelLogin\populateState(), et MailtoController\send().

+ Voici le graphe des appelants de cette fonction :

JURI::isSSL ( )

Checks whether the current URI is using HTTPS.

Renvoie:
boolean True if using SSL via HTTPS.
Depuis:
11.1
JURI::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:
11.1

Références $uri, null, et JString\parse_url().

+ Voici le graphe d'appel pour cette fonction :

static JURI::reset ( )
static

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

Renvoie:
void
Depuis:
11.1

Références $base.

static JURI::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:
11.1

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

Référencé par JAdministrator\__construct(), MediaViewMediaList\display(), TemplatesViewPrevuuw\display(), LanguagesViewOverride\display(), JForm\filterField(), JFormFieldMedia\getInput(), JHtml\includeRelativeFiles(), plgEditorCodemirror\onDisplay(), plgEditorTinymce\onInit(), et MessagesModelMessage\save().

+ Voici le graphe des appelants de cette fonction :

JURI::setFragment (   $anchor)

Set the URI anchor string everything after the "#".

Paramètres:
string$anchorThe URI anchor string.
Renvoie:
void
Depuis:
11.1
JURI::setHost (   $host)

Set URI host.

Paramètres:
string$hostThe URI host.
Renvoie:
void
Depuis:
11.1
JURI::setPass (   $pass)

Set URI password.

Paramètres:
string$passThe URI password.
Renvoie:
void
Depuis:
11.1
JURI::setPath (   $path)

Set the URI path string.

Paramètres:
string$pathThe URI path string.
Renvoie:
void
Depuis:
11.1

Références $path.

JURI::setPort (   $port)

Set URI port.

Paramètres:
integer$portThe URI port number.
Renvoie:
void
Depuis:
11.1
JURI::setQuery (   $query)

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

Paramètres:
mixed$queryThe query string or array.
Renvoie:
void
Depuis:
11.1

Références $query, et null.

JURI::setScheme (   $scheme)

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

Paramètres:
string$schemeThe URI scheme.
Renvoie:
void
Depuis:
11.1
JURI::setUser (   $user)

Set URI username.

Paramètres:
string$userThe URI username.
Renvoie:
void
Depuis:
11.1

Références $user.

JURI::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:
11.1

Références $name, et null.

JURI::toString (   $parts = array('scheme', 'user', 'pass', 'host', 'port', 'path', 'query', 'fragment'))

Returns full uri string.

Paramètres:
array$partsAn array specifying the parts to render.
Renvoie:
string The rendered URI string.
Depuis:
11.1

Références $parts, $query, et $uri.

Documentation des données membres

JURI::$_fragment = null
protected
JURI::$_host = null
protected
JURI::$_pass = null
protected
JURI::$_path = null
protected
JURI::$_port = null
protected
JURI::$_query = null
protected
JURI::$_scheme = null
protected
JURI::$_uri = null
protected
JURI::$_user = null
protected
JURI::$_vars = array()
protected
JURI::$base = array()
staticprotected
JURI::$current
staticprotected
JURI::$instances = array()
staticprotected
JURI::$root = array()
staticprotected
La documentation de cette classe a été générée à partir du fichier suivant :