lainwir3d/dolibarr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Qual: Doxygen

Browse Source
This commit is contained in:
Laurent Destailleur 2013-08-22 16:49:23 +02:00
parent c1dae58055
commit 9da5f7f47a
29 changed files with 156 additions and 125 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
htdocs/adherents/canvas/actions_adherentcard_common.class.php
View File

@ -17,14 +17,13 @@
*/
/**
* \file htdocs/contact/canvas/actions_adherentcard_common.class.php
* \ingroup thirdparty
* \file htdocs/adherents/canvas/actions_adherentcard_common.class.php
* \ingroup adherent
* \brief Fichier de la classe Adherent card controller (common)
*/
/**
* \class ActionsAdherentCardCommon
* \brief Classe permettant la gestion des adherents par defaut
* Class to maage members using default canvas
*/
abstract class ActionsAdherentCardCommon
{

6
htdocs/core/boxes/box_ficheinter.php
View File

@ -16,16 +16,16 @@
*/
/**
* \file htdocs/core/boxes/box_intervention.php
* \file htdocs/core/boxes/box_ficheinter.php
* \ingroup ficheinter
* \brief Module de generation de l'affichage de la box ficheinter
* \brief Box to show last interventions
*/
include_once DOL_DOCUMENT_ROOT.'/core/boxes/modules_boxes.php';
/**
* Class to manage the box to show last contracts
* Class to manage the box to show last interventions
*/
class box_ficheinter extends ModeleBoxes
{

8
htdocs/core/class/dolprintipp.class.php
View File

@ -28,7 +28,7 @@ class dolprintIPP
{
var $host;
var $port;
var $userid;
var $userid; /* user login */
var $user;
var $password;
var $error;
@ -72,7 +72,7 @@ class dolprintIPP
$ipp->setHost($this->host);
$ipp->setPort($this->port);
$ipp->setUserName($this->userid);
//$ipp->setAuthentication($this->user,$this->password);
if (! empty($this->user)) $ipp->setAuthentication($this->user,$this->password);
$ipp->getPrinters();
return $ipp->available_printers;
}
@ -95,7 +95,7 @@ class dolprintIPP
$ipp->setPort($this->port);
$ipp->setJobName($file,true);
$ipp->setUserName($this->userid);
//$ipp->setAuthentication($this->user,$this->password);
if (! empty($this->user)) $ipp->setAuthentication($this->user,$this->password);
// select printer uri for module order, propal,...
$sql = 'SELECT rowid,printer_uri,copy FROM '.MAIN_DB_PREFIX.'printer_ipp WHERE module="'.$module.'"';
$result = $this->db->query($sql);
@ -133,6 +133,7 @@ class dolprintIPP
$ipp->setHost($this->host);
$ipp->setPort($this->port);
$ipp->setUserName($this->userid);
if (! empty($this->user)) $ipp->setAuthentication($this->user,$this->password);
// select printer uri for module order, propal,...
$sql = 'SELECT rowid,printer_uri,printer_name FROM '.MAIN_DB_PREFIX.'printer_ipp WHERE module="'.$module.'"';
$result = $this->db->query($sql);
@ -194,6 +195,7 @@ class dolprintIPP
$ipp->setHost($this->host);
$ipp->setPort($this->port);
$ipp->setUserName($this->userid);
if (! empty($this->user)) $ipp->setAuthentication($this->user,$this->password);
$ipp->setPrinterURI($uri);
$ipp->getPrinterAttributes();
return $ipp->printer_attributes;

36
htdocs/core/class/html.formcron.class.php
View File

@ -1,30 +1,30 @@
<?php
/*
* Copyright (C) 2013 Florian Henry <florian.henry@open-concept.pro>
*
* 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
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
*
* 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
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* \file cron/class/html.formcron.class.php
* \brief Fichier de la classe des fonctions predefinie de composants html cron
*/
* \file core/class/html.formcron.class.php
* \brief Fichier de la classe des fonctions predefinie de composants html cron
*/
/**
* Class to manage building of HTML components
*/
*/
class FormCron extends Form
{
var $db;

2
htdocs/core/lib/cron.lib.php
View File

@ -17,7 +17,7 @@
*/
/**
* \file cron/lib/cron.lib.php
* \file core/lib/cron.lib.php
* \brief Function for module cron
* \ingroup cron
*/

4
htdocs/core/lib/date.lib.php
View File

@ -140,8 +140,8 @@ function getParentCompanyTimeZoneString()
* Return parent company timezone int.
* If $conf->global->MAIN_NEW_DATE is set, we use new behaviour: All convertions take care of dayling saving time.
*
* @param string $refdate Reference date for timezone (timezone differs on winter and summer)
* @return int An offset in hour (+1 for Europe/Paris on winter and +2 for Europe/Paris on summer)
* @param string $refgmtdate Reference date for timezone (timezone differs on winter and summer)
* @return int An offset in hour (+1 for Europe/Paris on winter and +2 for Europe/Paris on summer)
*
function getParentCompanyTimeZoneInt($refgmtdate='now')
{

4
htdocs/core/lib/functions.lib.php
View File

@ -3684,8 +3684,8 @@ function make_substitutions($chaine,$substitutionarray)
* @param array &$substitutionarray Array substitution old value => new value value
* @param Translate $outputlangs If we want substitution from special constants, we provide a language
* @param Object $object If we want substitution from special constants, we provide data in a source object
* @param Object/array $parameters Add more parameters (useful to pass product lines)
* @param string $callfunc What is the name of the custom function that will be called? (default: completesubstitutionarray)
* @param Mixed $parameters Add more parameters (useful to pass product lines)
* @param string $callfunc What is the name of the custom function that will be called? (default: completesubstitutionarray)
* @return void
* @see make_substitutions
*/

12
htdocs/core/lib/json.lib.php
View File

@ -283,14 +283,14 @@ function _unval($val)
}
/**
* convert a string from one UTF-16 char to one UTF-8 char
* Convert a string from one UTF-16 char to one UTF-8 char
*
* Normally should be handled by mb_convert_encoding, but
* provides a slower PHP-only method for installations
* that lack the multibye string extension.
*
* @param string $utf16 UTF-16 character
* @return string UTF-8 character
* @param string $utf16 UTF-16 character
* @return string UTF-8 character
*/
function utf162utf8($utf16)
{
@ -326,14 +326,14 @@ function utf162utf8($utf16)
}
/**
* convert a string from one UTF-8 char to one UTF-16 char
* Convert a string from one UTF-8 char to one UTF-16 char
*
* Normally should be handled by mb_convert_encoding, but
* provides a slower PHP-only method for installations
* that lack the multibye string extension.
*
* @param string $utf8 UTF-8 character
* @return string UTF-16 character
* @param string $utf8 UTF-8 character
* @return string UTF-16 character
*/
function utf82utf16($utf8)
{

70
htdocs/core/lib/pdf.lib.php
View File

@ -1,31 +1,31 @@
<?php
/* Copyright (C) 2006-2011 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2006 Rodolphe Quiedeville <rodolphe@quiedeville.org>
* Copyright (C) 2007 Patrick Raguin <patrick.raguin@gmail.com>
* Copyright (C) 2010-2012 Regis Houssin <regis.houssin@capnetworks.com>
* Copyright (C) 2010 Juanjo Menent <jmenent@2byte.es>
* Copyright (C) 2012 Christophe Battarel <christophe.battarel@altairis.fr>
*
* 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
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
* or see http://www.gnu.org/
*/
* Copyright (C) 2007 Patrick Raguin <patrick.raguin@gmail.com>
* Copyright (C) 2010-2012 Regis Houssin <regis.houssin@capnetworks.com>
* Copyright (C) 2010 Juanjo Menent <jmenent@2byte.es>
* Copyright (C) 2012 Christophe Battarel <christophe.battarel@altairis.fr>
*
* 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
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
* or see http://www.gnu.org/
*/
/**
* \file htdocs/core/lib/pdf.lib.php
* \brief Set of functions used for PDF generation
* \ingroup core
*/
* \brief Set of functions used for PDF generation
* \ingroup core
*/
/**
@ -72,7 +72,7 @@ function pdf_getFormat($outputlangs='')
* @param string $format Array(width,height). Keep empty to use default setup.
* @param string $metric Unit of format ('mm')
* @param string $pagetype 'P' or 'l'
* @return TPDF PDF object
* @return TPDF PDF object
*/
function pdf_getInstance($format='',$metric='mm',$pagetype='P')
{
@ -182,18 +182,18 @@ function pdf_getInstance($format='',$metric='mm',$pagetype='P')
/**
* writeHTMLCell
*
* @param unknown_type $w Width
* @param unknown_type $h Height
* @param unknown_type $x X
* @param unknown_type $y Y
* @param unknown_type $html Html
* @param unknown_type $border Border
* @param unknown_type $ln Ln
* @param unknown_type $fill Fill
* @param unknown_type $reseth Reseth
* @param unknown_type $align Align
* @param unknown_type $autopadding Autopadding
* @return void
* @param int $w Width
* @param int $h Height
* @param int $x X
* @param int $y Y
* @param string $html Html
* @param int $border Border
* @param int $ln Ln
* @param boolean $fill Fill
* @param boolean $reseth Reseth
* @param string $align Align
* @param boolean $autopadding Autopadding
* @return void
*/
public function writeHTMLCell($w, $h, $x, $y, $html = '', $border = 0, $ln = 0, $fill = false, $reseth = true, $align = '', $autopadding = true)
{

2
htdocs/core/modules/modCron.class.php
View File

@ -19,7 +19,7 @@
/**
* \defgroup cron Module cron
* \brief cron module descriptor.
* \file cron/core/modules/modCron.class.php
* \file htdocs/core/modules/modCron.class.php
* \ingroup cron
* \brief Description and activation file for module Jobs
*/

2
htdocs/core/modules/modHoliday.class.php
View File

@ -23,7 +23,7 @@
/**
* \defgroup holiday Module holiday
* \brief Module de gestion des congés
* \file htdocs/includes/modules/modHoliday.class.php
* \file htdocs/core/modules/modHoliday.class.php
* \ingroup holiday
* \brief Description and activation file for module holiday
*/

2
htdocs/core/modules/modMargin.class.php
View File

@ -17,7 +17,7 @@
/** \defgroup margin Module margin
* \brief Module to manage margins
* \file htdocs/includes/modules/modMargin.class.php
* \file htdocs/core/modules/modMargin.class.php
* \ingroup margin
* \brief Description and activation file for module Margin
*/

2
htdocs/core/modules/modOpenSurvey.class.php
View File

@ -21,7 +21,7 @@
*/
/**
* \file htdocs/opensurvey/core/modules/modOpenSurvey.class.php
* \file htdocs/core/modules/modOpenSurvey.class.php
* \ingroup opensurvey
* \brief Description and activation file for module OpenSurvey
*/

2
htdocs/core/modules/project/pdf/doc_generic_project_odt.modules.php
View File

@ -19,7 +19,7 @@
*/
/**
* \file htdocs/core/modules/project/doc/doc_generic_project_odt.modules.php
* \file htdocs/core/modules/project/pdf/doc_generic_project_odt.modules.php
* \ingroup project
* \brief File of class to build ODT documents for third parties
*/

2
htdocs/core/modules/project/task/mod_task_simple.php
View File

@ -99,7 +99,7 @@ class mod_task_simple extends ModeleNumRefTask
* Return next value
*
* @param Societe $objsoc Object third party
* @param Task $Task Object Task
* @param Task $task Object Task
* @return string Value if OK, 0 if KO
*/
function getNextValue($objsoc,$task)

2
htdocs/core/modules/supplier_invoice/mod_facture_fournisseur_cactus.php
View File

@ -19,7 +19,7 @@
*/
/**
* \file htdocs/core/modules/supplier_order/mod_facture_fournisseur_cactus.php
* \file htdocs/core/modules/supplier_invoice/mod_facture_fournisseur_cactus.php
* \ingroup supplier invoice
* \brief File containing the Cactus Class of numbering models of suppliers invoices references
*/

2
htdocs/cron/card.php
View File

@ -18,7 +18,7 @@
*/
/**
* \file cron/card.php
* \file htdocs/cron/card.php
* \ingroup cron
* \brief Cron Jobs Card
*/

4
htdocs/cron/info.php
View File

@ -16,8 +16,8 @@
*/
/**
* \file /cron/cron/info.php
* \brief Page fiche d'une operation
* \file htdocs/cron/info.php
* \brief Page of info of a cron job
*/
require '../main.inc.php';

2
htdocs/cron/list.php
View File

@ -18,7 +18,7 @@
*/
/**
* \file cron/cron/list.php
* \file htdocs/cron/cron/list.php
* \ingroup cron
* \brief Lists Jobs
*/

2
htdocs/ecm/ajax/ecmdatabase.php
View File

@ -16,7 +16,7 @@
*/
/**
* \file htdocs/ecm/ajax/ecmdatabases.php
* \file htdocs/ecm/ajax/ecmdatabase.php
* \brief File to build ecm database
*/

53
htdocs/fichinter/class/fichinter.class.php
View File

@ -1,28 +1,28 @@
<?php
/* Copyright (C) 2002-2003 Rodolphe Quiedeville <rodolphe@quiedeville.org>
* Copyright (C) 2004-2010 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2005-2012 Regis Houssin <regis.houssin@capnetworks.com>
* Copyright (C) 2011-2013 Juanjo Menent <jmenent@2byte.es>
*
* 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
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
* Copyright (C) 2005-2012 Regis Houssin <regis.houssin@capnetworks.com>
* Copyright (C) 2011-2013 Juanjo Menent <jmenent@2byte.es>
*
* 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
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* \file htdocs/fichinter/class/fichinter.class.php
* \ingroup ficheinter
* \brief Fichier de la classe des gestion des fiches interventions
*/
* \ingroup ficheinter
* \brief Fichier de la classe des gestion des fiches interventions
*/
require_once DOL_DOCUMENT_ROOT .'/core/class/commonobject.class.php';
@ -62,7 +62,7 @@ class Fichinter extends CommonObject
* Constructor
*
* @param DoliDB $db Database handler
*/
*/
function __construct($db)
{
$this->db = $db;
@ -829,36 +829,37 @@ class Fichinter extends CommonObject
/**
* Define the label of the contract
* Link intervention to a contract
*
* @param User $user Object user who modify
* @param int $contractid Description
* @return int <0 if ko, >0 if ok
*/
function set_contrat($user, $contratid)
function set_contrat($user, $contractid)
{
global $conf;
if ($user->rights->ficheinter->creer)
{
$sql = "UPDATE ".MAIN_DB_PREFIX."fichinter ";
$sql.= " SET fk_contrat = '".$contratid."'";
$sql.= " SET fk_contrat = '".$contractid."'";
$sql.= " WHERE rowid = ".$this->id;
$sql.= " AND entity = ".$conf->entity;
//$sql.= " AND fk_statut = 0";
dol_syslog("sql=".$sql);
if ($this->db->query($sql))
{
$this->fk_contrat = $contratid;
$this->fk_contrat = $contractid;
return 1;
}
else
{
$this->error=$this->db->error();
dol_syslog("Fichinter::set_contrat Erreur SQL");
dol_syslog($this->error, LOG_ERR);
return -1;
}
}
return -2;
}
/**

2
htdocs/opensurvey/adminstuds_preview.php
View File

@ -16,7 +16,7 @@
*/
/**
* \file htdocs/opensurvey/admin_studs_preview.php
* \file htdocs/opensurvey/adminstuds_preview.php
* \ingroup opensurvey
* \brief Page to preview votes of a survey
*/

4
htdocs/opensurvey/class/opensurveysondage.class.php
View File

@ -16,8 +16,8 @@
*/
/**
* \file dev/skeletons/opensurveysondage.class.php
* \ingroup mymodule othermodule1 othermodule2
* \file htdocs/opensurvey/class/opensurveysondage.class.php
* \ingroup opensurvey
* \brief This file is an example for a CRUD class file (Create/Read/Update/Delete)
* Initialy built by build_class_from_table on 2013-03-10 00:32
*/

2
htdocs/opensurvey/fonctions.php
View File

@ -16,7 +16,7 @@
*/
/**
* \file htdocs/opensurvey/fonction.php
* \file htdocs/opensurvey/fonctions.php
* \ingroup opensurvey
* \brief Functions for module
*/

13
htdocs/printipp/admin/printipp.php
View File

@ -17,7 +17,7 @@
/**
* \file htdocs/printipp/admin/printipp.php
* \ingroup core
* \ingroup printipp
* \brief Page to setup printipp module
*/
@ -41,6 +41,7 @@ if (!$mode) $mode='config';
/*
* Action
*/
if ($action == 'setvalue' && $user->admin)
{
$db->begin();
@ -87,7 +88,7 @@ print $langs->trans("PrintIPPDesc")."<br>\n";
print '<br>';
if ($mode=='config'&& $user->admin)
if ($mode == 'config' && $user->admin)
{
print '<form method="post" action="'.$_SERVER["PHP_SELF"].'?mode=config">';
print '<input type="hidden" name="token" value="'.$_SESSION['newtoken'].'">';
@ -162,7 +163,7 @@ if ($mode=='config'&& $user->admin)
print '</form>';
}
if ($mode=='test'&& $user->admin)
if ($mode == 'test' && $user->admin)
{
print '<table class="nobordernopadding" width="100%">';
$printer = new dolPrintIPP($db,$conf->global->PRINTIPP_HOST,$conf->global->PRINTIPP_PORT,$user->login,$conf->global->PRINTIPP_USER,$conf->global->PRINTIPP_PASSWORD);
@ -180,9 +181,10 @@ if ($mode=='test'&& $user->admin)
print '<td>Media</td>';
print '<td>Supported</td>';
print "</tr>\n";
$list = $printer->getlist_available_printers();
$var = True;
foreach ($list as $value )
$var = true;
foreach ($list as $value)
{
$var=!$var;
$printer_det = $printer->get_printer_detail($value);
@ -208,5 +210,6 @@ if ($mode=='test'&& $user->admin)
dol_fiche_end();
llxFooter();
$db->close();
?>

29
htdocs/product/stock/lib/replenishment.lib.php
View File

@ -17,12 +17,19 @@
*/
/**
* \file htdocs/product/stock/replenishment.lib.php
* \file htdocs/product/stock/lib/replenishment.lib.php
* \ingroup produit
* \brief Contains functions used in replenish.php and replenishorders.php
*/
require_once DOL_DOCUMENT_ROOT . '/fourn/class/fournisseur.commande.class.php';
/**
* dispatched
*
* @param int $order_id Id of order
* @return boolean
*/
function dispatched($order_id)
{
global $db;
@ -32,7 +39,8 @@ function dispatched($order_id)
$resql = $db->query($sql);
$dispatched = array();
$ordered = array();
if($resql && $db->num_rows($resql)) {
if($resql && $db->num_rows($resql))
{
while($res = $db->fetch_object($resql))
$dispatched[] = $res;
}
@ -47,6 +55,11 @@ function dispatched($order_id)
return $dispatched == $ordered;
}
/**
* dispatchedOrders
*
* @return Ambigous <string, multitype:NULL >
*/
function dispatchedOrders()
{
global $db;
@ -69,6 +82,12 @@ function dispatchedOrders()
return $res;
}
/**
* ordered
*
* @param int $product_id Product id
* @return void
*/
function ordered($product_id)
{
global $db, $langs, $conf;
@ -104,6 +123,12 @@ function ordered($product_id)
}
}
/**
* getProducts
*
* @param int $order_id Order id
* @return void
*/
function getProducts($order_id)
{
global $db;

2
htdocs/public/cron/cron_run_jobs.php
View File

@ -18,7 +18,7 @@
*/
/**
* \file cron/public/cron/cron_run_jobs.php
* \file htdocs/public/cron/cron_run_jobs.php
* \ingroup cron
* \brief Execute pendings jobs
*/

1
htdocs/theme/eldy/style.css.php
View File

@ -1810,6 +1810,7 @@ tr.liste_total td, form.liste_total div {
border: 0px;
margin-bottom: 1px;
color: #202020;
min-height: 18px; /* seems to not be used */
}
.pair:hover {

2
scripts/cron/cron_run_jobs.php
View File

@ -19,7 +19,7 @@
*/
/**
* \file cron/script/cron/cron_run_jobs.php
* \file scripts/cron/cron_run_jobs.php
* \ingroup cron
* \brief Execute pendings jobs
*/