From db732ddeddcfd3c6ae4d6ea56f5790eeb690d42e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20FRANCE?= Date: Wed, 17 Oct 2018 20:36:45 +0200 Subject: [PATCH] code comment --- htdocs/categories/class/categorie.class.php | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/htdocs/categories/class/categorie.class.php b/htdocs/categories/class/categorie.class.php index 15cb254ed7d..a9432234793 100644 --- a/htdocs/categories/class/categorie.class.php +++ b/htdocs/categories/class/categorie.class.php @@ -10,6 +10,7 @@ * Copyright (C) 2015 Marcos García * Copyright (C) 2015 Raphaël Doursenaud * Copyright (C) 2016 Charlie Benke + * Copyright (C) 2018 Frédéric France * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -805,7 +806,7 @@ class Categorie extends CommonObject * @param string $sortorder Sort order * @param int $limit Limit for list * @param int $page Page number - * @return array Array of categories + * @return array|int Array of categories, 0 if no cat, -1 on error */ function getListForItem($id, $type='customer', $sortfield = "s.rowid", $sortorder = 'ASC', $limit = 0, $page = 0) { @@ -974,7 +975,7 @@ class Categorie extends CommonObject * @param string $type Type of categories ('customer', 'supplier', 'contact', 'product', 'member') or (0, 1, 2, ...). * @param int $markafterid Removed all categories including the leaf $markafterid in category tree. * - * @return array Array of categories. this->cats and this->motherof are set. + * @return array|int Array of categories. this->cats and this->motherof are set, -1 on error */ function get_full_arbo($type, $markafterid=0) { @@ -1126,7 +1127,7 @@ class Categorie extends CommonObject * * @param int $type Type of category (0, 1, ...) * @param boolean $parent Just parent categories if true - * @return array Table of Object Category + * @return array|int Table of Object Category, -1 on error */ function get_all_categories($type=null, $parent=false) { @@ -1441,7 +1442,7 @@ class Categorie extends CommonObject * @param string $type Type of category ('member', 'customer', 'supplier', 'product', 'contact'). Old mode (0, 1, 2, ...) is deprecated. * @param boolean $exact Exact string search (true/false) * @param boolean $case Case sensitive (true/false) - * @return array Array of category id + * @return array|int Array of category id, -1 if error */ function rechercher($id, $nom, $type, $exact = false, $case = false) {