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
Référence de la classe JSite
+ Graphe d'héritage de JSite:
+ Graphe de collaboration de JSite:

Liste de tous les membres

Fonctions membres publiques

 getMenu ()
 getItems ()
 __construct ($config=array())
 initialise ($options=array())
 route ()
 dispatch ($component=null)
 render ()
 login ($credentials, $options=array())
 authorize ($itemid)
 authorise ($itemid)
 getParams ($option=null)
 getPageParameters ($option=null)
 getTemplate ($params=false)
 setTemplate ($template, $styleParams=null)
 getMenu ($name=null, $options=array())
 getPathway ($name=null, $options=array())
 getLanguageFilter ()
 setLanguageFilter ($state=false)
 getDetectBrowser ()
 setDetectBrowser ($state=false)
 redirect ($url, $msg='', $msgType='message', $moved=false, $persistMsg=true)
- Fonctions membres publiques inherited from JApplication
 close ($code=0)
 redirect ($url, $msg= '', $msgType= 'message', $moved=false)
 enqueueMessage ($msg, $type= 'message')
 getMessageQueue ()
 getCfg ($varname, $default=null)
 getName ()
 getUserState ($key, $default=null)
 setUserState ($key, $value)
 getUserStateFromRequest ($key, $request, $default=null, $type= 'none')
 triggerEvent ($event, $args=null)
 logout ($userid=null, $options=array())
 checkSession ()
 getClientId ()
 isAdmin ()
 isSite ()
 __toString ()
- 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 getRouter ($name=null, array $options=array())
- Fonctions membres publiques statiques inherited from JApplication
static getInstance ($client, $config=array(), $prefix= 'J')
static registerEvent ($event, $handler)
static stringURLSafe ($string)
static getHash ($seed)
static isWinOS ()

Attributs privés

 $template = null
 $_language_filter = false
 $_detect_browser = false

Additional Inherited Members

- Attributs publics inherited from JApplication
 $scope = null
 $requestTime = null
 $startTime = null
 $input = null
- Fonctions membres protégées inherited from JApplication
 _createConfiguration ($file)
 _createSession ($name)
- Attributs protégés inherited from JApplication
 $_clientId = null
 $_messageQueue = array()
 $_name = null
- Attributs protégés inherited from JObject
 $_errors = array()
- Attributs protégés statiques inherited from JApplication
static $instances = array()

Documentation des constructeurs et destructeur

JSite::__construct (   $config = array())

Class constructor

Paramètres:
arrayAn optional associative array of configuration settings. Recognized key values include 'clientId' (this list is not meant to be comprehensive).

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

Références $config.


Documentation des fonctions membres

JSite::authorise (   $itemid)

Check if the user can access the application

Références $return, $uri, $url, $user, JRoute\_(), JText\_(), JFactory\getURI(), JFactory\getUser(), et JError\raiseError().

+ Voici le graphe d'appel pour cette fonction :

JSite::authorize (   $itemid)
Obsolète:
1.6 Use the authorise method instead.

Références JLog\add(), et JLog\WARNING.

+ Voici le graphe d'appel pour cette fonction :

JSite::dispatch (   $component = null)

Dispatch the application

Paramètres:
string

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

Références $params, $user, JURI\current(), JRequest\getCmd(), JFactory\getDocument(), JFactory\getLanguage(), JLanguageHelper\getLanguages(), JFactory\getUser(), JPluginHelper\importPlugin(), JROUTER_MODE_SEF, JError\raiseError(), et JComponentHelper\renderComponent().

+ Voici le graphe d'appel pour cette fonction :

JSite::getDetectBrowser ( )

Return the current state of the detect browser option.

Renvoie:
boolean
Depuis:
1.6
JSite::getItems ( )

False method to fool the frontend search plugins

JSite::getLanguageFilter ( )

Return the current state of the language filter.

Renvoie:
boolean
Depuis:
1.6
JSite::getMenu ( )

False method to fool the frontend search plugins

JSite::getMenu (   $name = null,
  $options = array() 
)

Return a reference to the JPathway object.

Paramètres:
string$nameThe name of the application/client.
array$optionsAn optional associative array of configuration settings.
Renvoie:
object JMenu.
Depuis:
1.5

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

Références $menu, et $options.

