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 JHtml

Liste de tous les membres

Fonctions membres publiques statiques

static _ ($key)
static register ($key, $function)
static unregister ($key)
static isRegistered ($key)
static link ($url, $text, $attribs=null)
static iframe ($url, $name, $attribs=null, $noFrames= '')
static image ($file, $alt, $attribs=null, $relative=false, $path_only=false)
static stylesheet ($file, $attribs=array(), $relative=false, $path_only=false, $detect_browser=true, $detect_debug=true)
static script ($file, $framework=false, $relative=false, $path_only=false, $detect_browser=true, $detect_debug=true)
static core ($debug=null)
static setFormatOptions ($options)
static date ($input= 'now', $format=null, $tz=true, $gregorian=false)
static tooltip ($tooltip, $title= '', $image= 'tooltip.png', $text= '', $href= '', $alt= 'Tooltip', $class= 'hasTip')
static calendar ($value, $name, $id, $format= '%Y-%m-%d', $attribs=null)
static addIncludePath ($path= '')

Attributs publics statiques

static $formatOptions = array('format.depth' => 0, 'format.eol' => "\n", 'format.indent' => "\t")

Fonctions membres protégées statiques

static extract ($key)
static call ($function, $args)
static _includeRelativeFiles ($file, $relative, $detect_browser, $folder)
static includeRelativeFiles ($folder, $file, $relative, $detect_browser, $detect_debug)

Attributs protégés statiques

static $includePaths = array()
static $registry = array()

Documentation des fonctions membres

static JHtml::_ (   $key)
static

Class loader method

Additional arguments may be supplied and are passed to the sub-class. Additional include paths are also able to be specified for third-party use

Paramètres:
string$keyThe name of helper method to load, (prefix).(class).function prefix and class are optional and can be used to load custom html helpers.
Renvoie:
mixed JHtml::call($function, $args) or False on error
Depuis:
11.1

Références $file, $function, $includePaths, $key, $path, call(), JPath\find(), jimport(), JError\raiseError(), register(), et JText\sprintf().

