Extrafields: Difference between revisions

== Load class for extrafields ==

To use extrafields all pages need include  

require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';

== Load extrafield array in object ==

$extrafields = new ExtraFields($db);

$extralabels=$extrafields->fetch_name_optionals_label($object->table_element);

$extralabels will be an array with code and label of extrafields.

Extrafields are loaded in $object->array_options array.

$object->fetch($rowid);

$object->fetch_optionals($rowid,$extralabels);

This code must be placed just after the above.

HTML Exemple

print $object->array_options ['options_XXX'];

Where XXX is the code of the extrafields

PDF example

$pdf->MultiCell (0,5, $outputlangs->convToOutputCharset($object->array_options ['options_XXX']),0,'L'); )

Where XXX is the code of the extrafields

HTML Exemple

print $object->lines[$i]->array_options['options_XXX'];

Where XXX is the code of the extrafields

PDF example

$pdf->MultiCell (0,5, $outputlangs->convToOutputCharset($object->lines[$i]->array_options['options_XXX']),0,'L');

Where XXX is the code of the extrafields

Values of extrafields sent by form need to be retrieve. For doing that, use this method :

$ret = $extrafields->setOptionalsFromPost($extralabels,$object);

== Inside edit page to display extrafields ==

$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))

       print $object->showOptionals($extrafields,'edit');

}

== Inside view page to display extrafields ==

$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))

       print $object->showOptionals($extrafields);

}

== After fetch method of this object class ==

require_once(DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php');

$extrafields=new ExtraFields($this->db);

$this->fetch_optionals($this->id,$extralabels);

}

==After Update method of this object class :==

// Actions on extra fields (by external module or standard code)

// FIXME le hook fait double emploi avec le trigger !!

}

else if ($reshook < 0) $error++;

== After delete method of this object class ==

// Removed extrafields

if (! $error)

   }

}

==Admin pages ==

$elementtype='facture'; //Must be the $table_element of the class that manage extrafield

=Repair Database =

Search and find definition of $listofmodulesextra add the new extrafield declaration

$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');