$myAppliz->me(string $action, array $fields, ?array $options): array|object
Avec le paramètre get
cette méthode retourne les données de l'utilisateur connecté
via la méthode $myAppliz->login()
.
Si l'utilisateur n'est pas connecté un array ou object vide est retourné.
$myAppliz->me(string $action, array $keys_vals): bool
Avec le paramètre store
cette méthode permet de sauvegarder des informations sur
l'utilisateur connecté.
Elle retourne true
en cas de succès et false
en
cas d'erreur.
Paramètres | Description | ||||||
---|---|---|---|---|---|---|---|
action string
|
Les actions disponibles.
|
||||||
fields array
|
Liste des données à retourner. | ||||||
keys_vals array
|
Un tableau de données d'utilisateur personnalisées à ajouter, remplacer ou supprimer.
|
||||||
options array
|
Options (facultatif). |
Fields | Description | ||||
---|---|---|---|---|---|
id string
|
L'identifiant de l'utilisateur. Cet identifiant est unique par Appliz et ne peut pas être utilisé par une autre. | ||||
first_name string
|
Le prénom de l'utilisateur. | ||||
last_name string
|
Le nom de famille de l'utilisateur. | ||||
gender string
|
Le genre de l'utilisateur.
|
||||
perms array|object
|
Liste des permissions accordées par l'utilisateur.
|
||||
birthday array|object
|
La date de naissance et l'age de l'utilisateur.
|
||||
register_time array|object
|
La date d'inscription.
|
||||
user string
|
L'identifiant myAppliz de l'utilisateur (qui n'est pas unique par Appliz). Permet par exemple de repérer un utilisateur qui s'est désinscrit puis ré-inscrit à votre Appliz. |
||||
perso_{$var} string|int|float|array|object|bool
|
Un champ personnalisé définit via le paramètre store . |
Options | Description |
---|---|
datetime_format string
|
Format des dates.
Cette option est prioritaire sur le paramètre général de la configuration.
Valeur par défaut : c |
Exemple
Cet exemple sous-entend que l'utilisateur est déjà connecté via la méthode $myAppliz->login()
.
try
{
$me = $myAppliz->me('get', ['id', 'first_name', 'last_name', 'gender', 'perms', 'birthday']);
}
catch(Exception $e)
{
error_log('Erreur API myAppliz : '.$e->getMessage());
echo 'Une erreur s\'est produite, veuillez réessayer ultérieurement.';
exit();
}
echo '<pre>'. htmlspecialchars(print_r($me, true)) .'</pre>';
Résultat :
Array
(
[id] => 5f54a4eef845d309f1048384
[first_name] => alexis
[last_name] => bonnyaud
[gender] => male
[perms] => Array
(
[0] => send_mail
[1] => send_sms
)
[birthday] => Array
(
[datetime] => 1996-02-18T00:00:00+00:00
[age] => 28 )
)
Exemple
Cet exemple sous-entend que l'utilisateur est déjà connecté via la méthode $myAppliz->login()
.
$me = $myAppliz->me('get', ['first_name', 'birthday']);
// Comme dans l'exemple précédent vous pouvez ajouter un bloc try/catch pour gérer les erreurs.
if(!empty($me))
{
$me['first_name'] = htmlspecialchars($me['first_name']);
// Sécurité contre les injections XSS
$me['first_name'] = ucfirst($me['first_name']);
// Pour mettre une majuscule à la première lettre du prénom
echo 'Bonjour '. $me['first_name'] .', vous avez '. $me['birthday']['age'] .' ans.';
}
Résultat :
Bonjour Alexis, vous avez 28 ans.
Exemple
Cet exemple sous-entend que l'utilisateur est déjà connecté via la méthode $myAppliz->login()
.
$store = $myAppliz->me('store', [
'description' => 'Homines enim eruditos et sobrios ut infaustos.',
// créer ou modifie le champ « perso_description »
'dates.search' => '20/12/2021',
// créer ou modifie le champ « perso_dates['search'] »
'settings' => [
'menu1' => 'open',
'menu2' => 'open',
'locale' => 'fr',
],
// créer ou modifie le champ « perso_settings »
'settings.menu2' => 'close',
// créer ou modifie le champ « perso_settings['menu2'] »
'$unset' => ['credits', 'bio', 'dates.login']
// supprime les champs « perso_credits », « perso_bio » et « perso_dates['login'] »
]);
// vous pouvez ajouter un bloc try/catch pour gérer les erreurs.
if($store) // vérifie si l'opération store s'est bien passée
{
$me = $myAppliz->me('get', ['first_name', 'last_name', 'perso_description', 'perso_settings', 'perso_dates', 'perso_credits']);
echo '<pre>'. htmlspecialchars(print_r($me, true)) .'</pre>';
}
Résultat :
Array
(
[first_name] => alexis
[last_name] => bonnyaud
[perso_description] => Homines enim eruditos et sobrios ut infaustos.
[perso_settings] => Array
(
[menu1] => open
[menu2] => close
[locale] => fr
)
[perso_dates] => Array
(
[search] => 20/12/2021
)
)