add phpdoc (#31562)

* add phpdoc

* add phpdoc

* add phpdoc

* add phpdoc

* add phpdoc
This commit is contained in:
Frédéric FRANCE 2024-10-26 13:02:00 +02:00 committed by GitHub
parent 701fbcc15a
commit e0c1b067d8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 34 additions and 21 deletions

View File

@ -274,7 +274,7 @@ function invoice_rec_prepare_head($object)
$obj = $db->fetch_object($resql);
$nbFacture = $obj->nb;
} else {
dol_syslog('Failed to count facture with facture_rec '.$db->lasterror(), LOG_ERR);
dol_syslog('Failed to count invoices with invoice model '.$db->lasterror(), LOG_ERR);
}
if ($nbFacture > 0) {
$head[$h][1] .= '<span class="badge marginleftonlyshort">'.$nbFacture.'</span>';
@ -391,7 +391,7 @@ function supplier_invoice_rec_prepare_head($object)
$obj = $db->fetch_object($resql);
$nbFactureFourn = $obj->nb;
} else {
dol_syslog('Failed to count facture with facture fournisseur model '.$db->lasterror(), LOG_ERR);
dol_syslog('Failed to count invoices with supplier invoice model '.$db->lasterror(), LOG_ERR);
}
if ($nbFactureFourn > 0) {
$head[$h][1] .= '<span class="badge marginleftonlyshort">'.$nbFactureFourn.'</span>';

View File

@ -1,14 +1,14 @@
<?php
/* Copyright (c) 2005 Rodolphe Quiedeville <rodolphe@quiedeville.org>
* Copyright (c) 2005-2018 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (c) 2005-2018 Regis Houssin <regis.houssin@inodbox.com>
* Copyright (C) 2012 Florian Henry <florian.henry@open-concept.pro>
* Copyright (C) 2014 Juanjo Menent <jmenent@2byte.es>
* Copyright (C) 2014 Alexis Algoud <alexis@atm-consulting.fr>
* Copyright (C) 2018 Nicolas ZABOURI <info@inovea-conseil.com>
/* Copyright (c) 2005 Rodolphe Quiedeville <rodolphe@quiedeville.org>
* Copyright (c) 2005-2018 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (c) 2005-2018 Regis Houssin <regis.houssin@inodbox.com>
* Copyright (C) 2012 Florian Henry <florian.henry@open-concept.pro>
* Copyright (C) 2014 Juanjo Menent <jmenent@2byte.es>
* Copyright (C) 2014 Alexis Algoud <alexis@atm-consulting.fr>
* Copyright (C) 2018 Nicolas ZABOURI <info@inovea-conseil.com>
* Copyright (C) 2019 Abbes Bahfir <dolipar@dolipar.org>
* Copyright (C) 2023-2024 Frédéric France <frederic.france@free.fr>
* Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
* Copyright (C) 2023-2024 Frédéric France <frederic.france@free.fr>
* Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
*
* 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
@ -93,15 +93,28 @@ class UserGroup extends CommonObject
public $note;
/**
* @var User[]
* @var User[] Array of users
*/
public $members = array(); // Array of users
public $members = array();
public $nb_rights; // Number of rights granted to the user
public $nb_users; // Number of users in the group
/**
* @var int Number of rights granted to the user
*/
public $nb_rights;
public $rights; // Permissions of the group
/**
* @var int Number of users in the group
*/
public $nb_users;
/**
* @var stdClass Permissions of the group
*/
public $rights;
/**
* @var array<string,int> Cache array of already loaded permissions
*/
private $_tab_loaded = array(); // Array of cache of already loaded permissions
/**

View File

@ -1,5 +1,5 @@
<?php
/* Copyright (C) 2006-2016 Laurent Destailleur <eldy@users.sourceforge.net>
/* Copyright (C) 2006-2016 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
* Copyright (C) 2024 Frédéric France <frederic.france@free.fr>
*
@ -324,7 +324,7 @@ $server->register(
/**
* Get produt or service
*
* @param array $authentication Array of authentication information
* @param array{login:string,password:string,entity:?int,dolibarrkey:string} $authentication Array of authentication information
* @param int $id Id of object
* @param string $ref Ref of object
* @param string $ref_ext Ref external of object
@ -417,7 +417,7 @@ function getUser($authentication, $id, $ref = '', $ref_ext = '')
/**
* getListOfGroups
*
* @param array $authentication Array of authentication information
* @param array{login:string,password:string,entity:?int,dolibarrkey:string} $authentication Array of authentication information
* @return array Array result
*/
function getListOfGroups($authentication)
@ -485,7 +485,7 @@ function getListOfGroups($authentication)
/**
* Create an external user with thirdparty and contact
*
* @param array $authentication Array of authentication information
* @param array{login:string,password:string,entity:?int,dolibarrkey:string} $authentication Array of authentication information
* @param array $thirdpartywithuser Datas
* @return mixed
*/
@ -684,7 +684,7 @@ function createUserFromThirdparty($authentication, $thirdpartywithuser)
/**
* Set password of an user
*
* @param array $authentication Array of authentication information
* @param array{login:string,password:string,entity:?int,dolibarrkey:string} $authentication Array of authentication information
* @param array $shortuser Array of login/password info
* @return mixed
*/