Méthode Categories_management :: Change_category_visibility
Change_category_visibility
Change_category_visibility — Change la visibilité d'une catégorie
Cette méthode de la classe Categories_management permet de changer la visibilité dune catégorie. La visibilité est à prendre au sens de publié ou non, vous pourrez utiliser comme vous le souhaitez cette valeur dans votre module.
Voici les arguments que cette méthode admet :
Cette méthode ne renverra pas d'erreur si la catégorie a déjà le statut que vous souhaitez lui associer.
Dans votre script vous aurez certainement besoin de vérifier que la catégorie est visible, il faudra tester la valeur booléenne visible qui est représentée par un entier dans la base de données et qu'il faudra donc passer en booléen dans le cache comme ceci :
Cette méthode renvoie vrai si le changement d'état a été effectué avec succès, et faux sinon. Si le changement a échoué, vous pourrez savoir quelle erreur s'est produite en utilisant la méthode Check_error.
Nous allons voir les sources possibles d'erreur (utilisez la méthode Check_error pour savoir quelle erreur s'est produite). Voici les constantes que vous pouvez tester dans ce cas et ce à quoi elles correspondent (très utile pour le débuggage) :
Change_category_visibility — Change la visibilité d'une catégorie
Description
Code PHP :
bool Change_category_visibility(int $category_id, $visibility], $generate_cache[)
Cette méthode de la classe Categories_management permet de changer la visibilité dune catégorie. La visibilité est à prendre au sens de publié ou non, vous pourrez utiliser comme vous le souhaitez cette valeur dans votre module.
Voici les arguments que cette méthode admet :
- $category_id correspond à l'identifiant de la catégorie dont il faut changer le statut
- $visibility prendra la valeur CAT_VISIBLE pour la rendre visible et CAT_UNVISIBLE pour la masquer.
- $generate_cache indique si il faut ou pas régénérer le cache suite à cette modification. Par défaut il sera régénéré (LOAD_CACHE), pour ne pas le charger, passer DO_NOT_LOAD_CACHE).
Cette méthode ne renverra pas d'erreur si la catégorie a déjà le statut que vous souhaitez lui associer.
Dans votre script vous aurez certainement besoin de vérifier que la catégorie est visible, il faudra tester la valeur booléenne visible qui est représentée par un entier dans la base de données et qu'il faudra donc passer en booléen dans le cache comme ceci :
Code PHP :
//Transtypage forcé d'entier à booléen $cache['visible'] = (int)$base_de_donnees['visible'];
Valeur de retour
Cette méthode renvoie vrai si le changement d'état a été effectué avec succès, et faux sinon. Si le changement a échoué, vous pourrez savoir quelle erreur s'est produite en utilisant la méthode Check_error.
Différentes sources d'erreurs
Nous allons voir les sources possibles d'erreur (utilisez la méthode Check_error pour savoir quelle erreur s'est produite). Voici les constantes que vous pouvez tester dans ce cas et ce à quoi elles correspondent (très utile pour le débuggage) :
- CATEGORY_DOES_NOT_EXIST : la catégorie dont vous souhaitez changer le statut n'existe pas
- NEW_STATUS_UNKNOWN : le statut que vous souhaitez assigner à la catégorie est inconnu par le gestionnaire de catégories.
Voir aussi
- Check_error : permet de déterminer quelle est la dernière erreur survenue