gsl / civicrm-cli-utils
杂项工具。启动CiviCRM并包装API以供命令行使用。
Requires
- wp-cli/php-cli-tools: 0.10.*
This package is not auto-updated.
Last update: 2024-09-14 18:52:55 UTC
README
一系列CiviCRM命令行工具。工作正在进行中。
安装
使用composer install获取依赖:wp-cli/php-cli-tools
配置文件
您可以在项目的根目录中放置一个.conf
文件以节省一些输入。请参阅includes/base.php ::getConfig()
。在其中包含一个很好的配置是CIVICRM_ROOT
。还可以查看在includes/base.php::mapColumns()
中指定列映射的选项
示例
clean是这些工具的一个示例用法。它删除、取消删除,以及从STDIN导入联系人。使用源代码,Luke。
注意
对于civicrm 4.7之前的版本,cvCli()
需要一个核心修改来添加--json输出选项。
- https://gist.github.com/ginkgomzd/b26a750b2fbd3ce25950如果可能的话,建议使用
dushCVApi()
,它具有相同的功能。欢迎PR添加wp-cli支持。
匆忙的聊天方向
"clean"最初是一个示例集成...但后来Toby进行了泛化...所以...这就是了。我想找出你需要扩展什么,你应该浏览这个文件:https://github.com/ginkgostreet/civicrm-cli-utils/blob/master/includes/base.php 只需查看函数名,parseCsv()
是一个关键。
对了,getConfig是另一个。这可能就是上次你卡住的地方。这不是设置它的唯一方法,但可能是最简单的方法...在这个项目的根目录中放置一个.conf文件,并设置Civi的路径。
所以...我想创建一个像createContact.php https://github.com/ginkgostreet/civicrm-cli-utils/blob/master/includes/createContact.php ...例如createParticipant.php 是的,它涉及到编码...但它非常声明式。
后缀_run()
是核心查找以实现命令的地方,例如createParticipant。您可以在clean.php的末尾附近看到...它查找与命令匹配的文件,并期望由该文件加载...具有类似名称且带有后缀_run()
的函数。
所以...createContact_run()
...基本上获取全局配置(它只有Civi的路径),然后设置一些常量...然后执行
$main = 'processContactsForImport';
withFile($input, $main);
这意味着...对于输入文件的每一行,调用函数processContactsForImport
...该函数定义在同一个文件中。 ...该函数接收已解析为数组的行,然后使用核心实用程序调用civicrm API。