Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe ArrayHelper

Fonctions membres publiques statiques

static toInteger ($array, $default=null)
 
static toObject (array $array, $class='stdClass', $recursive=true)
 
static toString (array $array, $inner_glue='=', $outer_glue=' ', $keepOuterKey=false)
 
static fromObject ($p_obj, $recurse=true, $regex=null)
 
static getColumn (array $array, $valueCol, $keyCol=null)
 
static getValue ($array, $name, $default=null, $type='')
 
static invert (array $array)
 
static isAssociative ($array)
 
static pivot (array $source, $key=null)
 
static sortObjects (array $a, $k, $direction=1, $caseSensitive=true, $locale=false)
 
static arrayUnique (array $array)
 
static arraySearch ($needle, array $haystack, $caseSensitive=true)
 
static flatten ($array, $separator='.', $prefix='')
 

Fonctions membres privées

 __construct ()
 

Fonctions membres privées statiques

static arrayFromObject ($item, $recurse, $regex)
 

Description détaillée

ArrayHelper is an array utility class for doing all sorts of odds and ends with arrays.

Depuis
1.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( )
private

Private constructor to prevent instantiation of this class

Depuis
1.0

Documentation des fonctions membres

◆ arrayFromObject()

static arrayFromObject (   $item,
  $recurse,
  $regex 
)
staticprivate

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
Depuis
1.0

Références $item.

◆ arraySearch()

static arraySearch (   $needle,
array  $haystack,
  $caseSensitive = true 
)
static

An improved array_search that allows for partial matching of strings values in associative arrays.

Paramètres
string$needleThe text to search for within the array.
array$haystackAssociative array to search in to find $needle.
boolean$caseSensitiveTrue to search case sensitive, false otherwise.
Renvoie
mixed Returns the matching array $key if found, otherwise false.
Depuis
1.0

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

◆ arrayUnique()

static arrayUnique ( array  $array)
static

Multidimensional array safe unique test

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

◆ flatten()

static flatten (   $array,
  $separator = '.',
  $prefix = '' 
)
static

Method to recursively convert data to a one dimension array.

Paramètres
array | object$arrayThe array or object to convert.
string$separatorThe key separator.
string$prefixLast level key prefix.
Renvoie
array
Depuis
1.3.0

Références $key, $prefix, $separator, et elseif.

◆ fromObject()

static 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
Depuis
1.0

Référencé par AssociationExtensionHelper\getAssociationList(), et BaseDatabaseModel\loadHistory().

◆ getColumn()

static getColumn ( array  $array,
  $valueCol,
  $keyCol = null 
)
static

Extracts a column from an array of arrays or objects

Paramètres
array$arrayThe source array
string$valueColThe index of the column or name of object property to be used as value It may also be NULL to return complete arrays or objects (this is useful together with $keyCol to reindex the array).
string$keyColThe index of the column or name of object property to be used as key
Renvoie
array Column of values from the source array
Depuis
1.0
Voir également
http://php.net/manual/en/language.types.array.php
http://php.net/manual/en/function.array-column.php

Références $item, $key, $subject, et $value.

Référencé par JAdminCssMenu\check().

◆ getValue()

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

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

Paramètres
array | \ArrayAccess$arrayA named array or object that implements ArrayAccess
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
Depuis
1.0
Exceptions

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

Référencé par NewsfeedsControllerNewsfeed\allowAdd(), AdminModel\batch(), UsersModelUser\batch(), User\bind(), UsersControllerUsers\changeBlock(), JHtmlContentAdministrator\featured(), ModulesModelModule\getForm(), ConfigModelForm\loadForm(), FormModel\loadForm(), ListModel\loadForm(), InstallerControllerUpdatesites\publish(), AdminController\publish(), MenusControllerItems\publish(), MenusControllerItems\setDefault(), et JHtmlMessages\status().

◆ invert()

static invert ( array  $array)
static

Takes an associative array of arrays and inverts the array keys to values using the array values as keys.

Example: $input = array( 'New' => array('1000', '1500', '1750'), 'Used' => array('3000', '4000', '5000', '6000') ); $output = ArrayHelper::invert($input);

Output would be equal to: $output = array( '1000' => 'New', '1500' => 'New', '1750' => 'New', '3000' => 'Used', '4000' => 'Used', '5000' => 'Used', '6000' => 'Used' );

Paramètres
array$arrayThe source array.
Renvoie
array
Depuis
1.0

Références $base, $key, et $return.

◆ isAssociative()

static isAssociative (   $array)
static

Method to determine if an array is an associative array.

Paramètres
array$arrayAn array to test.
Renvoie
boolean
Depuis
1.0

Référencé par Form\bindLevel(), et Ini\objectToString().

◆ pivot()

static pivot ( array  $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
1.0

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

Référencé par LanguageHelper\getContentLanguages(), et LanguageHelper\getInstalledLanguages().

◆ sortObjects()

static sortObjects ( array  $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 an array of keys 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
Depuis
1.0

Références $b, $count, $direction, $i, $key, et elseif.

Référencé par InstallerModel\_getList(), ModulesModelModules\_getList(), LanguageHelper\getContentLanguages(), LanguageHelper\getInstalledLanguages(), ModulesModelSelect\getItems(), ModulesHelper\getModules(), JFormFieldComponents\getOptions(), JFormFieldConfigComponents\getOptions(), JFormFieldComponentsCategory\getOptions(), JFormFieldContentTypes\getOptions(), JHtmlModules\positions(), et JAdminCssMenu\preprocess().

◆ toInteger()

◆ toObject()

static toObject ( array  $array,
  $class = 'stdClass',
  $recursive = true 
)
static

Utility function to map an array to a stdClass object.

Paramètres
array$arrayThe array to map.
string$className of the class to create
boolean$recursiveConvert also any array inside the main array
Renvoie
object
Depuis
1.0

Références $class.

Référencé par InstallationModelFtp\detectFtpRoot(), ContentModelForm\getItem(), LanguagesModelLanguage\getItem(), MenusModelMenu\getItem(), TagsModelTag\getItem(), FinderIndexerAdapter\getItem(), ModulesModelModule\getItem(), AdminModel\getItem(), FinderIndexerAdapter\getItems(), InstallationModelConfiguration\setup(), et InstallationModelFtp\verifyFtpSettings().

◆ toString()

static toString ( array  $array,
  $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
Depuis
1.0

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

Référencé par HeadRenderer\fetchHead(), JHtmlSelect\genericlist(), JHtmlSelect\groupedlist(), HTMLHelper\iframe(), HTMLHelper\image(), HTMLHelper\link(), JHtmlSelect\radiolist(), et JHtmlForm\token().


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