Doxygen
This commit is contained in:
parent
9e900196fb
commit
c4a496cd05
@ -820,10 +820,12 @@ class Propal extends CommonObject
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Load an object from its id and create a new one in database
|
* Load an object from its id and create a new one in database
|
||||||
* @param fromid Id of object to clone
|
*
|
||||||
* @param invertdetail Reverse sign of amounts for lines
|
* @param int $fromid Id of object to clone
|
||||||
* @param socid Id of thirdparty
|
* @param int $invertdetail Reverse sign of amounts for lines
|
||||||
* @return int New id of clone
|
* @param int $socid Id of thirdparty
|
||||||
|
* @param HookManager $hookmanager Hook manager instance
|
||||||
|
* @return int New id of clone
|
||||||
*/
|
*/
|
||||||
function createFromClone($fromid,$invertdetail=0,$socid=0,$hookmanager=false)
|
function createFromClone($fromid,$invertdetail=0,$socid=0,$hookmanager=false)
|
||||||
{
|
{
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@ -61,11 +61,12 @@ class ModelePDFLabels
|
|||||||
/**
|
/**
|
||||||
* Create a document onto disk accordign to template module
|
* Create a document onto disk accordign to template module
|
||||||
*
|
*
|
||||||
* @param DoliDB $db Database handler
|
* @param DoliDB $db objet base de donnee
|
||||||
* @param array $arrayofmembers Array of members
|
* @param int $id id de la facture a creer
|
||||||
* @param string $modele Force le modele a utiliser ('' to not force)
|
* @param string $message message
|
||||||
* @param Translate $outputlangs Objet lang a utiliser pour traduction
|
* @param string $modele force le modele a utiliser ('' to not force)
|
||||||
* @return int <0 if KO, >0 if OK
|
* @param string $outputlangs objet lang a utiliser pour traduction
|
||||||
|
* @return int <0 if KO, >0 if OK
|
||||||
*/
|
*/
|
||||||
function members_label_pdf_create($db, $arrayofmembers, $modele, $outputlangs)
|
function members_label_pdf_create($db, $arrayofmembers, $modele, $outputlangs)
|
||||||
{
|
{
|
||||||
|
|||||||
@ -60,6 +60,7 @@ abstract class ModelePDFSuppliersInvoices extends CommonDocGenerator
|
|||||||
* @param Object $object object supplier invoice
|
* @param Object $object object supplier invoice
|
||||||
* @param string $model force le modele a utiliser ('' to not force)
|
* @param string $model force le modele a utiliser ('' to not force)
|
||||||
* @param Translate $outputlangs objet lang a utiliser pour traduction
|
* @param Translate $outputlangs objet lang a utiliser pour traduction
|
||||||
|
* @param HookManager $hookmanager Hook manager instance
|
||||||
* @return int 0 if KO, 1 if OK
|
* @return int 0 if KO, 1 if OK
|
||||||
*/
|
*/
|
||||||
function supplier_invoice_pdf_create($db, $object, $model, $outputlangs)
|
function supplier_invoice_pdf_create($db, $object, $model, $outputlangs)
|
||||||
|
|||||||
@ -146,6 +146,7 @@ class ModeleNumRefSuppliersOrders
|
|||||||
* @param int $hidedetails Hide details of lines
|
* @param int $hidedetails Hide details of lines
|
||||||
* @param int $hidedesc Hide description
|
* @param int $hidedesc Hide description
|
||||||
* @param int $hideref Hide ref
|
* @param int $hideref Hide ref
|
||||||
|
* @param HookManager $hookmanager Hook manager instance
|
||||||
* @return int 0 if KO, 1 if OK
|
* @return int 0 if KO, 1 if OK
|
||||||
*/
|
*/
|
||||||
function supplier_order_pdf_create($db, $object, $model, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0)
|
function supplier_order_pdf_create($db, $object, $model, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0)
|
||||||
|
|||||||
@ -198,7 +198,6 @@ function pdf_format_address($outputlangs,$object)
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Return a string with full address formated
|
* Return a string with full address formated
|
||||||
*
|
|
||||||
* @param outputlangs Output langs object
|
* @param outputlangs Output langs object
|
||||||
* @param sourcecompany Source company object
|
* @param sourcecompany Source company object
|
||||||
* @param targetcompany Target company object
|
* @param targetcompany Target company object
|
||||||
@ -297,10 +296,9 @@ function pdf_build_address($outputlangs,$sourcecompany,$targetcompany='',$target
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Show header of page for PDF generation
|
* Show header of page for PDF generation
|
||||||
*
|
* @param pdf Object PDF
|
||||||
* @param PDF $pdf Object PDF
|
* @param outputlang Object lang for output
|
||||||
* @param Translate $outputlangs Object lang for output
|
* @param page_height
|
||||||
* @param int $page_height Height of page
|
|
||||||
*/
|
*/
|
||||||
function pdf_pagehead(&$pdf,$outputlangs,$page_height)
|
function pdf_pagehead(&$pdf,$outputlangs,$page_height)
|
||||||
{
|
{
|
||||||
@ -316,11 +314,10 @@ function pdf_pagehead(&$pdf,$outputlangs,$page_height)
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Add a draft watermark on PDF files
|
* Add a draft watermark on PDF files
|
||||||
*
|
|
||||||
* @param pdf Object PDF
|
* @param pdf Object PDF
|
||||||
* @param outputlangs Object lang
|
* @param outputlangs Object lang
|
||||||
* @param h Height of PDF
|
* @param height Height of PDF
|
||||||
* @param w Width of PDF
|
* @param width Width of PDF
|
||||||
* @param unit Unit of height (mmn, pt, ...)
|
* @param unit Unit of height (mmn, pt, ...)
|
||||||
* @param text Text to show
|
* @param text Text to show
|
||||||
*/
|
*/
|
||||||
@ -495,9 +492,8 @@ function pdf_bank(&$pdf,$outputlangs,$curx,$cury,$account,$onlynumber=0)
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Show footer of page for PDF generation
|
* Show footer of page for PDF generation
|
||||||
*
|
|
||||||
* @param pdf The PDF factory
|
* @param pdf The PDF factory
|
||||||
* @param outputlangs Object lang for output
|
* @param outputlang Object lang for output
|
||||||
* @param paramfreetext Constant name of free text
|
* @param paramfreetext Constant name of free text
|
||||||
* @param fromcompany Object company
|
* @param fromcompany Object company
|
||||||
* @param marge_basse Margin bottom
|
* @param marge_basse Margin bottom
|
||||||
@ -692,19 +688,17 @@ function pdf_pagefoot(&$pdf,$outputlangs,$paramfreetext,$fromcompany,$marge_bass
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Output line description into PDF
|
* Output line description into PDF
|
||||||
*
|
* @param pdf PDF object
|
||||||
* @param PDF $pdf PDF object
|
* @param object Object
|
||||||
* @param Object $object Object
|
* @param i Current line number
|
||||||
* @param int $i Current line number
|
* @param outputlang Object lang for output
|
||||||
* @param Translate $outputlangs Object lang for output
|
* @param w
|
||||||
* @param int $w Width
|
* @param h
|
||||||
* @param int $h Height
|
* @param posx
|
||||||
* @param int $posx Pos x
|
* @param posy
|
||||||
* @param int $posy Pos y
|
* @param hideref Hide reference
|
||||||
* @param int $hideref Hide reference
|
* @param hidedesc Hide description
|
||||||
* @param int $hidedesc Hide description
|
* @param issupplierline Is it a line for a supplier object ?
|
||||||
* @param int $issupplierline Is it a line for a supplier object ?
|
|
||||||
* @param HookManager $hookmanager Instance of HookManager
|
|
||||||
*/
|
*/
|
||||||
function pdf_writelinedesc(&$pdf,$object,$i,$outputlangs,$w,$h,$posx,$posy,$hideref=0,$hidedesc=0,$issupplierline=0,$hookmanager=false)
|
function pdf_writelinedesc(&$pdf,$object,$i,$outputlangs,$w,$h,$posx,$posy,$hideref=0,$hidedesc=0,$issupplierline=0,$hookmanager=false)
|
||||||
{
|
{
|
||||||
@ -1193,9 +1187,9 @@ function pdf_getTotalQty($object,$type='',$outputlangs,$hookmanager=false)
|
|||||||
/**
|
/**
|
||||||
* Convert a currency code into its symbol
|
* Convert a currency code into its symbol
|
||||||
*
|
*
|
||||||
* @param PDF $pdf PDF object
|
* @param pdf PDF object
|
||||||
* @param string $currency_code Currency code
|
* @param currency_code Currency code
|
||||||
* @return string Currency symbol encoded into UTF8
|
* @param string Currency symbol encoded into UTF8
|
||||||
*/
|
*/
|
||||||
function pdf_getCurrencySymbol(&$pdf, $currency_code)
|
function pdf_getCurrencySymbol(&$pdf, $currency_code)
|
||||||
{
|
{
|
||||||
|
|||||||
@ -67,7 +67,6 @@ if (function_exists('get_magic_quotes_gpc')) // magic_quotes_* removed in PHP6
|
|||||||
*
|
*
|
||||||
* @param string $val Value
|
* @param string $val Value
|
||||||
* @param string $get 1=GET, 0=POST
|
* @param string $get 1=GET, 0=POST
|
||||||
* @return boolean true if ther is an injection
|
|
||||||
*/
|
*/
|
||||||
function test_sql_and_script_inject($val, $get)
|
function test_sql_and_script_inject($val, $get)
|
||||||
{
|
{
|
||||||
@ -86,13 +85,11 @@ function test_sql_and_script_inject($val, $get)
|
|||||||
if ($get) $sql_inj += preg_match('/"/i', $val); // We refused " in GET parameters value
|
if ($get) $sql_inj += preg_match('/"/i', $val); // We refused " in GET parameters value
|
||||||
return $sql_inj;
|
return $sql_inj;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Security: Return true if OK, false otherwise
|
* Security: Return true if OK, false otherwise
|
||||||
*
|
*
|
||||||
* @param string $var Variable name
|
* @param string $var Variable name
|
||||||
* @param string $get 1=GET, 0=POST
|
* @param string $get 1=GET, 0=POST
|
||||||
* @return boolean true if ther is an injection
|
|
||||||
*/
|
*/
|
||||||
function analyse_sql_and_script(&$var, $get)
|
function analyse_sql_and_script(&$var, $get)
|
||||||
{
|
{
|
||||||
@ -117,7 +114,6 @@ function analyse_sql_and_script(&$var, $get)
|
|||||||
return (test_sql_and_script_inject($var,$get) <= 0);
|
return (test_sql_and_script_inject($var,$get) <= 0);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Sanity check on URL
|
// Sanity check on URL
|
||||||
if (! empty($_SERVER["PHP_SELF"]))
|
if (! empty($_SERVER["PHP_SELF"]))
|
||||||
{
|
{
|
||||||
@ -788,17 +784,17 @@ if (! function_exists("llxHeader"))
|
|||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* Show HTML header HTML + BODY + Top menu + left menu + DIV
|
* Show HTML header HTML + BODY + Top menu + left menu + DIV
|
||||||
*
|
* @param head Add optionnal head lines
|
||||||
* @param string $head Optionnal head lines
|
* @param title Title of web page
|
||||||
* @param string $title HTML title
|
* @param help_url Url links to help page
|
||||||
* @param string $help_url Url links to help page
|
* Syntax is: For a wiki page: EN:EnglishPage|FR:FrenchPage|ES:SpanishPage
|
||||||
* Syntax is: For a wiki page: EN:EnglishPage|FR:FrenchPage|ES:SpanishPage
|
* For other external page: http://server/url
|
||||||
* For other external page: http://server/url
|
* @param target Target to use in menu links
|
||||||
* @param int $disablejs More content into html header
|
* @param disablejs Do not output links to js (Ex: qd fonction utilisee par sous formulaire Ajax)
|
||||||
* @param int $disablehead More content into html header
|
* @param disablehead Do not output head section
|
||||||
* @param array $arrayofjs Array of complementary js files
|
* @param arrayofjs Array of js files to add in header
|
||||||
* @param array $arrayofcss Array of complementary css files
|
* @param arrayofcss Array of css files to add in header
|
||||||
* @param string $morequerystring Query string to add to the link "print" to get same parameters (use only if autodetect fails)
|
* @param morequerystring Query string to add to the link "print" to get same parameters (use only if autodetect fails)
|
||||||
*/
|
*/
|
||||||
function llxHeader($head = '', $title='', $help_url='', $target='', $disablejs=0, $disablehead=0, $arrayofjs='', $arrayofcss='', $morequerystring='')
|
function llxHeader($head = '', $title='', $help_url='', $target='', $disablejs=0, $disablehead=0, $arrayofjs='', $arrayofcss='', $morequerystring='')
|
||||||
{
|
{
|
||||||
@ -833,7 +829,7 @@ function top_httphead()
|
|||||||
* @param int $disablehead More content into html header
|
* @param int $disablehead More content into html header
|
||||||
* @param array $arrayofjs Array of complementary js files
|
* @param array $arrayofjs Array of complementary js files
|
||||||
* @param array $arrayofcss Array of complementary css files
|
* @param array $arrayofcss Array of complementary css files
|
||||||
* @return void
|
* @return none
|
||||||
*/
|
*/
|
||||||
function top_htmlhead($head, $title='', $disablejs=0, $disablehead=0, $arrayofjs='', $arrayofcss='')
|
function top_htmlhead($head, $title='', $disablejs=0, $disablehead=0, $arrayofjs='', $arrayofcss='')
|
||||||
{
|
{
|
||||||
|
|||||||
@ -72,6 +72,17 @@ class ActionsCardProduct extends Product
|
|||||||
return $langs->trans("Products");
|
return $langs->trans("Products");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief Lecture des donnees dans la base
|
||||||
|
* \param id Product id
|
||||||
|
*/
|
||||||
|
function fetch($id='', $ref='', $action='')
|
||||||
|
{
|
||||||
|
$result = parent::fetch($id);
|
||||||
|
|
||||||
|
return $result;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Assign custom values for canvas (for example into this->tpl to be used by templates)
|
* Assign custom values for canvas (for example into this->tpl to be used by templates)
|
||||||
*
|
*
|
||||||
|
|||||||
@ -72,6 +72,17 @@ class ActionsCardService extends Product
|
|||||||
return $langs->trans("Products");
|
return $langs->trans("Products");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief Lecture des donnees dans la base
|
||||||
|
* \param id Product id
|
||||||
|
*/
|
||||||
|
function fetch($id='', $ref='', $action='')
|
||||||
|
{
|
||||||
|
$result = parent::fetch($id);
|
||||||
|
|
||||||
|
return $result;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Assign custom values for canvas (for example into this->tpl to be used by templates)
|
* Assign custom values for canvas (for example into this->tpl to be used by templates)
|
||||||
*
|
*
|
||||||
|
|||||||
@ -69,8 +69,7 @@ class ActionsCardDefault extends ActionsCardCommon
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Execute actions
|
* Execute actions
|
||||||
*
|
* @param Id of object (may be empty for creation)
|
||||||
* @param int $socid Id of object (may be empty for creation)
|
|
||||||
*/
|
*/
|
||||||
function doActions($socid)
|
function doActions($socid)
|
||||||
{
|
{
|
||||||
@ -82,7 +81,7 @@ class ActionsCardDefault extends ActionsCardCommon
|
|||||||
/**
|
/**
|
||||||
* Assign custom values for canvas (for example into this->tpl to be used by templates)
|
* Assign custom values for canvas (for example into this->tpl to be used by templates)
|
||||||
*
|
*
|
||||||
* @param string $action Type of action
|
* @param action Type of action
|
||||||
*/
|
*/
|
||||||
function assign_values($action='')
|
function assign_values($action='')
|
||||||
{
|
{
|
||||||
|
|||||||
@ -69,8 +69,7 @@ class ActionsCardIndividual extends ActionsCardCommon
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Execute actions
|
* Execute actions
|
||||||
*
|
* @param Id of object (may be empty for creation)
|
||||||
* @param int $socid Id of object (may be empty for creation)
|
|
||||||
*/
|
*/
|
||||||
function doActions($socid)
|
function doActions($socid)
|
||||||
{
|
{
|
||||||
@ -80,9 +79,9 @@ class ActionsCardIndividual extends ActionsCardCommon
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Assign custom values for canvas (for example into this->tpl to be used by templates)
|
* Assign custom values for canvas (for example into this->tpl to be used by templates)
|
||||||
*
|
*
|
||||||
* @param string $action Type of action
|
* @param action Type of action
|
||||||
*/
|
*/
|
||||||
function assign_values($action='')
|
function assign_values($action='')
|
||||||
{
|
{
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user