附加字段: Difference between revisions

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search
m (Import interlang links (links to translated versions of this page in other languages) from origin English page "Extrafields".)
Tag: 2017 source edit
 
(7 intermediate revisions by 2 users not shown)
Line 11: Line 11:
{{Template用户手册}}
{{Template用户手册}}


= 附加字段 =
=附加字段=


附加字段允许将其他数据添加到Dolibarr标准数据库模式中。在第3.2版中介绍了,在大多数业务对象中实现了附加字段:
附加字段允许您向标准Dolibarr数据库模式中添加更多数据。自版本3.2开始引入,附加字段现在在大多数业务对象中得以实现:
* Thirdparties & contacts
* Users
* Events
* Proposal
* Customer Invoices
* Orders
* Supplier Proposal
* Supplier Invoices
* Supplier Orders
* Products & services
* Member & member type
* Projects & project tasks (since 3.4)
* Categories
* Expense Report


== 技术实现 ==
*合作方 & 联系人
*用户
*事件
*报价单
*客户发票
*订单
*供应商报价单
*供应商发票
*供应商订单
*产品 & 服务
*会员 & 会员类型
*项目 & 项目任务 (自 3.4 起)
*类别
*费用报销单


每个对象在数据库中都有它的表来存储附加字段的值。
==技术实现方式==


== 数据表附加字段表模块 ==
每个对象在数据库中都有一个表用于存储ExtraFields的值。
 
==数据表的附加字段表的模板==


   llx_''BaseTableNAme''_extrafields
   llx_''BaseTableNAme''_extrafields
Line 42: Line 43:




创建一个MySQL表实例,用于实现对象上的附加字段:
用于在对象上实现 ExtraFields 的MySQL定义文件示例:


   create table llx_place_room_extrafields
   create table llx_place_room_extrafields
Line 52: Line 53:
   ) ENGINE=innodb;
   ) ENGINE=innodb;


== 加载附加字段类 ==
==加载ExtraFields类==
使用附加字段需要包括
要使用ExtraFields,所有页面必须包括:
<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';
</source>
</syntaxhighlight>


== 加载附加字段数组于对象 ==
==加载对象的ExtraField数组==
<source lang="php">
<syntaxhighlight lang="PHP">
$extrafields = new ExtraFields($db);
$extrafields = new ExtraFields($db);
$extralabels=$extrafields->fetch_name_optionals_label($object->table_element);
$extralabels=$extrafields->fetch_name_optionals_label($object->table_element);
</source>
</syntaxhighlight>
 
$extralabels 将是带代码和附加字段标签的数组。


这个代码必须被放置到类中,例如进入函数"write_file"。
$extralabels 将是一个包含扩展字段的code和label的数组。此代码必须放在类中,例如放在“write_file”函数中。


== 对象加载附加字段 ==
==加载对象的ExtraField值==


附加字段的加载,使用 $object->array_options 数组。
把ExtraFields加载到数组 $object->array_options 中。


<source lang="php">
<syntaxhighlight lang="PHP">
$object->fetch($rowid);
$object->fetch($rowid);
$object->fetch_optionals($rowid,$extralabels);
$object->fetch_optionals($rowid,$extralabels);
</source>
</syntaxhighlight>
 
此代码应放在上述代码之后。


这个代码必须放在上面的后面。
==以PDF或HTML格式显示ExtraField值==
加载ExtraFields后


== 显示附加字段于 PDF 或 HTML ==
HTML示例
加载附加字段后


HTML 示例
<syntaxhighlight lang="PHP">
<source lang="php">
print $object->array_options ['options_XXX'];
print $object->array_options ['options_XXX'];
</source>
</syntaxhighlight>
此处 XXX 为附加字段代码
 
此处 XXX 是extrafields代码
 
PDF示例


PDF 示例
<syntaxhighlight lang="PHP">
<source lang="php">
$pdf->MultiCell (0,5, $outputlangs->convToOutputCharset($object->array_options ['options_XXX']),0,'L'); )
$pdf->MultiCell (0,5, $outputlangs->convToOutputCharset($object->array_options ['options_XXX']),0,'L'); )
</source>
</syntaxhighlight>
此处 XXX 为附加字段代码
 
