Doc comment

This commit is contained in:
Laurent Destailleur 2016-05-26 21:12:36 +02:00
parent b410aa57b9
commit 97278c254e

View File

@ -1273,11 +1273,11 @@ class Categorie extends CommonObject
* Return list of categories (object instances or labels) linked to element of id $id and type $type * Return list of categories (object instances or labels) linked to element of id $id and type $type
* Should be named getListOfCategForObject * Should be named getListOfCategForObject
* *
* @param int $id Id of element * @param int $id Id of element
* @param string $type Type of category ('customer', 'supplier', 'contact', 'product', 'member'). Old mode (0, 1, 2, ...) is deprecated. * @param string $type Type of category ('customer', 'supplier', 'contact', 'product', 'member'). Old mode (0, 1, 2, ...) is deprecated.
* @param string $mode 'object'=Get array of fetched category instances, 'label'=Get array of category * @param string $mode 'id'=Get array of category ids, 'object'=Get array of fetched category instances, 'label'=Get array of category
* labels, 'id'= Get array of category IDs * labels, 'id'= Get array of category IDs
* @return mixed Array of category objects or < 0 if KO * @return mixed Array of category objects or < 0 if KO
*/ */
function containing($id, $type, $mode='object') function containing($id, $type, $mode='object')
{ {