JSite::getPageParameters (   $option = null)

Get the application parameters

Paramètres:
stringThe component option
Renvoie:
object The parameters object
Depuis:
1.5
JSite::getParams (   $option = null)

Get the appliaction parameters

Paramètres:
stringThe component option
Renvoie:
object The parameters object
Depuis:
1.5

Références $menu, $params, $title, JRequest\getCmd(), JFactory\getLanguage(), JLanguageHelper\getLanguages(), JComponentHelper\getParams(), et JRegistry\loadString().

+ Voici le graphe d'appel pour cette fonction :

JSite::getPathway (   $name = null,
  $options = array() 
)

Return a reference to the JPathway object.

Paramètres:
string$nameThe name of the application.
array$optionsAn optional associative array of configuration settings.
Renvoie:
object JPathway.
Depuis:
1.5

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

Références $options.

static JSite::getRouter (   $name = null,
array  $options = array() 
)
static

Return a reference to the JRouter object.

Paramètres:
string$nameThe name of the application.
array$optionsAn optional associative array of configuration settings.
Renvoie:
JRouter
Depuis:
1.5

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

Références $config, $options, et JFactory\getConfig().

Référencé par JPathwaySite\__construct(), et modMenuHelper\getList().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

JSite::getTemplate (   $params = false)

Get the template

Renvoie:
string The template name
Depuis:
1.0

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

Références $db, $id, $item, $menu, $params, $query, $tag, $template, JText\_(), JFactory\getCache(), JRequest\getCmd(), JFactory\getDbo(), JFilterInput\getInstance(), JRequest\getInt(), JFactory\getLanguage(), JRequest\getVar(), JPATH_THEMES, JRegistry\loadString(), et JError\raiseWarning().

+ Voici le graphe d'appel pour cette fonction :

JSite::initialise (   $options = array())
JSite::login (   $credentials,
  $options = array() 
)

Login authentication function

Paramètres:
arrayArray('username' => string, 'password' => string)
arrayArray('remember' => boolean)
Voir également:
JApplication::login

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

Références $options, et JURI\base().

+ Voici le graphe d'appel pour cette fonction :

JSite::redirect (   $url,
  $msg = '',
  $msgType = 'message',
  $moved = false,
  $persistMsg = true 
)

Redirect to another URL.

Optionally enqueues a message in the system message queue (which will be displayed the next time a page is loaded) using the enqueueMessage method. If the headers have not been sent the redirect will be accomplished using a "301 Moved Permanently" code in the header pointing to the new location. If the headers have already been sent this will be accomplished using a JavaScript statement.

Paramètres:
stringThe URL to redirect to. Can only be http/https URL
stringAn optional message to display on redirect.
stringAn optional message type.
booleanTrue if the page is 301 Permanently Moved, otherwise 303 See Other is assumed.
booleanTrue if the enqueued messages are passed to the redirection, false else.
Renvoie:
none; calls exit().
Depuis:
1.5
Voir également:
JApplication::enqueueMessage()

Références $url.

JSite::render ( )

Display the application.

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

Références $file, $params, $return, $template, $uri, $user, JRequest\getCmd(), JFactory\getDocument(), JFactory\getURI(), JFactory\getUser(), JPluginHelper\importPlugin(), JPATH_THEMES, JResponse\setBody(), et JResponse\setHeader().

+ Voici le graphe d'appel pour cette fonction :

JSite::route ( )

Route the application.

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

Références JRequest\getInt().

+ Voici le graphe d'appel pour cette fonction :

JSite::setDetectBrowser (   $state = false)

Set the current state of the detect browser option.

Renvoie:
boolean The old state
Depuis:
1.6

Références $state.

JSite::setLanguageFilter (   $state = false)

Set the current state of the language filter.

Renvoie:
boolean The old state
Depuis:
1.6

Références $state.

JSite::setTemplate (   $template,
  $styleParams = null 
)

Overrides the default template that would be used

Paramètres:
stringThe template name
mixedThe template style parameters

Références $template, et JPATH_THEMES.


Documentation des données membres

JSite::$_detect_browser = false
private

Option to detect language by the browser

JSite::$_language_filter = false
private

Option to filter by language

JSite::$template = null
private

La documentation de cette classe a été générée à partir des fichiers suivants :