Dolibarr ERP CRM Wiki

Changes

Extrafields (view source)

Revision as of 17:57, 24 October 2022

3,781 bytes added ,  2 years ago
Ajout d'une partie vidéo concernant les extrafields. Not in the language of the page but it's better than nothing or it can help
Line 1: Line 1:  +
<!-- BEGIN origin interlang links -->
 +
<!-- You can edit this section but do NOT remove these comments
 +
    Links below will be automatically replicated on translated pages by PolyglotBot -->
 +
[[zh:附加字段]]
 +
[[fr:Champs_personnalises]]
 +
<!-- END interlang links -->
 +
 
{{TemplateDocDevEn}}
 
{{TemplateDocDevEn}}
−
= Extrafields =
     −
Extrafields allow to add others datas to Dolibarr standard database schema. Introduced in version 3.2, extrafields are now implemented in businesses object :
+
=Extrafields=
−
* Thirdparties & contacts & users
+
Extrafields allow to add others datas to Dolibarr standard database schema. Introduced in version 3.2, extrafields are now implemented in most business objects :
 +
* Thirdparties & contacts  
 +
* Users
 
* Events
 
* Events
 +
* Proposal
 
* Customer Invoices
 
* Customer Invoices
−
* Proposal
+
* Orders
 +
* Supplier Proposal
 +
* Supplier Invoices
 +
* Supplier Orders
 
* Products & services
 
* Products & services
 
* Member & member type
 
* Member & member type
−
* Orders
   
* Projects & project tasks (since 3.4)
 
* Projects & project tasks (since 3.4)
 +
* Categories
 +
* Expense Report
   −
== Technical implementation ==
+
= Technical implementation =
   −
Each object have his table in database to store values of extrafields.
+
Each object has its table in database to store values of extrafields.
 +
 
 +
== Datatables extrafield tables models ==
   −
==Datatables extrafield tables models is  :==
   
   llx_''BaseTableNAme''_extrafields
 
   llx_''BaseTableNAme''_extrafields
 
   rowid                    integer AUTO_INCREMENT PRIMARY KEY,
 
   rowid                    integer AUTO_INCREMENT PRIMARY KEY,
Line 23: Line 37:  
   import_key                varchar(14)
 
   import_key                varchar(14)
   −
==Display page have to include :==
+
 
−
<source lang="php">
+
An example of mysql definition file for extrafields implementation on an object :
 +
 
 +
  create table llx_place_room_extrafields
 +
  (
 +
    rowid                    integer AUTO_INCREMENT PRIMARY KEY,
 +
    tms                      timestamp,
 +
    fk_object                integer NOT NULL,
 +
    import_key                varchar(14)                          -- import key
 +
  ) ENGINE=innodb;
 +
 
 +
= Usage =
 +
== Load class for extrafields ==
 +
To use extrafields all pages need include
 +
<syntaxhighlight lang="php">
 
require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
 
require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
−
</source>
+
</syntaxhighlight>
   −
==Load extrafield array in object :==
+
== Load extrafield array in object ==
−
<source lang="php">
+
<syntaxhighlight lang="php">
 
$extrafields = new ExtraFields($db);
 
$extrafields = new ExtraFields($db);
−
$extralabels=$extrafields->fetch_name_optionals_label('''ObjectClassName''');
+
$extralabels=$extrafields->fetch_name_optionals_label($object->table_element);
−
</source>
+
</syntaxhighlight>
 +
 
 +
$extralabels will be an array with code and label of extrafields.
 +
This code must be placed into the class for example into the function "write_file".
 +
 
 +
== Load extrafield into object ==
 +
 
 +
Extrafields are loaded in $object->array_options array.
 +
 
 +
<syntaxhighlight lang="php">
 +
$object->fetch($rowid);
 +
$object->fetch_optionals($rowid,$extralabels);
 +
</syntaxhighlight>
 +
 
 +
This code must be placed just after the above.
 +
 
 +
== Display extrafield value into PDF or HTML ==
 +
After load extrafields
 +
 
 +
HTML Exemple
 +
<syntaxhighlight lang="php">
 +
print $object->array_options ['options_XXX'];
 +
</syntaxhighlight>
 +
Where XXX is the code of the extrafields
 +
 
 +
PDF example
 +
<syntaxhighlight lang="php">
 +
$pdf->MultiCell (0,5, $outputlangs->convToOutputCharset($object->array_options ['options_XXX']),0,'L'); )
 +
</syntaxhighlight>
 +
Where XXX is the code of the extrafields
 +
 
 +
A dedicated page to show how to integrate extrafileds into PDF can be found there : [[Add Extrafields on PDF Models]]
 +
 
 +
== Display extrafield value of lines into PDF or HTML ==
 +
After load extrafields
   −
==Load extrafield into object :==
+
HTML Exemple
−
<source lang="php">
+
<syntaxhighlight lang="php">
−
''$object''->fetch($rowid);
+
print $object->lines[$i]->array_options['options_XXX'];
−
''$object''->fetch_optionals($rowid,$extralabels);
+
</syntaxhighlight>
−
</source>
+
Where XXX is the code of the extrafields
   −
==Before call ''$object''->create or ''$object''->update :==
+
PDF example
−
<source lang="php">
+
<syntaxhighlight lang="php">
−
$ret = $extrafields->setOptionalsFromPost($extralabels,''$object'');
+
$pdf->MultiCell (0,5, $outputlangs->convToOutputCharset($object->lines[$i]->array_options['options_XXX']),0,'L');
−
</source>
+
</syntaxhighlight>
 +