Référencé par ContentController\__construct(), plgContentEmailcloak\_cloak(), plgEditorNone\_displayButtons(), JButtonStandard\_getCommand(), JButtonConfirm\_getCommand(), JElementList\_getOptions(), JElementComponentLayouts\_getOptions(), JHtmlTabs\_loadBehavior(), JHtmlSliders\_loadBehavior(), JPaneTabs\_loadBehavior(), JPaneSliders\_loadBehavior(), JHtmlBatch\access(), JHtmlList\accesslevel(), JHtmlJGrid\action(), RedirectModelLink\activate(), JHtmlUsers\addNote(), CategoriesViewCategory\addToolbar(), CategoriesViewCategories\addToolbar(), JHtmlRules\assetFormWidget(), JHtmlAccess\assetgrouplist(), MenusHtmlMenus\association(), JHtmlSelect\booleanlist(), JHtmlIcons\button(), JHtmlIcons\buttons(), plgUserProfile\calendar(), JHtmlBehavior\caption(), JHtmlCategory\categories(), JHtmlList\category(), JHtmlBanner\clients(), JHtmlLanguages\clients(), JHtmlBehavior\combobox(), core(), JHtmlIcon\create(), JHtmlFilter\dates(), MediaViewImages\display(), MediaViewImagesList\display(), MediaViewMedia\display(), MediaViewMediaList\display(), SearchViewSearch\display(), ContentViewArchive\display(), CategoriesViewCategories\display(), ContactViewCategory\display(), ContactViewContact\display(), JoomlaupdateViewUpdate\display(), ContentViewArticles\display(), JoomlaupdateViewDefault\display(), FinderViewSearch\display(), FinderViewIndexer\display(), MenusViewItems\display(), ContactViewFeatured\display(), InstallerViewDefault\display(), ContentController\display(), LanguagesViewOverride\display(), plgSystemDebug\displayMemoryUsage(), JHtmlIcon\edit(), JHtmlIcon\email(), JHtmlContentAdministrator\featured(), JHtmlContact\featured(), JButtonPopup\fetchButton(), JElementArticle\fetchElement(), JElementAuthor\fetchElement(), JElementContact\fetchElement(), JElementNewsfeed\fetchElement(), JElementRadio\fetchElement(), JElementSQL\fetchElement(), JElementTemplateStyle\fetchElement(), JElementUserGroup\fetchElement(), JElementMenu\fetchElement(), JElementFilelist\fetchElement(), JElementCategory\fetchElement(), JElementFolderlist\fetchElement(), JElementHelpsites\fetchElement(), JElementEditors\fetchElement(), JElementMenuItem\fetchElement(), JElementTimezones\fetchElement(), JElementLanguages\fetchElement(), JElementCalendar\fetchElement(), JElementList\fetchElement(), JHtmlUsers\filterNotes(), JHtmlBehavior\formvalidation(), JHtmlBehavior\framework(), JHtmlList\genericordering(), UsersHelper\getActiveOptions(), ModulesHelper\getAssignmentOptions(), CacheHelper\getClientOptions(), TemplatesHelper\getClientOptions(), ModulesHelper\getClientOptions(), BannersHelper\getClientOptions(), MediaModelManager\getFolderList(), JFormFieldGroupedList\getGroups(), JFormFieldMenuItem\getGroups(), JFormFieldTemplateStyle\getGroups(), JFormFieldTimezone\getGroups(), JFormFieldModal_Newsfeeds\getInput(), JFormFieldClient\getInput(), JFormFieldModal_Article\getInput(), JFormFieldModal_Contacts\getInput(), JFormFieldGroup\getInput(), JFormFieldOrdering\getInput(), JFormFieldType\getInput(), JFormFieldMenutype\getInput(), JFormFieldModulePosition\getInput(), JFormFieldUser\getInput(), JFormFieldColor\getInput(), JFormFieldUsergroup\getInput(), JFormFieldList\getInput(), JFormFieldPassword\getInput(), JFormFieldCombo\getInput(), JFormFieldModuleLayout\getInput(), JFormFieldComponentLayout\getInput(), JFormFieldCalendar\getInput(), JFormFieldRules\getInput(), JFormFieldAccessLevel\getInput(), JFormFieldMedia\getInput(), JFormFieldGroupedList\getInput(), JFormFieldTos\getLabel(), modLoginHelper\getLanguageList(), UsersHelperDebug\getLevelsOptions(), JPagination\getLimitBox(), modArticlesNewsHelper\getList(), modArticlesCategoryHelper\getList(), modStatsHelper\getList(), JoomlaupdateHelperSelect\getMethods(), JFormFieldSample\getOptions(), JFormFieldCategoryEdit\getOptions(), JFormFieldSearchFilter\getOptions(), JFormFieldSQL\getOptions(), JFormFieldSessionHandler\getOptions(), JFormFieldCacheHandler\getOptions(), JFormFieldContentLanguage\getOptions(), JFormFieldInteger\getOptions(), JFormFieldFolderList\getOptions(), JFormFieldDirectories\getOptions(), JFormFieldMenu\getOptions(), JFormFieldCategory\getOptions(), JFormFieldFileList\getOptions(), JFormFieldList\getOptions(), JFormFieldRadio\getOptions(), JFormFieldCheckboxes\getOptions(), ModulesHelper\getPositions(), UsersHelper\getRangeOptions(), modSearchHelper\getSearchImage(), ModulesHelper\getStateOptions(), MessagesHelper\getStateOptions(), UsersHelper\getStateOptions(), JHtmlUser\groups(), JHtmlList\images(), JHtmlSelect\integerlist(), JHtmlBatch\item(), JHtmlBatch\language(), JHtmlAccess\level(), JHtmlMenu\linkoptions(), JHtmlFinder\mapslist(), JHtmlMenu\menuitemlist(), JHtmlMenu\menuitems(), JHtmlBehavior\modal(), modChrome_sliders(), modChrome_tabs(), JHtmlBehavior\multiselect(), JHtmlUsers\notes(), PlgSystemHighlight\onAfterDispatch(), plgSystemDebug\onAfterDispatch(), plgContentVote\onContentBeforeDisplay(), plgContentPagebreak\onContentPrepare(), plgButtonPagebreak\onDisplay(), plgButtonImage\onDisplay(), plgButtonArticle\onDisplay(), plgEditorCodemirror\onInit(), plgCaptchaRecaptcha\onInit(), JHtmlCategory\options(), JPagination\orderDownIcon(), JHtmlMenu\ordering(), JHtmlList\ordering(), JPagination\orderUpIcon(), JHtmlBanner\pinned(), JHtmlModules\positions(), JHtmlList\positions(), JHtmlIcon\print_popup(), JHtmlIcon\print_screen(), JHtmlLanguages\published(), JHtmlRedirect\published(), RedirectHelper\publishedOptions(), JHtmlLanguages\publishedOptions(), JHtmlDate\relative(), script(), JHtmlFilter\select(), modBreadCrumbsHelper\setSeparator(), JHtmlMessages\state(), InstallerHtmlManage\state(), JHtmlModules\state(), MenusHtmlMenus\state(), JHtmlFinder\statelist(), PluginsHelper\stateOptions(), JHtmlBehavior\switcher(), JHtmlModules\templates(), JHtmlModules\templateStates(), JHtmlTemplates\thumb(), JHtmlBehavior\tree(), modArticlesCategoryHelper\truncate(), JHtmlModules\types(), JHtmlFinder\typeslist(), plgUserProfile\url(), JHtmlBatch\user(), JHtmlAccess\usergroup(), et JHtmlList\users().

