diff --git a/htdocs/core/boxes/box_actions.php b/htdocs/core/boxes/box_actions.php index d8a9548f73d..267d238d5ce 100644 --- a/htdocs/core/boxes/box_actions.php +++ b/htdocs/core/boxes/box_actions.php @@ -52,8 +52,10 @@ class box_actions extends ModeleBoxes { } /** - * Charge les donnees en memoire pour affichage ulterieur - * @param $max Nombre maximum d'enregistrements a charger + * Load data for box to show them later + * + * @param int $max Maximum number of records to load + * @return void */ function loadBox($max=5) { @@ -146,6 +148,13 @@ class box_actions extends ModeleBoxes { } } + /** + * Method to show box + * + * @param array $head Array with properties of box title + * @param array $contents Array with properties of box lines + * @return void + */ function showBox($head = null, $contents = null) { parent::showBox($this->info_box_head, $this->info_box_contents); diff --git a/htdocs/core/boxes/box_bookmarks.php b/htdocs/core/boxes/box_bookmarks.php index aa31aa3cf7d..89352d908aa 100644 --- a/htdocs/core/boxes/box_bookmarks.php +++ b/htdocs/core/boxes/box_bookmarks.php @@ -37,7 +37,7 @@ class box_bookmarks extends ModeleBoxes { var $info_box_contents = array(); /** - * \brief Constructeur de la classe + * Constructor */ function box_bookmarks() { @@ -48,8 +48,10 @@ class box_bookmarks extends ModeleBoxes { } /** - * \brief Charge les donnees en memoire pour affichage ulterieur - * \param $max Nombre maximum d'enregistrements a charger + * Load data for box to show them later + * + * @param int $max Maximum number of records to load + * @return void */ function loadBox($max=5) { @@ -121,6 +123,13 @@ class box_bookmarks extends ModeleBoxes { } } + /** + * Method to show box + * + * @param array $head Array with properties of box title + * @param array $contents Array with properties of box lines + * @return void + */ function showBox($head = null, $contents = null) { parent::showBox($this->info_box_head, $this->info_box_contents); diff --git a/htdocs/core/boxes/box_clients.php b/htdocs/core/boxes/box_clients.php index c9db0650c43..509641b7570 100644 --- a/htdocs/core/boxes/box_clients.php +++ b/htdocs/core/boxes/box_clients.php @@ -40,7 +40,7 @@ class box_clients extends ModeleBoxes { var $info_box_contents = array(); /** - * \brief Constructeur de la classe + * Constructor */ function box_clients() { @@ -51,8 +51,10 @@ class box_clients extends ModeleBoxes { } /** - * Load data of box into memory for a future usage - * @param $max Maximum number of records to show + * Load data for box to show them later + * + * @param int $max Maximum number of records to load + * @return void */ function loadBox($max=5) { @@ -125,6 +127,13 @@ class box_clients extends ModeleBoxes { } + /** + * Method to show box + * + * @param array $head Array with properties of box title + * @param array $contents Array with properties of box lines + * @return void + */ function showBox($head = null, $contents = null) { parent::showBox($this->info_box_head, $this->info_box_contents); diff --git a/htdocs/core/boxes/box_commandes.php b/htdocs/core/boxes/box_commandes.php index 8aac9fada59..74da5a9ab39 100644 --- a/htdocs/core/boxes/box_commandes.php +++ b/htdocs/core/boxes/box_commandes.php @@ -40,7 +40,7 @@ class box_commandes extends ModeleBoxes { var $info_box_contents = array(); /** - * \brief Constructeur de la classe + * Constructor */ function box_commandes() { @@ -51,8 +51,10 @@ class box_commandes extends ModeleBoxes { } /** - * \brief Charge les donnees en memoire pour affichage ulterieur - * \param $max Nombre maximum d'enregistrements a charger + * Load data for box to show them later + * + * @param int $max Maximum number of records to load + * @return void */ function loadBox($max=5) { @@ -134,6 +136,13 @@ class box_commandes extends ModeleBoxes { } } + /** + * Method to show box + * + * @param array $head Array with properties of box title + * @param array $contents Array with properties of box lines + * @return void + */ function showBox($head = null, $contents = null) { parent::showBox($this->info_box_head, $this->info_box_contents); diff --git a/htdocs/core/boxes/box_comptes.php b/htdocs/core/boxes/box_comptes.php index d2267e11562..f988017338a 100644 --- a/htdocs/core/boxes/box_comptes.php +++ b/htdocs/core/boxes/box_comptes.php @@ -54,7 +54,8 @@ class box_comptes extends ModeleBoxes { /** * Load data into info_box_contents array to show array later. * - * @param $max Maximum number of records to load + * @param int $max Maximum number of records to load + * @return void */ function loadBox($max=5) { @@ -147,6 +148,13 @@ class box_comptes extends ModeleBoxes { } + /** + * Method to show box + * + * @param array $head Array with properties of box title + * @param array $contents Array with properties of box lines + * @return void + */ function showBox($head = null, $contents = null) { parent::showBox($this->info_box_head, $this->info_box_contents); diff --git a/htdocs/core/boxes/box_contacts.php b/htdocs/core/boxes/box_contacts.php index 0371e821d22..98c43b14f96 100755 --- a/htdocs/core/boxes/box_contacts.php +++ b/htdocs/core/boxes/box_contacts.php @@ -41,7 +41,7 @@ class box_contacts extends ModeleBoxes { var $info_box_contents = array(); /** - * \brief Constructeur de la classe + * Constructor */ function box_contacts() { @@ -52,8 +52,10 @@ class box_contacts extends ModeleBoxes { } /** - * Load data of box into memory for a future usage - * @param $max Maximum number of records to show + * Load data into info_box_contents array to show array later. + * + * @param int $max Maximum number of records to load + * @return void */ function loadBox($max=5) { @@ -123,6 +125,13 @@ class box_contacts extends ModeleBoxes { } + /** + * Method to show box + * + * @param array $head Array with properties of box title + * @param array $contents Array with properties of box lines + * @return void + */ function showBox($head = null, $contents = null) { parent::showBox($this->info_box_head, $this->info_box_contents); diff --git a/htdocs/core/boxes/box_contracts.php b/htdocs/core/boxes/box_contracts.php index de4a2347f2d..f92494b100a 100644 --- a/htdocs/core/boxes/box_contracts.php +++ b/htdocs/core/boxes/box_contracts.php @@ -54,6 +54,7 @@ class box_contracts extends ModeleBoxes { * Load data for box to show them later * * @param int $max Maximum number of records to load + * @return void */ function loadBox($max=5) { @@ -144,6 +145,13 @@ class box_contracts extends ModeleBoxes { } } + /** + * Method to show box + * + * @param array $head Array with properties of box title + * @param array $contents Array with properties of box lines + * @return void + */ function showBox($head = null, $contents = null) { parent::showBox($this->info_box_head, $this->info_box_contents); diff --git a/htdocs/core/boxes/box_external_rss.php b/htdocs/core/boxes/box_external_rss.php index dfaf342f5e8..9d4e59358b4 100644 --- a/htdocs/core/boxes/box_external_rss.php +++ b/htdocs/core/boxes/box_external_rss.php @@ -42,7 +42,7 @@ class box_external_rss extends ModeleBoxes { var $info_box_contents = array(); /** - * Constructeur de la classe + * Constructor */ function box_external_rss($DB,$param) { @@ -56,10 +56,11 @@ class box_external_rss extends ModeleBoxes { } /** - * Load information for box into memory to show them later with this->showBox method. - * - * @param int $max Max numbe rof records to load - * @param int $cachedelay Delay we accept for cache file + * Load data into info_box_contents array to show array later. + * + * @param int $max Maximum number of records to load + * @param int $cachedelay Delay we accept for cache file + * @return void */ function loadBox($max=5, $cachedelay=3600) { @@ -152,6 +153,13 @@ class box_external_rss extends ModeleBoxes { } + /** + * Method to show box + * + * @param array $head Array with properties of box title + * @param array $contents Array with properties of box lines + * @return void + */ function showBox($head = null, $contents = null) { parent::showBox($this->info_box_head, $this->info_box_contents); diff --git a/htdocs/core/boxes/box_factures.php b/htdocs/core/boxes/box_factures.php index b7359c19932..f801afb650f 100644 --- a/htdocs/core/boxes/box_factures.php +++ b/htdocs/core/boxes/box_factures.php @@ -39,7 +39,7 @@ class box_factures extends ModeleBoxes { var $info_box_contents = array(); /** - * \brief Constructeur de la classe + * Constructor */ function box_factures() { @@ -50,8 +50,10 @@ class box_factures extends ModeleBoxes { } /** - * \brief Charge les donnees en memoire pour affichage ulterieur - * \param $max Nombre maximum d'enregistrements a charger + * Load data into info_box_contents array to show array later. + * + * @param int $max Maximum number of records to load + * @return void */ function loadBox($max=5) { @@ -149,6 +151,13 @@ class box_factures extends ModeleBoxes { } } + /** + * Method to show box + * + * @param array $head Array with properties of box title + * @param array $contents Array with properties of box lines + * @return void + */ function showBox($head = null, $contents = null) { parent::showBox($this->info_box_head, $this->info_box_contents); diff --git a/htdocs/core/boxes/box_factures_fourn.php b/htdocs/core/boxes/box_factures_fourn.php index 5cbb0af5cd9..365c3a12a7f 100644 --- a/htdocs/core/boxes/box_factures_fourn.php +++ b/htdocs/core/boxes/box_factures_fourn.php @@ -39,7 +39,7 @@ class box_factures_fourn extends ModeleBoxes { var $info_box_contents = array(); /** - * \brief Constructeur de la classe + * Constructor */ function box_factures_fourn() { @@ -50,8 +50,10 @@ class box_factures_fourn extends ModeleBoxes { } /** - * \brief Charge les donnees en memoire pour affichage ulterieur - * \param $max Nombre maximum d'enregistrements a charger + * Load data into info_box_contents array to show array later. + * + * @param int $max Maximum number of records to load + * @return void */ function loadBox($max=5) { @@ -143,6 +145,13 @@ class box_factures_fourn extends ModeleBoxes { } } + /** + * Method to show box + * + * @param array $head Array with properties of box title + * @param array $contents Array with properties of box lines + * @return void + */ function showBox($head = null, $contents = null) { parent::showBox($this->info_box_head, $this->info_box_contents); diff --git a/htdocs/core/boxes/box_factures_fourn_imp.php b/htdocs/core/boxes/box_factures_fourn_imp.php index 61363d2bcac..3a9a48bedbd 100644 --- a/htdocs/core/boxes/box_factures_fourn_imp.php +++ b/htdocs/core/boxes/box_factures_fourn_imp.php @@ -39,7 +39,7 @@ class box_factures_fourn_imp extends ModeleBoxes { /** - * \brief Constructeur de la classe + * Constructor */ function box_factures_fourn_imp() { @@ -50,8 +50,10 @@ class box_factures_fourn_imp extends ModeleBoxes { } /** - * \brief Charge les donnees en memoire pour affichage ulterieur - * \param $max Nombre maximum d'enregistrements a charger + * Load data into info_box_contents array to show array later. + * + * @param int $max Maximum number of records to load + * @return void */ function loadBox($max=5) { @@ -143,6 +145,13 @@ class box_factures_fourn_imp extends ModeleBoxes { } + /** + * Method to show box + * + * @param array $head Array with properties of box title + * @param array $contents Array with properties of box lines + * @return void + */ function showBox($head = null, $contents = null) { parent::showBox($this->info_box_head, $this->info_box_contents); diff --git a/htdocs/core/boxes/box_factures_imp.php b/htdocs/core/boxes/box_factures_imp.php index 57b0e2cb722..7eeac19a248 100644 --- a/htdocs/core/boxes/box_factures_imp.php +++ b/htdocs/core/boxes/box_factures_imp.php @@ -42,7 +42,7 @@ class box_factures_imp extends ModeleBoxes { /** - * \brief Constructeur de la classe + * Constructor */ function box_factures_imp() { @@ -53,8 +53,10 @@ class box_factures_imp extends ModeleBoxes { } /** - * \brief Charge les donnees en memoire pour affichage ulterieur - * \param $max Nombre maximum d'enregistrements a charger + * Load data into info_box_contents array to show array later. + * + * @param int $max Maximum number of records to load + * @return void */ function loadBox($max=5) { @@ -145,6 +147,13 @@ class box_factures_imp extends ModeleBoxes { } } + /** + * Method to show box + * + * @param array $head Array with properties of box title + * @param array $contents Array with properties of box lines + * @return void + */ function showBox($head = null, $contents = null) { parent::showBox($this->info_box_head, $this->info_box_contents); diff --git a/htdocs/core/boxes/box_fournisseurs.php b/htdocs/core/boxes/box_fournisseurs.php index e93f60a84c3..9c02cab8462 100644 --- a/htdocs/core/boxes/box_fournisseurs.php +++ b/htdocs/core/boxes/box_fournisseurs.php @@ -39,7 +39,7 @@ class box_fournisseurs extends ModeleBoxes { var $info_box_contents = array(); /** - * \brief Constructeur de la classe + * Constructor */ function box_fournisseurs() { @@ -50,8 +50,10 @@ class box_fournisseurs extends ModeleBoxes { } /** - * Load data of box into memory for a future usage - * @param $max Maximum number of records to show + * Load data into info_box_contents array to show array later. + * + * @param int $max Maximum number of records to load + * @return void */ function loadBox($max=5) { @@ -119,6 +121,13 @@ class box_fournisseurs extends ModeleBoxes { } + /** + * Method to show box + * + * @param array $head Array with properties of box title + * @param array $contents Array with properties of box lines + * @return void + */ function showBox($head = null, $contents = null) { parent::showBox($this->info_box_head, $this->info_box_contents); diff --git a/htdocs/core/boxes/box_members.php b/htdocs/core/boxes/box_members.php index 8b3cc143b33..094ccd07a98 100755 --- a/htdocs/core/boxes/box_members.php +++ b/htdocs/core/boxes/box_members.php @@ -40,7 +40,7 @@ class box_members extends ModeleBoxes { var $info_box_contents = array(); /** - * \brief Constructeur de la classe + * Constructor */ function box_members() { @@ -51,8 +51,10 @@ class box_members extends ModeleBoxes { } /** - * Load data of box into memory for a future usage - * @param $max Maximum number of records to show + * Load data into info_box_contents array to show array later. + * + * @param int $max Maximum number of records to load + * @return void */ function loadBox($max=5) { @@ -121,6 +123,13 @@ class box_members extends ModeleBoxes { } + /** + * Method to show box + * + * @param array $head Array with properties of box title + * @param array $contents Array with properties of box lines + * @return void + */ function showBox($head = null, $contents = null) { parent::showBox($this->info_box_head, $this->info_box_contents); diff --git a/htdocs/core/boxes/box_osc_client.php b/htdocs/core/boxes/box_osc_client.php index a2a539f22ac..a784a0c8774 100644 --- a/htdocs/core/boxes/box_osc_client.php +++ b/htdocs/core/boxes/box_osc_client.php @@ -39,7 +39,7 @@ class box_osc_clients extends ModeleBoxes { var $info_box_contents = array(); /** - * \brief Constructeur de la classe + * Constructor */ function box_osc_clients() { @@ -50,8 +50,10 @@ class box_osc_clients extends ModeleBoxes { } /** - * \brief Charge les donn�es en m�moire pour affichage ult�rieur - * \param $max Nombre maximum d'enregistrements � charger + * Load data into info_box_contents array to show array later. + * + * @param int $max Maximum number of records to load + * @return void */ function loadBox($max=5) { @@ -97,6 +99,13 @@ class box_osc_clients extends ModeleBoxes { } + /** + * Method to show box + * + * @param array $head Array with properties of box title + * @param array $contents Array with properties of box lines + * @return void + */ function showBox($head = null, $contents = null) { parent::showBox($this->info_box_head, $this->info_box_contents); diff --git a/htdocs/core/boxes/box_produits.php b/htdocs/core/boxes/box_produits.php index 711ee033a8c..5c125cf421e 100644 --- a/htdocs/core/boxes/box_produits.php +++ b/htdocs/core/boxes/box_produits.php @@ -42,7 +42,7 @@ class box_produits extends ModeleBoxes { /** - * \brief Constructeur de la classe + * Constructor */ function box_produits() { @@ -53,8 +53,10 @@ class box_produits extends ModeleBoxes { } /** - * \brief Charge les donnees en memoire pour affichage ulterieur - * \param $max Nombre maximum d'enregistrements a charger + * Load data into info_box_contents array to show array later. + * + * @param int $max Maximum number of records to load + * @return void */ function loadBox($max=5) { @@ -154,6 +156,13 @@ class box_produits extends ModeleBoxes { } } + /** + * Method to show box + * + * @param array $head Array with properties of box title + * @param array $contents Array with properties of box lines + * @return void + */ function showBox($head = null, $contents = null) { parent::showBox($this->info_box_head, $this->info_box_contents); diff --git a/htdocs/core/boxes/box_propales.php b/htdocs/core/boxes/box_propales.php index 91bc157ea80..4752e0ffc70 100644 --- a/htdocs/core/boxes/box_propales.php +++ b/htdocs/core/boxes/box_propales.php @@ -41,7 +41,7 @@ class box_propales extends ModeleBoxes { /** - * \brief Constructeur de la classe + * Constructor */ function box_propales() { @@ -52,8 +52,10 @@ class box_propales extends ModeleBoxes { } /** - * \brief Charge les donnees en memoire pour affichage ulterieur - * \param $max Nombre maximum d'enregistrements a charger + * Load data into info_box_contents array to show array later. + * + * @param int $max Maximum number of records to load + * @return void */ function loadBox($max=5) { @@ -139,6 +141,13 @@ class box_propales extends ModeleBoxes { } } + /** + * Method to show box + * + * @param array $head Array with properties of box title + * @param array $contents Array with properties of box lines + * @return void + */ function showBox($head = null, $contents = null) { parent::showBox($this->info_box_head, $this->info_box_contents); diff --git a/htdocs/core/boxes/box_prospect.php b/htdocs/core/boxes/box_prospect.php index 3e4c3c67a0b..69bb2444008 100644 --- a/htdocs/core/boxes/box_prospect.php +++ b/htdocs/core/boxes/box_prospect.php @@ -42,7 +42,7 @@ class box_prospect extends ModeleBoxes { var $info_box_contents = array(); /** - * \brief Constructeur de la classe + * Constructor */ function box_prospect($DB,$param) { @@ -56,8 +56,10 @@ class box_prospect extends ModeleBoxes { } /** - * \brief Charge les donnees en memoire pour affichage ulterieur - * \param $max Nombre maximum d'enregistrements a charger + * Load data into info_box_contents array to show array later. + * + * @param int $max Maximum number of records to load + * @return void */ function loadBox($max=5) { @@ -132,6 +134,13 @@ class box_prospect extends ModeleBoxes { } } + /** + * Method to show box + * + * @param array $head Array with properties of box title + * @param array $contents Array with properties of box lines + * @return void + */ function showBox($head = null, $contents = null) { parent::showBox($this->info_box_head, $this->info_box_contents); diff --git a/htdocs/core/boxes/box_services_expired.php b/htdocs/core/boxes/box_services_expired.php index dc030a46a5a..895fa7713a2 100644 --- a/htdocs/core/boxes/box_services_expired.php +++ b/htdocs/core/boxes/box_services_expired.php @@ -54,6 +54,7 @@ class box_services_expired extends ModeleBoxes { * Load data for box to show them later * * @param int $max Maximum number of records to load + * @return void */ function loadBox($max=5) { @@ -141,7 +142,14 @@ class box_services_expired extends ModeleBoxes { } } - function showBox() + /** + * Method to show box + * + * @param array $head Array with properties of box title + * @param array $contents Array with properties of box lines + * @return void + */ + function showBox($head = null, $contents = null) { parent::showBox($this->info_box_head, $this->info_box_contents); } diff --git a/htdocs/core/boxes/box_services_vendus.php b/htdocs/core/boxes/box_services_vendus.php index 067deee6d1f..477cb6383f3 100644 --- a/htdocs/core/boxes/box_services_vendus.php +++ b/htdocs/core/boxes/box_services_vendus.php @@ -40,7 +40,7 @@ class box_services_vendus extends ModeleBoxes { var $info_box_contents = array(); /** - * \brief Constructeur de la classe + * Constructor */ function box_services_vendus() { @@ -51,8 +51,10 @@ class box_services_vendus extends ModeleBoxes { } /** - * \brief Charge les donnees en memoire pour affichage ulterieur - * \param $max Nombre maximum d'enregistrements a charger + * Load data into info_box_contents array to show array later. + * + * @param int $max Maximum number of records to load + * @return void */ function loadBox($max=5) { @@ -159,6 +161,13 @@ class box_services_vendus extends ModeleBoxes { } + /** + * Method to show box + * + * @param array $head Array with properties of box title + * @param array $contents Array with properties of box lines + * @return void + */ function showBox($head = null, $contents = null) { parent::showBox($this->info_box_head, $this->info_box_contents); diff --git a/htdocs/core/boxes/modules_boxes.php b/htdocs/core/boxes/modules_boxes.php index e03ec6aa778..b38c37494fa 100644 --- a/htdocs/core/boxes/modules_boxes.php +++ b/htdocs/core/boxes/modules_boxes.php @@ -88,9 +88,11 @@ class ModeleBoxes // Can't be abtract as it is instanciated to build "empty" /** - * \brief Standard method to show a box (usage by boxes not mandatory, a box can still use its own function) - * \param $head tableau des caracteristiques du titre - * \param $contents tableau des lignes de contenu + * Standard method to show a box (usage by boxes not mandatory, a box can still use its own function) + * + * @param array $head Array with properties of box title + * @param array $contents Array with properties of box lines + * @return void */ function showBox($head, $contents) {