';
-
- $out.= '| ';
- $out.= '';
- $out.= $this->form->textwithpicto($item->getNameText(), $item->getHelpText(), 1, 'info', '', 0, 3, 'tootips'.$item->confKey);
- $out.= '';
- $out.= ' | ';
-
- $out.= '';
-
- if ($editMode) {
- $out.= $item->generateInputField();
- } else {
- $out.= $item->generateOutputField();
- }
-
- if (!empty($item->errors)) {
- // TODO : move set event message in a methode to be called by cards not by this class
- setEventMessages(null, $item->errors, 'errors');
- }
-
- $out.= ' | ';
- $out.= '
';
- }
-
- return $out;
- }
-
-
- /**
- * Method used to test module builder convertion to this form usage
- *
- * @param array $params an array of arrays of params from old modulBuilder params
- * @return boolean
- */
- public function addItemsFromParamsArray($params)
- {
- if (!is_array($params) || empty($params)) { return false; }
- foreach ($params as $confKey => $param) {
- $this->addItemFromParams($confKey, $param); // todo manage error
- }
- return true;
- }
-
-
- /**
- * From old
- * Method was used to test module builder convertion to this form usage.
- *
- * @param string $confKey the conf name to store
- * @param array $params an array of params from old modulBuilder params
- * @return bool
- */
- public function addItemFromParams($confKey, $params)
- {
- if (empty($confKey) || empty($params['type'])) { return false; }
-
- /*
- * Exemple from old module builder setup page
- * // 'WEBPORTALBIS_MYPARAM1'=>array('type'=>'string', 'css'=>'minwidth500' ,'enabled'=>1),
- // 'WEBPORTALBIS_MYPARAM2'=>array('type'=>'textarea','enabled'=>1),
- //'WEBPORTALBIS_MYPARAM3'=>array('type'=>'category:'.Categorie::TYPE_CUSTOMER, 'enabled'=>1),
- //'WEBPORTALBIS_MYPARAM4'=>array('type'=>'emailtemplate:thirdparty', 'enabled'=>1),
- //'WEBPORTALBIS_MYPARAM5'=>array('type'=>'yesno', 'enabled'=>1),
- //'WEBPORTALBIS_MYPARAM5'=>array('type'=>'thirdparty_type', 'enabled'=>1),
- //'WEBPORTALBIS_MYPARAM6'=>array('type'=>'securekey', 'enabled'=>1),
- //'WEBPORTALBIS_MYPARAM7'=>array('type'=>'product', 'enabled'=>1),
- */
-
- $item = new FormSetupItem($confKey);
- // need to be ignored from scrutinizer setTypeFromTypeString was created as deprecated to incite developper to use object oriented usage
- /** @scrutinizer ignore-deprecated */ $item->setTypeFromTypeString($params['type']);
-
- if (!empty($params['enabled'])) {
- $item->enabled = $params['enabled'];
- }
-
- if (!empty($params['css'])) {
- $item->cssClass = $params['css'];
- }
-
- $this->items[$item->confKey] = $item;
-
- return true;
- }
-
- /**
- * Used to export param array for /core/actions_setmoduleoptions.inc.php template
- * Method exists only for manage setup convertion
- *
- * @return array $arrayofparameters for /core/actions_setmoduleoptions.inc.php
- */
- public function exportItemsAsParamsArray()
- {
- $arrayofparameters = array();
- foreach ($this->items as $item) {
- $arrayofparameters[$item->confKey] = array(
- 'type' => $item->getType(),
- 'enabled' => $item->enabled
- );
- }
-
- return $arrayofparameters;
- }
-
- /**
- * Reload for each item default conf
- * note: this will override custom configuration
- *
- * @return bool
- */
- public function reloadConfs()
- {
-
- if (!array($this->items)) { return false; }
- foreach ($this->items as $item) {
- $item->loadValueFromConf();
- }
-
- return true;
- }
-
-
- /**
- * Create a new item
- * the tagret is useful with hooks : that allow externals modules to add setup items on good place
- *
- * @param string $confKey the conf key used in database
- * @param string $targetItemKey target item used to place the new item beside
- * @param bool $insertAfterTarget insert before or after target item ?
- * @return FormSetupItem the new setup item created
- */
- public function newItem($confKey, $targetItemKey = false, $insertAfterTarget = false)
- {
- $item = new FormSetupItem($confKey);
-
- // set item rank if not defined as last item
- if (empty($item->rank)) {
- $item->rank = $this->getCurentItemMaxRank() + 1;
- $this->setItemMaxRank($item->rank); // set new max rank if needed
- }
-
- // try to get rank from target column, this will override item->rank
- if (!empty($targetItemKey)) {
- if (isset($this->items[$targetItemKey])) {
- $targetItem = $this->items[$targetItemKey];
- $item->rank = $targetItem->rank; // $targetItem->rank will be increase after
- if ($targetItem->rank >= 0 && $insertAfterTarget) {
- $item->rank++;
- }
- }
-
- // calc new rank for each item to make place for new item
- foreach ($this->items as $fItem) {
- if ($item->rank <= $fItem->rank) {
- $fItem->rank = $fItem->rank + 1;
- $this->setItemMaxRank($fItem->rank); // set new max rank if needed
- }
- }
- }
-
- $this->items[$item->confKey] = $item;
- return $this->items[$item->confKey];
- }
-
- /**
- * Sort items according to rank
- *
- * @return bool
- */
- public function sortingItems()
- {
- // Sorting
- return uasort($this->items, array($this, 'itemSort'));
- }
-
- /**
- * getCurentItemMaxRank
- *
- * @param bool $cache To use cache or not
- * @return int
- */
- public function getCurentItemMaxRank($cache = true)
- {
- if (empty($this->items)) {
- return 0;
- }
-
- if ($cache && $this->maxItemRank > 0) {
- return $this->maxItemRank;
- }
-
- $this->maxItemRank = 0;
- foreach ($this->items as $item) {
- $this->maxItemRank = max($this->maxItemRank, $item->rank);
- }
-
- return $this->maxItemRank;
- }
-
-
- /**
- * set new max rank if needed
- *
- * @param int $rank the item rank
- * @return int|void new max rank
- */
- public function setItemMaxRank($rank)
- {
- $this->maxItemRank = max($this->maxItemRank, $rank);
- }
-
-
- /**
- * get item position rank from item key
- *
- * @param string $itemKey the item key
- * @return int rank on success and -1 on error
- */
- public function getLineRank($itemKey)
- {
- if (!isset($this->items[$itemKey]->rank)) {
- return -1;
- }
- return $this->items[$itemKey]->rank;
- }
-
-
- /**
- * uasort callback function to Sort params items
- *
- * @param FormSetupItem $a formSetup item
- * @param FormSetupItem $b formSetup item
- * @return int Return compare result
- */
- public function itemSort(FormSetupItem $a, FormSetupItem $b)
- {
- if (empty($a->rank)) {
- $a->rank = 0;
- }
- if (empty($b->rank)) {
- $b->rank = 0;
- }
- if ($a->rank == $b->rank) {
- return 0;
- }
- return ($a->rank < $b->rank) ? -1 : 1;
- }
-}
-
-/**
- * This class help to create item for class formSetup
- */
-class FormSetupItem
-{
- /**
- * @var DoliDB Database handler.
- */
- public $db;
-
- /** @var Translate */
- public $langs;
-
- /** @var int */
- public $entity;
-
- /** @var Form */
- public $form;
-
- /** @var string $confKey the conf key used in database */
- public $confKey;
-
- /** @var string|false $nameText */
- public $nameText = false;
-
- /** @var string $helpText */
- public $helpText = '';
-
- /** @var string $fieldValue */
- public $fieldValue;
-
- /** @var string $defaultFieldValue */
- public $defaultFieldValue = null;
-
- /** @var array $fieldAttr fields attribute only for compatible fields like input text */
- public $fieldAttr = array();
-
- /** @var bool|string set this var to override field output will override $fieldInputOverride and $fieldOutputOverride too */
- public $fieldOverride = false;
-
- /** @var bool|string set this var to override field input */
- public $fieldInputOverride = false;
-
- /** @var bool|string set this var to override field output */
- public $fieldOutputOverride = false;
-
- /** @var int $rank */
- public $rank = 0;
-
- /** @var array set this var for options on select and multiselect items */
- public $fieldOptions = array();
-
- /** @var callable $saveCallBack */
- public $saveCallBack;
-
- /** @var callable $setValueFromPostCallBack */
- public $setValueFromPostCallBack;
-
- /**
- * @var string $errors
- */
- public $errors = array();
-
- /**
- * TODO each type must have setAs{type} method to help configuration
- * And set var as protected when its done configuration must be done by method
- * this is important for retrocompatibility of futures versions
- * @var string $type 'string', 'textarea', 'category:'.Categorie::TYPE_CUSTOMER', 'emailtemplate', 'thirdparty_type'
- */
- protected $type = 'string';
-
- public $enabled = 1;
-
- public $cssClass = '';
-
- /**
- * Constructor
- *
- * @param string $confKey the conf key used in database
- */
- public function __construct($confKey)
- {
- global $langs, $db, $conf, $form;
- $this->db = $db;
-
- if (!empty($form) && is_object($form) && get_class($form) == 'Form') { // the form class has a cache inside so I am using it to optimize
- $this->form = $form;
- } else {
- $this->form = new Form($this->db);
- }
-
- $this->langs = $langs;
- $this->entity = $conf->entity;
-
- $this->confKey = $confKey;
- $this->loadValueFromConf();
- }
-
- /**
- * load conf value from databases
- * @return bool
- */
- public function loadValueFromConf()
- {
- global $conf;
- if (isset($conf->global->{$this->confKey})) {
- $this->fieldValue = getDolGlobalString($this->confKey);
- return true;
- } else {
- $this->fieldValue = null;
- return false;
- }
- }
-
- /**
- * reload conf value from databases is an aliase of loadValueFromConf
- * @deprecated
- * @return bool
- */
- public function reloadValueFromConf()
- {
- return $this->loadValueFromConf();
- }
-
-
- /**
- * Save const value based on htdocs/core/actions_setmoduleoptions.inc.php
- *
- * @return int -1 if KO, 1 if OK
- */
- public function saveConfValue()
- {
- global $hookmanager;
-
- $parameters = array();
- $reshook = $hookmanager->executeHooks('formSetupBeforeSaveConfValue', $parameters, $this); // Note that $action and $object may have been modified by some hooks
- if ($reshook < 0) {
- $this->setErrors($hookmanager->errors);
- return -1;
- }
-
- if ($reshook > 0) {
- return $reshook;
- }
-
-
- if (!empty($this->saveCallBack) && is_callable($this->saveCallBack)) {
- return call_user_func($this->saveCallBack, $this);
- }
-
- // Modify constant only if key was posted (avoid resetting key to the null value)
- if ($this->type != 'title') {
- $result = dolibarr_set_const($this->db, $this->confKey, $this->fieldValue, 'chaine', 0, '', $this->entity);
- if ($result < 0) {
- return -1;
- } else {
- return 1;
- }
- }
-
- return 0;
- }
-
- /**
- * Set an override function for saving data
- *
- * @param callable $callBack a callable function
- * @return void
- */
- public function setSaveCallBack(callable $callBack)
- {
- $this->saveCallBack = $callBack;
- }
-
- /**
- * Set an override function for get data from post
- * @param callable $callBack a callable function
- * @return void
- */
- public function setValueFromPostCallBack(callable $callBack)
- {
- $this->setValueFromPostCallBack = $callBack;
- }
-
- /**
- * Save const value based on htdocs/core/actions_setmoduleoptions.inc.php
- * @return int -1 if KO, 0 nothing to do , 1 if OK
- */
- public function setValueFromPost()
- {
- if (!empty($this->setValueFromPostCallBack) && is_callable($this->setValueFromPostCallBack)) {
- return call_user_func($this->setValueFromPostCallBack);
- }
-
- // Modify constant only if key was posted (avoid resetting key to the null value)
- if ($this->type != 'title') {
- if (preg_match('/category:/', $this->type)) {
- if (GETPOST($this->confKey, 'int') == '-1') {
- $val_const = '';
- } else {
- $val_const = GETPOST($this->confKey, 'int');
- }
- } elseif ($this->type == 'multiselect') {
- $val = GETPOST($this->confKey, 'array');
- if ($val && is_array($val)) {
- $val_const = implode(',', $val);
- } else {
- $val_const = '';
- }
- } elseif ($this->type == 'html') {
- $val_const = GETPOST($this->confKey, 'restricthtml');
- } else {
- $val_const = GETPOST($this->confKey, 'alpha');
- }
-
- // TODO add value check with class validate
- $this->fieldValue = $val_const;
-
- return 1;
- }
-
- return 0;
- }
-
- /**
- * Get help text or generate it
- * @return int|string
- */
- public function getHelpText()
- {
- if (!empty($this->helpText)) { return $this->helpText; }
- return (($this->langs->trans($this->confKey . 'Tooltip') != $this->confKey . 'Tooltip') ? $this->langs->trans($this->confKey . 'Tooltip') : '');
- }
-
- /**
- * Get field name text or generate it
- * @return false|int|string
- */
- public function getNameText()
- {
- if (!empty($this->nameText)) { return $this->nameText; }
- return (($this->langs->trans($this->confKey) != $this->confKey) ? $this->langs->trans($this->confKey) : $this->langs->trans('MissingTranslationForConfKey', $this->confKey));
- }
-
- /**
- * generate input field
- * @return bool|string
- */
- public function generateInputField()
- {
- global $conf;
-
- if (!empty($this->fieldOverride)) {
- return $this->fieldOverride;
- }
-
- if (!empty($this->fieldInputOverride)) {
- return $this->fieldInputOverride;
- }
-
- // Set default value
- if (is_null($this->fieldValue)) {
- $this->fieldValue = $this->defaultFieldValue;
- }
-
-
- $this->fieldAttr['name'] = $this->confKey;
- $this->fieldAttr['id'] = 'setup-'.$this->confKey;
- $this->fieldAttr['value'] = $this->fieldValue;
-
- $out = '';
-
- if ($this->type == 'title') {
- $out.= $this->generateOutputField(); // title have no input
- } elseif ($this->type == 'multiselect') {
- $out.= $this->generateInputFieldMultiSelect();
- } elseif ($this->type == 'select') {
- $out.= $this->generateInputFieldSelect();
- } elseif ($this->type == 'selectUser') {
- $out.= $this->generateInputFieldSelectUser();
- } elseif ($this->type == 'textarea') {
- $out.= $this->generateInputFieldTextarea();
- } elseif ($this->type== 'html') {
- $out.= $this->generateInputFieldHtml();
- } elseif ($this->type== 'color') {
- $out.= $this->generateInputFieldColor();
- } elseif ($this->type == 'yesno') {
- if (!empty($conf->use_javascript_ajax)) {
- $out.= ajax_constantonoff($this->confKey);
- } else {
- $out.= $this->form->selectyesno($this->confKey, $this->fieldValue, 1);
- }
- } elseif (preg_match('/emailtemplate:/', $this->type)) {
- $out.= $this->generateInputFieldEmailTemplate();
- } elseif (preg_match('/category:/', $this->type)) {
- $out.=$this->generateInputFieldCategories();
- } elseif (preg_match('/thirdparty_type/', $this->type)) {
- require_once DOL_DOCUMENT_ROOT.'/core/class/html.formcompany.class.php';
- $formcompany = new FormCompany($this->db);
- $out.= $formcompany->selectProspectCustomerType($this->fieldValue, $this->confKey);
- } elseif ($this->type == 'securekey') {
- $out.= $this->generateInputFieldSecureKey();
- } elseif ($this->type == 'product') {
- if (isModEnabled("product") || isModEnabled("service")) {
- $selected = (empty($this->fieldValue) ? '' : $this->fieldValue);
- $out.= $this->form->select_produits($selected, $this->confKey, '', 0, 0, 1, 2, '', 0, array(), 0, '1', 0, $this->cssClass, 0, '', null, 1);
- }
- } else {
- $out.= $this->generateInputFieldText();
- }
-
- return $out;
- }
-
- /**
- * generatec default input field
- * @return string
- */
- public function generateInputFieldText()
- {
- if (empty($this->fieldAttr)) { $this->fieldAttr['class'] = 'flat '.(empty($this->cssClass) ? 'minwidth200' : $this->cssClass); }
- return '