13.6.3.19 Doc::getMultipleRawValues()

13.6.3.19.1 Description

mixed getMultipleRawValues ( string $idAttr,
                             string $def   = "",
                                int $index = - 1 )

La méthode getMultipleRawValues permet d'obtenir les valeurs d'attributs multi-valués.

Les attributs multi-valués peuvent être :

• des attributs déclarés avec l'option multiple=yes ;
• des attributs rattachés à un attribut de type array.

13.6.3.19.1.1 Avertissements

Aucun.

13.6.3.19.2 Liste des paramètres

(string) idAttr

Le nom de l'attribut multi-valué dont on souhaite obtenir les valeurs.

(string) def

def permet de spécifier la valeur par défaut qui sera retournée si l'attribut n'est pas valué.

Par défaut, la valeur par défaut est une chaîne vide.

(int) index

index permet d'obtenir la valeur à un indice (à partir de 0) donné.

Si index est égal à -1, alors toutes les valeurs de l'attribut sont retournées.

Si index est supérieur ou égal au nombre de valeurs, alors la valeur par défaut définie par def est retournée.

13.6.3.19.3 Valeur de retour

La méthode retourne

• la valeur (scalaire) si le paramètres index est différent de -1,
• les valeurs (array) si index vaut -1,
• ou la valeur scalaire par défaut def si l'attribut n'est pas valué.

13.6.3.19.4 Erreurs / Exceptions

Aucune.

13.6.3.19.5 Historique

13.6.3.19.5.1 Release 3.2.5

La méthode getMultipleRawValues remplace la méthode précédemment nommée getTValue.

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

13.6.3.19.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.

  /*
   * Obtenir l'ensemble des valeurs de la colonne `us_group`
   */
  $v = $iuser->getMultipleRawValues(
      \Dcp\AttributeIdentifiers\Iuser::us_group
  );
   
  var_dump($v);

  Résultat :

  array(3) {
    [0]=>
    string(3) "Foo"
    [1]=>
    string(3) "Bar"
    [2]=>
    string(3) "Baz"
  }

• 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.

  /*
   * Obtenir la deuxième valeur de la colonne `us_group`
   * (valeur à l'indice 1)
   */
  $v = $iuser->getMultipleRawValues(
      \Dcp\AttributeIdentifiers\Iuser::us_group,
      "",
      1
  );
   
  var_dump($v);

  Résultat :

  string(3) "Bar"

13.6.3.19.7 Notes

Aucune.

13.6.3.19.8 Voir aussi

• Doc::getArrayRawValues
• Doc::getRawValue