此处 XXX 是extrafields代码


== 显示附加字段列表于 PDF or HTML ==
==以PDF或HTML格式显示行的ExtraField值==
加载附加字段后
加载ExtraFields后


HTML 示例
HTML示例
<source lang="php">
 
<syntaxhighlight lang="PHP">
print $object->lines[$i]->array_options['options_XXX'];
print $object->lines[$i]->array_options['options_XXX'];
</source>
</syntaxhighlight>
此处 XXX 为附加字段代码


PDF 示例
此处 XXX 是extrafields代码
<source lang="php">
 
PDF示例
 
<syntaxhighlight lang="PHP">
$pdf->MultiCell (0,5, $outputlangs->convToOutputCharset($object->lines[$i]->array_options['options_XXX']),0,'L');
$pdf->MultiCell (0,5, $outputlangs->convToOutputCharset($object->lines[$i]->array_options['options_XXX']),0,'L');
</source>
</syntaxhighlight>
此处 XXX 为附加字段代码
 
此处 XXX 是extrafields代码


==如何在使用模板(propals等)时更改列的标签==
在模板的PHP代码中,您可以通过修改名为“_tableau(...)”的函数来更改扩展字段的标签。


== 调用 $object->create() 或 $object->update()之前 ==
==在调用 $object->create() 或 $object->update()之前==


表单发送的附加字段的值需要取回。为此,使用此方法:
必须检索表单发送的extrafields值。为此,请使用以下方法:
<source lang="php">
 
<syntaxhighlight lang="PHP">
$ret = $extrafields->setOptionalsFromPost($extralabels,$object);
$ret = $extrafields->setOptionalsFromPost($extralabels,$object);
</source>
</syntaxhighlight>


== 内部编辑页面显示附加字段 ==
==在编辑页面中显示扩展字段==


 
<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,$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))
Line 126: Line 136:
       print $object->showOptionals($extrafields,'edit');
       print $object->showOptionals($extrafields,'edit');
}
}
</source>
</syntaxhighlight>


== 内部显示页面显示附加字段 ==
==在视图页面中显示扩展字段==


<source lang="php">
<syntaxhighlight 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,$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))
Line 136: Line 146:
       print $object->showOptionals($extrafields);
       print $object->showOptionals($extrafields);
}
}
</source>
</syntaxhighlight>


== 对象类的 fetch 方法之后 ==
==在此对象类的Fetch方法之后==
<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);
Line 146: Line 156:
$this->fetch_optionals($this->id,$extralabels);
$this->fetch_optionals($this->id,$extralabels);
}
}
</source>
</syntaxhighlight>


==对象类的Update方法之后==
==在此对象类的Update方法之后==
<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 167: Line 177:
}
}
else if ($reshook < 0) $error++;
else if ($reshook < 0) $error++;
</source>
</syntaxhighlight>


== 对象类的delete方法之后 ==
==在此对象类的Delete方法之后==
<source lang="php">
<syntaxhighlight lang="PHP">
// Removed extrafields
// Removed extrafields
if (! $error)
if (! $error)
Line 184: Line 194:
   }
   }
}
}
</source>
</syntaxhighlight>


==管理页==
==管理页面==
<source lang="php">
<syntaxhighlight lang="PHP">
$elementtype='facture'; //Must be the $table_element of the class that manage extrafield
$elementtype='facture'; //Must be the $table_element of the class that manage extrafield
</source>
</syntaxhighlight>


==修复数据库 ==
==恢复数据库==
Search and find definition of $listofmodulesextra add the new extrafield declaration
搜索并查找$listofmodulesextra的定义添加新的extrafield语句
<source lang="php">
 
<syntaxhighlight lang="PHP">
$listofmodulesextra=array('societe'=>'societe','adherent'=>'adherent','product'=>'product',
$listofmodulesextra=array('societe'=>'societe','adherent'=>'adherent','product'=>'product',
'socpeople'=>'socpeople', 'commande'=>'commande', 'facture'=>'facture',
'socpeople'=>'socpeople', 'commande'=>'commande', 'facture'=>'facture',
'commande_fournisseur'=>'commande_fournisseur', 'actioncomm'=>'actioncomm',
'commande_fournisseur'=>'commande_fournisseur', 'actioncomm'=>'actioncomm',
'adherent_type'=>'adherent_type','user'=>'user','projet'=>'projet', 'projet_task'=>'projet_task');
'adherent_type'=>'adherent_type','user'=>'user','projet'=>'projet', 'projet_task'=>'projet_task');
</source>
</syntaxhighlight>
 