+ Voici le graphe d'appel pour cette fonction :

static JHtml::_includeRelativeFiles (   $file,
  $relative,
  $detect_browser,
  $folder 
)
staticprotected

Compute the files to be include

Paramètres:
string$filepath to file
boolean$relativepath to file is relative to /media folder
boolean$detect_browserdetect browser to include specific browser files
string$folderfolder name to search into (images, css, js, ...)
Renvoie:
array files to be included
Voir également:
JBrowser
Depuis:
11.1
Obsolète:
12.1

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

+ Voici le graphe d'appel pour cette fonction :

static JHtml::addIncludePath (   $path = '')
static

Add a directory where JHtml should search for helpers. You may either pass a string or an array of directories.

Paramètres:
string$pathA path to search.
Renvoie:
array An array with directory elements
Depuis:
11.1

Références $includePaths, $path, JPath\clean(), et jimport().

Référencé par ModulesViewModules\display(), UsersViewUsers\display(), FinderViewFilters\display(), FinderViewSearch\display(), FinderViewFilter\display(), InstallerViewManage\display(), FinderViewIndex\display(), FinderViewMaps\display(), BannersViewBanners\display(), UsersViewNote\display(), et UsersViewNotes\display().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

static JHtml::calendar (   $value,
  $name,
  $id,
  $format = '%Y-%m-%d',
  $attribs = null 
)
static

Displays a calendar control field

Paramètres:
string$valueThe date value
string$nameThe name of the text field
string$idThe id of the text field
string$formatThe date format
array$attribsAdditional HTML attributes
Renvoie:
string HTML markup for a calendar field
Depuis:
11.1

Références $attribs, $disabled, $id, $name, JText\_(), JFactory\getDocument(), JFactory\getLanguage(), null, et JArrayHelper\toString().

Référencé par JHtmlFilter\dates().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

static JHtml::call (   $function,
  $args 
)
staticprotected

Function caller method

Paramètres:
string$functionFunction or method to call
array$argsArguments to be passed to function
Renvoie:
mixed Function result or false on error.
Voir également:
http://php.net/manual/en/function.call-user-func-array.php
Depuis:
11.1

Références $function, JText\_(), et JError\raiseError().

Référencé par _().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

static JHtml::core (   $debug = null)
static

Add the /media/system/js/core Javascript file.

Paramètres:
boolean$debugTrue if debugging is enabled.
Renvoie:
void
Depuis:
11.1
Obsolète:
12.1 Use JHtml::_('behavior.framework'); instead.

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

+ Voici le graphe d'appel pour cette fonction :

static JHtml::date (   $input = 'now',
  $format = null,
  $tz = true,
  $gregorian = false 
)
static

