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 JArrayHelper

Liste de tous les membres

Fonctions membres publiques statiques

static toInteger (&$array, $default=null)
static toObject (&$array, $class= 'stdClass')
static toString ($array=null, $inner_glue= '=', $outer_glue= ' ', $keepOuterKey=false)
static fromObject ($p_obj, $recurse=true, $regex=null)
static getColumn (&$array, $index)
static getValue (&$array, $name, $default=null, $type= '')
static isAssociative ($array)
static pivot ($source, $key=null)
static sortObjects (&$a, $k, $direction=1, $caseSensitive=true, $locale=false)
static arrayUnique ($myArray)

Fonctions membres protégées statiques

static _fromObject ($item, $recurse, $regex)
static _sortObjects (&$a, &$b)

Attributs protégés statiques

static $sortCase
static $sortDirection
static $sortKey
static $sortLocale

Documentation des fonctions membres

static JArrayHelper::_fromObject (   $item,
  $recurse,
  $regex 
)
staticprotected

Utility function to map an object or array to an array

Paramètres:
mixed$itemThe source object or array
boolean$recurseTrue to recurse through multi-level objects
string$regexAn optional regular expression to match on field names
Renvoie:
array The array mapped from the given object
Depuis:
11.1

Références $item, et elseif.

static JArrayHelper::_sortObjects ( $a,
$b 
)
staticprotected

Callback function for sorting an array of objects on a key

Paramètres:
array&$aAn array of objects
array&$bAn array of objects
Renvoie:
integer Comparison status
Voir également:
JArrayHelper::sortObjects()
Depuis:
11.1

Références $count, $direction, $i, $key, elseif, JString\strcasecmp(), et JString\strcmp().

+ Voici le graphe d'appel pour cette fonction :

static JArrayHelper::arrayUnique (   $myArray)
static

Multidimensional array safe unique test

Paramètres:
array$myArrayThe array to make unique.
Renvoie:
array
Voir également:
http://php.net/manual/en/function.array-unique.php
Depuis:
11.2

Référencé par JUpdater\arrayUnique(), et JUpdater\findUpdates().

+ Voici le graphe des appelants de cette fonction :

static JArrayHelper::fromObject (   $p_obj,
  $recurse = true,
  $regex = null 
)
static

Utility function to map an object to an array

Paramètres:
object$p_objThe source object
boolean$recurseTrue to recurse through multi-level objects
string$regexAn optional regular expression to match on field names
Renvoie:
array The array mapped from the given object
Depuis:
11.1

Références null.

Référencé par plgSystemDebug\displaySession(), ConfigModelApplication\getData(), UsersModelRemind\processRemindRequest(), ConfigModelApplication\removeroot(), et ConfigModelApplication\save().

+ Voici le graphe des appelants de cette fonction :

static JArrayHelper::getColumn ( $array,
  $index 
)
static

Extracts a column from an array of arrays or objects

Paramètres:
array&$arrayThe source array
string$indexThe index of the column or name of object property
Renvoie:
array Column of values from the source array
Depuis:
11.1

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

Référencé par MenusModelMenus\getItems().

+ Voici le graphe des appelants de cette fonction :

static JArrayHelper::getValue ( $array,
  $name,
  $default = null,
  $type = '' 
)
static

Utility function to return a value from a named array or a specified default

Paramètres:
array&$arrayA named array
string$nameThe key to search for
mixed$defaultThe default value to give if no key found
string$typeReturn type for the variable (INT, FLOAT, STRING, WORD, BOOLEAN, ARRAY)
Renvoie:
mixed The value from the source array
Depuis:
11.1

Références $name, $type, et null.

Référencé par plgContentGeshi\_replace(), ContactControllerContact\allowAdd(), WeblinksControllerWeblink\allowAdd(), NewsfeedsControllerNewsfeed\allowAdd(), BannersControllerBanner\allowAdd(), ContentControllerArticle\allowAdd(), ContactModelContact\batch(), BannersModelBanner\batch(), ModulesModelModule\batch(), MenusModelItem\batch(), JModelAdmin\batch(), UsersModelUser\batch(), MenusModelItem\batchCopy(), CategoriesModelCategory\batchCopy(), MenusModelItem\batchMove(), JUser\bind(), UsersControllerUsers\changeBlock(), JHtmlContentAdministrator\featured(), JHtmlContact\featured(), ContactControllerContacts\featured(), ContentControllerArticles\featured(), PluginsModelPlugin\getForm(), TemplatesModelStyle\getForm(), ModulesModelModule\getForm(), MenusModelItem\getForm(), JFormFieldMenutype\getInput(), modArticlesLatestHelper\getList(), JModelForm\loadForm(), plgUserProfile\onUserAfterDelete(), plgUserProfile\onUserAfterSave(), InstallerControllerManage\publish(), JControllerAdmin\publish(), JHtmlRedirect\published(), MenusControllerItems\setDefault(), JHtmlMessages\state(), JHtmlNewsfeed\state(), et BannersControllerBanners\sticky_publish().

+ Voici le graphe des appelants de cette fonction :

static JArrayHelper::isAssociative (   $array)
static

Method to determine if an array is an associative array.

Paramètres:
array$arrayAn array to test.
Renvoie:
boolean True if the array is an associative array.
Depuis:
11.1

Référencé par JForm\bind(), JRegistry\bindData(), et JForm\bindLevel().

+ Voici le graphe des appelants de cette fonction :

static JArrayHelper::pivot (   $source,
  $key = null 
)
static