==相关视频==
Extrafields:
(法语配音,但有字幕,并以法语校阅)


== 如何在使用模型时更改列的标签 (propals, etc.) ==
<youtube width="200" height="180">Eex2YXxToS0</youtube>
在该模型的PHP代码中,您可以通过"_tableau(...)"的函数来更改附加字段的标签。
<youtube width="200" height="180">QQnyoUGsN1c</youtube>
<youtube width="200" height="180">md6JHbd8o_0</youtube>

Latest revision as of 07:57, 12 October 2023


附加字段

附加字段允许您向标准Dolibarr数据库模式中添加更多数据。自版本3.2开始引入,附加字段现在在大多数业务对象中得以实现:

  • 合作方 & 联系人
  • 用户
  • 事件
  • 报价单
  • 客户发票
  • 订单
  • 供应商报价单
  • 供应商发票
  • 供应商订单
  • 产品 & 服务
  • 会员 & 会员类型
  • 项目 & 项目任务 (自 3.4 起)
  • 类别
  • 费用报销单

技术实现方式

每个对象在数据库中都有一个表用于存储ExtraFields的值。

数据表的附加字段表的模板

 llx_BaseTableNAme_extrafields
 rowid                     integer AUTO_INCREMENT PRIMARY KEY,
 tms                       timestamp,
 fk_object                 integer NOT NULL,
 import_key                varchar(14)


用于在对象上实现 ExtraFields 的MySQL定义文件示例:

 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;

加载ExtraFields类

要使用ExtraFields,所有页面必须包括:

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

加载对象的ExtraField数组

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

$extralabels 将是一个包含扩展字段的code和label的数组。此代码必须放在类中,例如放在“write_file”函数中。

加载对象的ExtraField值

把ExtraFields加载到数组 $object->array_options 中。

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

此代码应放在上述代码之后。

以PDF或HTML格式显示ExtraField值

加载ExtraFields后

HTML示例

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

此处 XXX 是extrafields代码

PDF示例

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

此处 XXX 是extrafields代码

以PDF或HTML格式显示行的ExtraField值

加载ExtraFields后

HTML示例

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

此处 XXX 是extrafields代码

PDF示例

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

此处 XXX 是extrafields代码

如何在使用模板(propals等)时更改列的标签

在模板的PHP代码中,您可以通过修改名为“_tableau(...)”的函数来更改扩展字段的标签。

在调用 $object->create() 或 $object->update()之前

必须检索表单发送的extrafields值。为此,请使用以下方法:

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

在编辑页面中显示扩展字段

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

在视图页面中显示扩展字段

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

在此对象类的Fetch方法之后

require_once(DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php');
$extrafields=new ExtraFields($this->db);
$extralabels=$extrafields->fetch_name_optionals_label($this->table_element,true);
if (count($extralabels)>0) {
	$this->fetch_optionals($this->id,$extralabels);
}

在此对象类的Update方法之后

// Actions on extra fields (by external module or standard code)
// FIXME le hook fait double emploi avec le trigger !!
$hookmanager->initHooks(array('HookModuleNamedao'));
$parameters=array('socid'=>$this->id);
$reshook=$hookmanager->executeHooks('insertExtraFields',$parameters,$this,$action);    // Note that $action and $object may have been modified by some hooks
if (empty($reshook))
{
	if (empty($conf->global->MAIN_EXTRAFIELDS_DISABLED)) // For avoid conflicts if trigger used
	{
            $result=$this->insertExtraFields();
            if ($result < 0)
            {
            	$error++;
            }
        }
}
else if ($reshook < 0) $error++;

在此对象类的Delete方法之后

// 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);
      }
   }
}

管理页面

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

恢复数据库

搜索并查找$listofmodulesextra的定义添加新的extrafield语句

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

相关视频

Extrafields: (法语配音,但有字幕,并以法语校阅)