ARRAY_UNSHIFT |
Tableau : Inverse le décalage |
| PHP 4.0+ |
Syntaxe
|
function array_unshift($array,$var);
|
|
function array_unshift($array,$var,...);
|
Paramètres
| Nom |
Description |
| $array |
Ce paramètre permet d'indiquer les tableaux à traiter. |
| $var |
Ce paramètre permet d'indiquer une valeur à rajouter au tableau. |
| ... |
Ces paramètres permettent d'indiquer les autres valeurs à rajouter au tableau. |
Retour
| Valeur |
Description |
| 0 ou supérieur |
Ces valeurs permettent d'indiquer le nombre de cellule que contient le tableau. |
Description
Cette fonction permet d'insérer une cellule du début du tableau sans écrase les autres.
Remarques
- Ajout d'éléments au début d'un tableau : La fonction array_unshift() permet d'ajouter un ou plusieurs éléments au début d'un tableau. Cela modifie
directement le tableau original, en décalant les éléments existants vers la droite pour faire de la place pour les nouveaux éléments ajoutés en tête du tableau.
- Modification du tableau original : Contrairement à d'autres fonctions renvoyant une copie modifiée du tableau, array_unshift() modifie le tableau
directement. Les éléments existants sont réindexés (si le tableau est numéroté) et les nouveaux éléments sont insérés au début du tableau, ce qui peut entraîner un réajustement
des indices pour les tableaux indexés numériquement.
- Retourne la nouvelle taille du tableau : array_unshift() ne renvoie pas le tableau modifié, mais plutôt le nouveau nombre d'éléments dans le tableau après
l'ajout des nouveaux éléments. Cela peut être utile si vous souhaitez connaître la taille du tableau après avoir effectué une insertion au début, mais elle ne renvoie pas le
tableau lui-même.
- Utilisation avec des tableaux associatifs : Lorsqu'elle est utilisée avec des tableaux associatifs, array_unshift() insère les nouveaux éléments au début
du tableau en préservant les clefs associatives des éléments existants. Les nouveaux éléments sont ajoutés avec des clefs numériques, sauf si une clef spécifique est fournie, mais
cela ne modifie pas les clefs des autres éléments du tableau.
- Ajout de plusieurs éléments : array_unshift() accepte plusieurs paramètres après le tableau. Cela signifie que vous pouvez ajouter plusieurs éléments à
la fois au début du tableau, ce qui permet d'insérer efficacement plusieurs valeurs sans avoir à appeler la fonction plusieurs fois.
- Réindexation des clefs numériques : Si vous utilisez array_unshift() sur un tableau avec des indices numériques, les indices des éléments existants sont
réajustés après l'ajout. Par exemple, les éléments d'origine verront leurs indices augmentés pour faire de la place aux nouveaux éléments au début du tableau. Cependant, cette
réindexation ne s'applique pas aux tableaux associatifs, où les clés sont conservées.
- Performances sur de grands tableaux : La fonction array_unshift() peut être coûteuse en termes de performances lorsqu'elle est utilisée sur de grands
tableaux, car tous les éléments du tableau doivent être décalés pour faire de la place pour les nouveaux éléments au début. Cela peut avoir un impact sur la vitesse, notamment
lorsque l'on travaille avec des tableaux volumineux.
- Gestion des tableaux vides : Si la fonction est appelée sur un tableau vide, array_unshift() fonctionne de la même manière et insère les nouveaux éléments
au début du tableau, devenant ainsi le tableau contenant uniquement ces éléments. Si un tableau est vide au départ, l'ajout de nouveaux éléments le rend non vide, et la fonction
renvoie la nouvelle taille du tableau.
Références
PHP 4 - Guide du développeur, Edition First Interactive, Blake Schwendiman, 2002, ISBN: 2-84427-283-5, page 365
Dernière mise à jour : Dimanche, le 22 mars 2015