Returns formated date according to a given format and time zone.

Paramètres:
string$inputString in a format accepted by date(), defaults to "now".
string$formatFormat optional format for strftime
mixed$tzTime zone to be used for the date. Special cases: boolean true for user setting, boolean false for server setting.
boolean$gregorianTrue to use Gregorian calenar
Renvoie:
string A date translated by the given format and time zone.
Voir également:
strftime
Depuis:
11.1

Références $config, $date, $user, JText\_(), elseif, JFactory\getConfig(), JFactory\getDate(), JFactory\getLanguage(), JFactory\getUser(), et null.

Référencé par FinderViewSearch\display().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

static JHtml::extract (   $key)
staticprotected

Method to extract a key

Paramètres:
string$keyThe name of helper method to load, (prefix).(class).function prefix and class are optional and can be used to load custom html helpers.
Renvoie:
array Contains lowercase key, prefix, file, function.
Depuis:
11.1

Références $file, $key, et $parts.

static JHtml::iframe (   $url,
  $name,
  $attribs = null,
  $noFrames = '' 
)
static

Write a <iframe></iframe> element

Paramètres:
string$urlThe relative URL to use for the src attribute
string$nameThe target attribute to use
array$attribsAn associative array of attributes to add
string$noFramesThe message to display if the iframe tag is not supported
Renvoie:
string <iframe></iframe> element or message if not supported
Depuis:
11.1

Références $attribs, $name, $url, et JArrayHelper\toString().

+ Voici le graphe d'appel pour cette fonction :

static JHtml::image (   $file,
  $alt,
  $attribs = null,
  $relative = false,
  $path_only = false 
)
static

Write a element

Paramètres:
string$fileThe relative or absolute URL to use for the src attribute
string$altThe alt text.
string$attribsThe target attribute to use
array$relativeAn associative array of attributes to add
boolean$path_onlyIf set to true, it tries to find an override for the file in the template
Renvoie:
string
Depuis:
11.1

Références $attribs, $file, null, et JArrayHelper\toString().

+ Voici le graphe d'appel pour cette fonction :

static JHtml::includeRelativeFiles (   $folder,
  $file,
  $relative,
  $detect_browser,
  $detect_debug 
)
staticprotected

Compute the files to be include

Paramètres:
string$folderfolder name to search into (images, css, js, ...)
string$filepath to file
boolean$relativepath to file is relative to /media folder
boolean$detect_browserdetect browser to include specific browser files
boolean$detect_debugdetect debug to include compressed files if debug is on
Renvoie:
array files to be included
Voir également:
JBrowser
Depuis:
11.1

Références $app, $extension, $file, $files, $template, JURI\base(), elseif, JFactory\getApplication(), JFactory\getConfig(), JFile\getExt(), JBrowser\getInstance(), JPATH_ROOT, JPATH_THEMES, JURI\root(), et JFile\stripExt().

+ Voici le graphe d'appel pour cette fonction :

static JHtml::isRegistered (   $key)
static

Test if the key is registered.

Paramètres:
string$keyThe name of the key
Renvoie:
boolean True if the key is registered.
Depuis:
11.1

Références $key.

Référencé par plgUserProfile\onContentPrepareData().

+ Voici le graphe des appelants de cette fonction :

static JHtml::link (   $url,
  $text,
  $attribs = null 
)
static

Write a element

Paramètres:
string$urlThe relative URL to use for the href attribute
string$textThe target attribute to use
array$attribsAn associative array of attributes to add
Renvoie:
string string
Depuis:
11.1

Références $attribs, $text, $url, et JArrayHelper\toString().

+ Voici le graphe d'appel pour cette fonction :

static JHtml::register (   $key,
  $function 
)
static

Registers a function to be called with a specific key

Paramètres:
string$keyThe name of the key
string$functionFunction or method
Renvoie:
boolean True if the function is callable
Depuis:
11.1

Références $function, et $key.

Référencé par _(), et plgUserProfile\onContentPrepareData().

+ Voici le graphe des appelants de cette fonction :

static JHtml::script (   $file,
  $framework = false,
  $relative = false,
  $path_only = false,
  $detect_browser = true,
  $detect_debug = true 
)
static

