diff --git a/htdocs/accountancy/class/html.formventilation.class.php b/htdocs/accountancy/class/html.formventilation.class.php index d6f5ce17404..e9d65943eac 100644 --- a/htdocs/accountancy/class/html.formventilation.class.php +++ b/htdocs/accountancy/class/html.formventilation.class.php @@ -18,30 +18,35 @@ */ /** - * \file htdocs/accountancy/class/html.formventilation.class.php - * \ingroup Accounting Expert - * \brief Class for HML form + * \file htdocs/accountancy/class/html.formventilation.class.php + * \ingroup Accounting Expert + * \brief File of class with all html predefined components */ -class FormVentilation extends Form { + +/** + * Class to manage generation of HTML components for bank module + */ +class FormVentilation extends Form +{ var $db; var $error; /** - * Constructor - * - * @param DoliDB $db handler - */ - function __construct($db) { - $this->db = $db; - return 1; - } - + * Constructor + * + * @param DoliDB $db Database handler + */ + public function __construct($db) + { + $this->db = $db; + } + /** - * Return select filter with date of transaction + * Return select filter with date of transaction * - * @param string $htmlname of input - * @param string $selectedkey value - * @return string select input + * @param string $htmlname Name of select field + * @param string $selectedkey Value + * @return string HTML edit field */ function select_bookkeeping_importkey($htmlname = 'importkey', $selectedkey) { global $langs; @@ -83,15 +88,17 @@ class FormVentilation extends Form { } /** - * Return list of the accounts with label + * Return list of accounts with label by chart of accounts * - * @param string $selectedid pcg_type - * @param string $htmlname of combo list - * @param int $showempty en empty line - * - * @return string with HTML select + * @param string $selectedid Preselected chart of accounts + * @param string $htmlname Name of field in html form + * @param int $showempty Add an empty field + * @param array $events Event options + * + * @return string String with HTML select */ - function select_account($selectid, $htmlname = 'account', $showempty = 0, $event = array()) { + function select_account($selectid, $htmlname = 'account', $showempty = 0, $event = array()) + { global $conf, $user, $langs; $out = ''; @@ -142,15 +149,17 @@ class FormVentilation extends Form { } /** - * Return list of pcg with label + * Return list of accounts with label by class of accounts * - * @param string $selectedid pcg_type - * @param string $htmlname of combo list - * @param int $showempty en empty line - * - * @return string with HTML select + * @param string $selectedid Preselected pcg_type + * @param string $htmlname Name of field in html form + * @param int $showempty Add an empty field + * @param array $events Event options + * + * @return string String with HTML select */ - function select_pcgtype($selectid, $htmlname = 'pcg_type', $showempty = 0, $event = array()) { + function select_pcgtype($selectid, $htmlname = 'pcg_type', $showempty = 0, $event = array()) + { global $conf, $user, $langs; $out = ''; @@ -194,15 +203,17 @@ class FormVentilation extends Form { } /** - * Return subtype list of pcg with label + * Return list of accounts with label by sub_class of accounts * - * @param string $selectedid pcg_type - * @param string $htmlname of combo list - * @param int $showempty en empty line - * - * @return string with HTML select + * @param string $selectedid Preselected pcg_type + * @param string $htmlname Name of field in html form + * @param int $showempty Add an empty field + * @param array $events Event options + * + * @return string String with HTML select */ - function select_pcgsubtype($selectid, $htmlname = 'pcg_subtype', $showempty = 0, $event = array()) { + function select_pcgsubtype($selectid, $htmlname = 'pcg_subtype', $showempty = 0, $event = array()) + { global $conf, $user, $langs; $out = '';