warent/convey-sugar

关于此包最新版本(dev-master)没有可用的许可信息。

SugarCRM 的扩展,以更轻松、更灵活地操作数据

dev-master 2016-07-16 23:12 UTC

This package is not auto-updated.

Last update: 2024-09-14 19:31:11 UTC


README

许可证:MIT

1. 关于

  • 设计用于与 SugarCRM 7 和 v10 REST API 一起工作

2. 安装

ConveySugar 通过 Composer 提供 $ composer require warent/convey-sugar

3. 使用示例

<?php

	namespace App;

	use ConveySugar\Sugar;
	use ConveySugar\Utilities\Search;

	class ContactSearchingApp {

		private $sugar;

		public function __construct() {
			// Creating our Sugar connection instance.
			// Connection opens when newed up,
			// so be sure accepting functions accept sugar by reference.
			$this->sugar = new Sugar([
				'SUGAR_URL' => 'https://sugar/rest/v10/',
				'SUGAR_USERNAME' => 'admin',
				'SUGAR_PASSWORD' => 'password'
			]);
		}

		public function searchContacts() {

			// Instantiating a new Sugar Utility
			// This one cycles through all records within a Sugar module
			$serchUtil = new Search(['resultsFn' => function($params) {
				$resultCount = count($params['results']);
				echo "$resultCount results from offset {$params['offset']}";
				foreach ($params['results'] as $result) {
					print_r($Result);
				}
			});

			// We execute our Search Utility on the module 'Contacts'
			$this->sugar->execute('Contacts', $searchUtil);
		}
	}
?>

4. 工具

计数

描述

Return the number of records within a sugar module

参数

删除

描述

Delete a record by ID

参数

  • recordID (Sugar ID [字符串]) 必需

插入

描述

Insert a new record

参数

  • values (关联数组) 必需

相关

描述

Cycle related records of one sugar record to another module

参数

  • recordID (Sugar ID [字符串]) 必需
  • relation (Sugar 模块 [字符串]) 必需
  • type (Related::Type [静态整型])
    • Related::TYPE_NORMAL
    • Related::TYPE_NAKED
    • Related::TYPE_BACK
  • number (整数)
  • transform (Related::Transform [静态整型])
    • Related::TRANSFORM_JSON
    • Related::TRANSFORM_BOOL
  • resultsFn (函数)
    • 参数 (关联数组)
      • results (数组)
      • offset (整数)
  • offset (整数)
  • limit (整数)

搜索

描述

Cycle records of a sugar module

参数

  • resultsFn (函数) 必需
    • 参数 (关联数组)
      • results (数组)
      • offset (整数)
  • offset (整数)
  • limit (整数)

5. 额外功能

resultsFn

  • 在 resultsFn 中返回 false 将停止/中断查找

相关(工具)

  • transform 默认返回 JSON(关联数组)。如果找到任何结果,则 TYPE_BOOL 将返回 true,否则返回 false
  • type 指的是 SugarCRM 关联查询的格式。在 Sugar API 中,有三种(非官方)已知方式来实现这一点,分别是 NORMALBACKNAKED:在 NORMAL 类型中,查询为 $module_$relation_$number;在 BACK 类型中,查询为 $relation_$module_$number;在 NAKED 类型中,查询仅为 $relation。默认 typeNORMAL,默认 number1,因为这些是最常见的配置。

谢谢