13.6.3.31 Doc::removeArrayRow()

13.6.3.31.1 Description

string removeArrayRow ( string $idAttr,
                           int $index )

La méthode removeArrayRow permet de supprimer une ligne à un indice donnée dans un attribut de type array.

La ligne supprimée entraîne un décalage des lignes d'indice supérieur, qui descendent alors toutes d'un cran.

13.6.3.31.1.1 Avertissements

Lors de chaque appel à removeArrayRow, un setValue est effectué pour chacune des colonnes de l'array. Pour supprimer de nombreuses lignes, il peut être plus efficace de gérer manuellement la suppression dans chaque colonne.

13.6.3.31.2 Liste des paramètres

(string) idAttr

Le nom de l'attribut de type array dans lequel on souhaite supprimer une ligne.

(int) index

index permet de spécifier l'indice (à partir de 0) de la ligne qu'on souhaite supprimer.

Si index est inférieur à 0 ou supérieur ou égal au nombre de lignes du tableau, alors le tableau n'est pas modifié et reste inchangé.

13.6.3.31.3 Valeur de retour

La méthode retourne une chaîne vide s'il n'y a pas d'erreur, ou une chaîne non-vide contenant le message d'erreur dans le cas contraire.

13.6.3.31.4 Erreurs / Exceptions

Une erreur est retournée si :

• l'attribut idAttr n'est pas de type array.

13.6.3.31.5 Historique

Aucun.

13.6.3.31.6 Exemples

• Exemple #1

  /* Soit le tableau `MyPhoto::faces` composé comme suit :
   
     +-----------+----------+
     | Firstname | Lastname |
     +===========+==========+
  #0 | Bart      | Simpson  |
  #1 | Marge     | Simpson  |
  #2 | Lisa      | Simpson  |
  #3 | Homer     | Simpson  |
     +-----------+----------+
  */
   
  $photo->removeArrayRow(\Dcp\AttributeIdentifier\MyPhoto::faces, 0)
   
  /* Après la suppression de la première ligne (indice 0) :
   
     +-----------+----------+
     | Firstname | Lastname |
     +===========+==========+
  #0 | Marge     | Simpson  |
  #1 | Lisa      | Simpson  |
  #2 | Homer     | Simpson  |
     +-----------+----------+
  */
   
  $photo->removeArrayRow(\Dcp\AttributeIdentifier\MyPhoto::faces, 1)
   
  /* Après la suppression de la ligne entre Marge et Homer (indice 1) :
   
     +-----------+----------+
     | Firstname | Lastname |
     +===========+==========+
  #0 | Marge     | Simpson  |
  #1 | Homer     | Simpson  |
     +-----------+----------+
  */

13.6.3.31.7 Notes

Aucune.

13.6.3.31.8 Voir aussi

• Doc::clearArrayValues
• Doc::addArrayRow