13.6.3.12 Doc::getArrayRawValues()

13.6.3.12.1 Description

array|bool(false) getArrayRawValues ( string $idAttr,
                                         int $index = -1 )

La méthode getArrayRawValues retourne les valeurs des attributs rattachés à cet attribut de type array, sous la forme d'une liste de lignes composées chacune d'un tableau associatif.

13.6.3.12.1.1 Avertissements

Aucun.

13.6.3.12.2 Liste des paramètres

(string) idAttr

Le nom de l'attribut de type array dont on souhaite obtenir les valeurs.

(int) index

index permet de ne retourner qu'une ligne en particulier en spécifiant l'indice (à partir de 0) de la ligne qu'on souhaite obtenir.

Si index est égal à -1, alors toutes les lignes sont retournées. Si index est supérieur ou égal au nombre de lignes du tableau, alors une ligne vide est retournée.

13.6.3.12.3 Valeur de retour

La méthode retourne le booléen false s'il y a une erreur.

Soit le tableau suivant :

S'il n'y a pas d'erreur, la méthode retourne les lignes sous la forme suivante :

array(
    /* Ligne 1 */
    0 => array(
        'attr_1' => $L1_C1, /* Colonne 1 */
        'attr_2' => $L1_C2, /* Colonne 2 */
        […]
        'attr_N' => $L1_CN  /* Colonne N */
    ),
 
    [...]
 
    /* Ligne M */
    M => array(
        'attr_1' => $LM_C1,
        'attr_2' => $LM_C2,
        […]
        'attr_N' => $LM_CN
    )
)

Si une ligne particulière est demandée (utilisation du paramètre index), alors seule la ligne demandée est retournée :

array(
    'attr_1' => $L1_C1, /* Colonne 1 */
    'attr_2' => $L1_C2, /* Colonne 2 */
    [...]
    'attr_N' => $L1_CN  /* Colonne N */
)

13.6.3.12.4 Erreurs / Exceptions

Une erreur est retournée (false) si :

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

13.6.3.12.5 Historique

13.6.3.12.5.1 Release 3.2.5

La méthode getArrayRawValues remplace la méthode précédemment nommée getAValues.

L'utilisation de getAValues est obsolète depuis la version 3.2.5 de dynacase-core.

13.6.3.12.6 Exemples

• Exemple #1 :

  L'attribut us_groups est de type array, avec les colonnes us_idgroup de type docid("IUSER") et us_group de type text.

  /*
   * Retourner le contenu entier du tableau.
   */
  $v = $iuser->getArrayRawValues(
      \Dcp\AttributeIdentifiers\Iuser::us_groups
  );
   
  var_dump($v);

  Résultat :

  array(3) {
    [0]=>
    array(2) {
      ["us_group"]=>
      string(3) "Foo"
      ["us_idgroup"]=>
      string(4) "1058"
    }
    [1]=>
    array(2) {
      ["us_group"]=>
      string(3) "Bar"
      ["us_idgroup"]=>
      string(4) "1059"
    }
    [2]=>
    array(2) {
      ["us_group"]=>
      string(3) "Baz"
      ["us_idgroup"]=>
      string(4) "1060"
    }
  }

• Exemple #2 :

  L'attribut us_groups est de type array, avec les colonnes us_idgroup de type docid("IUSER") et us_group de type text.

  /*
   * Retourner seulement les valeur de la deuxième ligne
   * (ligne à l'indice 1).
   */
  $v = $iuser->getArrayRawValues(
      \Dcp\AttributeIdentifiers\Iuser::us_groups,
      1
  );
   
  var_dump($v);

  Résultat :

  array(2) {
    ["us_group"]=>
    string(3) "Bar"
    ["us_idgroup"]=>
    string(4) "1059"
  }

13.6.3.12.7 Notes

Aucune.

13.6.3.12.8 Voir aussi

• Doc::getMultipleRawValues