Write a <script></script> element

Paramètres:
string$filepath to file
boolean$frameworkload the JS framework
boolean$relativepath to file is relative to /media folder
boolean$path_onlyreturn the path to the file only
boolean$detect_browserdetect browser to include specific browser js files
boolean$detect_debugdetect debug to search for compressed files if debug is on
Renvoie:
mixed nothing if $path_only is false, null, path or array of path if specific js browser files were detected
Voir également:
JHtml::stylesheet
Depuis:
11.1

Références $file, _(), JLog\add(), elseif, JFactory\getDocument(), null, et JLog\WARNING.

Référencé par FinderViewIndexer\display(), et JHtmlFilter\slider().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

static JHtml::setFormatOptions (   $options)
static

Set format related options.

Updates the formatOptions array with all valid values in the passed array. See {

Voir également:
JHtml::$formatOptions} for details.
Paramètres:
array$optionsOption key/value pairs.
Renvoie:
void
Depuis:
11.1

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

static JHtml::stylesheet (   $file,
  $attribs = array(),
  $relative = false,
  $path_only = false,
  $detect_browser = true,
  $detect_debug = true 
)
static

Write a <link rel="stylesheet" style="text/css"> element

Paramètres:
string$filepath to file
array$attribsattributes to be added to the stylesheet
boolean$relativepath to file is relative to /media folder
boolean$path_onlyreturn the path to the file only
boolean$detect_browserdetect browser to include specific browser css files will try to include file, file_*browser*, file_*browser*_*major*, file_*browser*_*major*_*minor*
Navigator browser

major.minor

Safari 3.0.x konqueror 522.x
Safari 3.1.x and 3.2.x konqueror 525.x
Safari 4.0 to 4.0.2 konqueror 530.x
Safari 4.0.3 to 4.0.4 konqueror 531.x
iOS 4.0 Safari konqueror 532.x
Safari 5.0 konqueror

533.x

Google Chrome 1.0 konqueror 528.x
Google Chrome 2.0 konqueror 530.x
Google Chrome 3.0 and 4.x konqueror 532.x
Google Chrome 5.0 konqueror

533.x

Internet Explorer 5.5 msie 5.5
Internet Explorer 6.x msie 6.x
Internet Explorer 7.x msie 7.x
Internet Explorer 8.x msie

8.x

Firefox mozilla 5.0
a lot of others
boolean$detect_debugdetect debug to search for compressed files if debug is on
Renvoie:
mixed nothing if $path_only is false, null, path or array of path if specific css browser files were detected
Voir également:
JBrowser
Depuis:
11.1

Références $attribs, $file, JLog\add(), elseif, JFactory\getDocument(), null, et JLog\WARNING.

Référencé par JHtmlFilter\dates(), FinderViewIndexer\display(), JHtmlFilter\select(), et JHtmlFilter\slider().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

static JHtml::tooltip (   $tooltip,
  $title = '',
  $image = 'tooltip.png',
  $text = '',
  $href = '',
  $alt = 'Tooltip',
  $class = 'hasTip' 
)
static

Creates a tooltip with an image as button

Paramètres:
string$tooltipThe tip string
mixed$titleThe title of the tooltip or an associative array with keys contained in {'title','image','text','href','alt'} and values corresponding to parameters of the same name.
string$imageThe image for the tip, if no text is provided
string$textThe text for the tip
string$hrefAn URL that will be used to create the link
string$altThe alt attribute for img tag
string$classCSS class for the tool tip
Renvoie:
string
Depuis:
11.1

Références $class, $image, $text, $title, image, et null.

static JHtml::unregister (   $key)
static

Removes a key for a method from registry.

Paramètres:
string$keyThe name of the key
Renvoie:
boolean True if a set key is unset
Depuis:
11.1

Références $key.


Documentation des données membres

JHtml::$formatOptions = array('format.depth' => 0, 'format.eol' => "\n", 'format.indent' => "\t")
static
JHtml::$includePaths = array()
staticprotected

Référencé par _(), et addIncludePath().

JHtml::$registry = array()
staticprotected

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