Where XXX is the code of the extrafields
   −
==Inside edit page to display extrafields :==
+
 
−
<source lang="php">
+
== How to change the labels of the columns when using models (propals, etc.) ==
−
$reshook=$hookmanager->executeHooks('formObjectOptions',$parameters,$act,$action);    // Note that $action and $object may have been modified by hook
+
In the PHP code of the model you can change the labels of your extrafield by changing into the function named "_tableau(...)"
 +
 
 +
== Before call $object->create() or $object->update() ==
 +
 
 +
Values of extrafields sent by form need to be retrieve. For doing that, use this method :
 +
<syntaxhighlight lang="php">
 +
$ret = $extrafields->setOptionalsFromPost($extralabels,$object);
 +
</syntaxhighlight>
 +
 
 +
== Inside edit page to display extrafields ==
 +
 
 +
 
 +
<syntaxhighlight lang="php">
 +
$reshook=$hookmanager->executeHooks('formObjectOptions',$parameters,$object,$action);    // Note that $action and $object may have been modified by hook
 
if (empty($reshook) && ! empty($extrafields->attribute_label))
 
if (empty($reshook) && ! empty($extrafields->attribute_label))
 
{
 
{
−
       print ''$object''->showOptionals($extrafields,'edit');
+
       print $object->showOptionals($extrafields,'edit');
 
}
 
}
−
</source>
+
</syntaxhighlight>
 +
 
 +
== Inside view page to display extrafields ==
   −
==Inside view page to display extrafields :==
+
<syntaxhighlight lang="php">
−
<source lang="php">
+
$reshook=$hookmanager->executeHooks('formObjectOptions',$parameters,$object,$action);    // Note that $action and $object may have been modified by hook
−
$reshook=$hookmanager->executeHooks('formObjectOptions',$parameters,$act,$action);    // Note that $action and $object may have been modified by hook
   
if (empty($reshook) && ! empty($extrafields->attribute_label))
 
if (empty($reshook) && ! empty($extrafields->attribute_label))
 
{
 
{
−
       print ''$object''->showOptionals($extrafields);
+
       print $object->showOptionals($extrafields);
 
}
 
}
−
</source>
+
</syntaxhighlight>
   −
==After fetch method of this object class:==
+
== After fetch method of this object class ==
−
<source lang="php">
+
<syntaxhighlight lang="php">
 
require_once(DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php');
 
require_once(DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php');
 
$extrafields=new ExtraFields($this->db);
 
$extrafields=new ExtraFields($this->db);
−
$extralabels=$extrafields->fetch_name_optionals_label('company',true);
+
$extralabels=$extrafields->fetch_name_optionals_label($this->table_element,true);
 
if (count($extralabels)>0) {
 
if (count($extralabels)>0) {
−
$this->array_options = array();
+
$this->fetch_optionals($this->id,$extralabels);
−
}
  −
foreach($extrafields->attribute_label as $key=>$label)
  −
{
  −
$this->array_options['options_'.$key]=$label;
   
}
 
}
−
</source>
+
</syntaxhighlight>
    
==After Update method of this object class :==
 
==After Update method of this object class :==
−
<source lang="php">
+
<syntaxhighlight lang="php">
 
// Actions on extra fields (by external module or standard code)
 
// Actions on extra fields (by external module or standard code)
 
// FIXME le hook fait double emploi avec le trigger !!
 
// FIXME le hook fait double emploi avec le trigger !!
Line 96: Line 168:  
}
 
}
 
else if ($reshook < 0) $error++;
 
else if ($reshook < 0) $error++;
−
</source>
+
</syntaxhighlight>
 +
 
 +
== After delete method of this object class ==
 +
<syntaxhighlight lang="php">
 +
// Removed extrafields
 +
if (! $error)
 +
{
 +
      if (empty($conf->global->MAIN_EXTRAFIELDS_DISABLED)) // For avoid conflicts if trigger used
 +
      {
 +
      $result=$this->deleteExtraFields();
 +
      if ($result < 0)
 +
      {
 +
        $error++;
 +
        dol_syslog(get_class($this)."::delete erreur ".$errorflag." ".$this->error, LOG_ERR);
 +
      }
 +
  }
 +
}
 +
</syntaxhighlight>
 +
 
 +
==Admin pages ==
 +
<syntaxhighlight lang="php">
 +
$elementtype='facture'; //Must be the $table_element of the class that manage extrafield
 +
</syntaxhighlight>
 +
 
 +
=Repair Database =
 +
Search and find definition of $listofmodulesextra add the new extrafield declaration
 +
<syntaxhighlight lang="php">
 +
$listofmodulesextra=array('societe'=>'societe','adherent'=>'adherent','product'=>'product',
 +
'socpeople'=>'socpeople', 'commande'=>'commande', 'facture'=>'facture',
 +
'commande_fournisseur'=>'commande_fournisseur', 'actioncomm'=>'actioncomm',
 +
'adherent_type'=>'adherent_type','user'=>'user','projet'=>'projet', 'projet_task'=>'projet_task');
 +
</syntaxhighlight>
 +
 
 +
= Related videos =
 +
 
 +
Extrafields:
 +
(vocal in french but subtitles are available and review in this language)
 +
 
 +
<youtube width="200" height="180">Eex2YXxToS0</youtube>
 +
<youtube width="200" height="180">QQnyoUGsN1c</youtube>
 +
<youtube width="200" height="180">md6JHbd8o_0</youtube>
Techsc
148

edits

Retrieved from "https://wiki.dolibarr.org/index.php?title=Special:MobileDiff/29310...54947"