Pivots an array to create a reverse lookup of an array of scalars, arrays or objects.

Paramètres:
array$sourceThe source array.
string$keyWhere the elements of the source array are objects or arrays, the key to pivot on.
Renvoie:
array An array of arrays pivoted either on the value of the keys, or an individual key of an object or array.
Depuis:
11.3

Références $counter, $key, et elseif.

static JArrayHelper::sortObjects ( $a,
  $k,
  $direction = 1,
  $caseSensitive = true,
  $locale = false 
)
static

Utility function to sort an array of objects on a given field

Paramètres:
array&$aAn array of objects
mixed$kThe key (string) or a array of key to sort on
mixed$directionDirection (integer) or an array of direction to sort in [1 = Ascending] [-1 = Descending]
mixed$caseSensitiveBoolean or array of booleans to let sort occur case sensitive or insensitive
mixed$localeBoolean or array of booleans to let sort occur using the locale language or not
Renvoie:
array The sorted array of objects
Depuis:
11.1

Références $direction, et null.

Référencé par InstallerModel\_getList(), PluginsModelPlugins\_getList(), ModulesModelModules\_getList(), ContentModelCategory\getChildren(), UsersHelperDebug\getComponents(), ModMenuHelper\getComponents(), CacheModelCache\getData(), ModulesModelSelect\getItems(), et ModulesHelper\getModules().

+ Voici le graphe des appelants de cette fonction :

static JArrayHelper::toInteger ( $array,
  $default = null 
)
static

Function to convert array to integer values

Paramètres:
array&$arrayThe source array to convert
mixed$defaultA default value (int|array) to assign if $array is not an array
Renvoie:
void
Depuis:
11.1

Références $i, elseif, et null.

Référencé par RedirectControllerLinks\activate(), RedirectModelLink\activate(), ContactModelContact\batch(), BannersModelBanner\batch(), ModulesModelModule\batch(), MenusModelItem\batch(), JModelAdmin\batch(), UsersModelUser\batch(), MenusModelItem\batchMove(), CategoriesModelCategory\batchMove(), UsersModelUser\batchUser(), JTableUser\bind(), JHtmlCategory\categories(), UsersControllerLevel\delete(), MenusControllerMenus\delete(), CategoriesControllerCategories\delete(), JControllerAdmin\delete(), MenusModelMenu\delete(), InstallerModelDiscover\discover_install(), TemplatesControllerStyles\duplicate(), ModulesControllerModules\duplicate(), ContentModelArticle\featured(), ContactModelContact\featured(), JElementAuthor\fetchElement(), JForm\filterField(), FinderModelSearch\getExcludedLinkIds(), FinderIndexerQuery\getExcludedTermIds(), JAccess\getGroupsByUser(), FinderIndexerQuery\getIncludedTermIds(), BannersModelBanners\getListQuery(), ContactModelContacts\getListQuery(), ContentModelArticles\getListQuery(), JFormFieldCategoryEdit\getOptions(), ModFinderHelper\getQuery(), FinderIndexerQuery\getRequiredTermIds(), JAccess\getUsersByGroup(), InstallerControllerLanguages\install(), JHtmlCategory\options(), UsersModelUsers\populateState(), FinderModelSearch\populateState(), FinderIndexerQuery\processDynamicTaxonomy(), FinderIndexerQuery\processStaticTaxonomy(), BannersTableClient\publish(), FinderTableMap\publish(), MessagesTableMessage\publish(), UsersTableNote\publish(), FinderTableFilter\publish(), JTableExtension\publish(), WeblinksTableWeblink\publish(), JControllerAdmin\publish(), BannersTableBanner\publish(), JTableContent\publish(), JTableNested\publish(), JTable\publish(), InstallerControllerManage\refresh(), InstallerControllerManage\remove(), FinderControllerFilter\save(), TemplatesModelStyle\save(), JControllerAdmin\saveorder(), TemplatesControllerStyles\setDefault(), MenusControllerItems\setDefault(), JUserHelper\setUserGroups(), BannersTableBanner\stick(), JInstallerModule\uninstall(), TemplatesControllerStyles\unsetDefault(), et InstallerControllerUpdate\update().

static JArrayHelper::toObject ( $array,
  $class = 'stdClass' 
)
static
static JArrayHelper::toString (   $array = null,
  $inner_glue = '=',
  $outer_glue = ' ',
  $keepOuterKey = false 
)
static

Utility function to map an array to a string.

Paramètres:
array$arrayThe array to map.
string$inner_glueThe glue (optional, defaults to '=') between the key and the value.
string$outer_glueThe glue (optional, defaults to ' ') between array elements.
boolean$keepOuterKeyTrue if final key should be kept.
Renvoie:
string The string mapped from the given array
Depuis:
11.1

Références $item, $key, et $output.

Référencé par JHtmlImage\administrator(), JHtml\calendar(), JDocumentRendererHead\fetchHead(), JHtmlSelect\genericlist(), modSyndicateHelper\getLink(), ContentModelArticles\getListQuery(), JHtmlSelect\groupedlist(), JHtml\iframe(), JHtml\image(), JHtml\link(), JHtmlSelect\options(), JHtmlSelect\radiolist(), et JHtmlImage\site().

+ Voici le graphe des appelants de cette fonction :


Documentation des données membres

JArrayHelper::$sortCase
staticprotected
JArrayHelper::$sortDirection
staticprotected
JArrayHelper::$sortKey
staticprotected
JArrayHelper::$sortLocale
staticprotected

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