13.12.8 SearchAccount::setReturnType()
Permet de choisir le type de retour de l'objet searchAccount. Par défaut, le
retour est une AccountList.
13.12.8.1 Description
void setObjectReturn ( string $type )
Deux types de retour sont possibles soit :
- un objet
DocumentList: la documentList est un itérable sur les documents Dynacase associés aux comptes trouvés, - un objet
AccountList: l'accountList est un itérable sur les objets account.
13.12.8.1.1 Avertissements
Aucun
13.12.8.2 Liste des paramètres
- (string)
type -
Le type est une string qui est au choix entre deux constantes de classe, soit :
- SearchAccount::returnAccount : le retour est alors une accountList,
- SearchAccount::returnDocument : le retour est alors une documentList.
13.12.8.3 Valeur de retour
void
13.12.8.4 Erreurs / Exceptions
Si le type n'est pas une des deux constantes de classe alors une exception de
type Dcp\Sacc\Exception est levée.
13.12.8.5 Historique
Cette méthode remplace la méthode ::setObjectReturn().
13.12.8.6 Exemple
print "Return account \n"; $searchAccount = new SearchAccount(); $searchAccount->setReturnType(SearchAccount::returnAccount); $accountList = $searchAccount->search(); foreach ($accountList as $account) { printf("%s \n", get_class($account)); } print "\n"; print "Return document \n"; $searchAccount = new SearchAccount(); $searchAccount->setReturnType(SearchAccount::returnDocument); $documentList = $searchAccount->search(); foreach ($documentList as $currentDocument) { printf("%s \n", get_class($currentDocument)); }
Résultat :
Return account Account Account Account Account Account Account Account Account Account Account Account Account Account Account
Return document Dcp\Family\Igroup Dcp\Family\Role Dcp\Family\Iuser Dcp\Family\Zoo_gardien Dcp\Family\Role Dcp\Family\Iuser Dcp\Family\Iuser Dcp\Family\Iuser Dcp\Family\Role Dcp\Family\Igroup Dcp\Family\Zoo_veterinaire Dcp\Family\Igroup Dcp\Family\Igroup Dcp\Family\Role
13.12.8.7 Notes
Aucunes