-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7bc5906
commit 6c3bf31
Showing
1 changed file
with
63 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,37 +1,63 @@ | ||
| ## Welcome to GitHub Pages | ||
|
|
||
| You can use the [editor on GitHub](https://github.com/PortoSpire/suiteCRMClient/edit/master/docs/index.md) to maintain and preview the content for your website in Markdown files. | ||
|
|
||
| Whenever you commit to this repository, GitHub Pages will run [Jekyll](https://jekyllrb.com/) to rebuild the pages in your site, from the content in your Markdown files. | ||
|
|
||
| ### Markdown | ||
|
|
||
| Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for | ||
|
|
||
| ```markdown | ||
| Syntax highlighted code block | ||
|
|
||
| # Header 1 | ||
| ## Header 2 | ||
| ### Header 3 | ||
|
|
||
| - Bulleted | ||
| - List | ||
|
|
||
| 1. Numbered | ||
| 2. List | ||
|
|
||
| **Bold** and _Italic_ and `Code` text | ||
|
|
||
| [Link](url) and  | ||
| ``` | ||
|
|
||
| For more details see [Basic writing and formatting syntax](https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax). | ||
|
|
||
| ### Jekyll Themes | ||
|
|
||
| Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/PortoSpire/suiteCRMClient/settings/pages). The name of this theme is saved in the Jekyll `_config.yml` configuration file. | ||
|
|
||
| ### Support or Contact | ||
|
|
||
| Having trouble with Pages? Check out our [documentation](https://docs.github.com/categories/github-pages-basics/) or [contact support](https://support.github.com/contact) and we’ll help you sort it out. | ||
| <img src="https://img.shields.io/github/v/release/PortoSpire/suiteCRMClient" /> <img src="https://img.shields.io/github/languages/code-size/PortoSpire/suiteCRMClient" /> <img src="https://img.shields.io/github/license/PortoSpire/suiteCRMClient" /> | ||
| # Client library for use with SuiteCRM | ||
| A free (LGPL3) client library for use with SuiteCRM to abstract various API usage to enable easier integrations. | ||
| <a href="https://suitecrm.com/"><img src="https://assets.portospire.com/psf/img/suite_icon.png" alt="SuiteCRM" width="182" /></a> | ||
|
|
||
| <a href="https://www.portospire.com/">Provided by PortoSpire | ||
| <img src="https://assets.portospire.com/psf/img/portospire%20header.svg" alt="PortoSpire - be seen" width="182" /></a> | ||
|
|
||
| [Introduction](#introduction) | ||
| [Setup](#setup) | ||
| [Usage](#usage) | ||
| * [Mezzio](#mezzio) | ||
| * [Laminas MVC](#laminasmvc) | ||
| * [Standalone](#standalone) | ||
|
|
||
|
|
||
| ## <a name="introduction" href="#introduction">Introduction</a> | ||
| This package provides a SuiteCRM client to abstract API calls and form submissions to provide and receive | ||
| data from SuiteCRM instances. It makes use of Person Form campaigns and both the V8 and rest APIs as needed. | ||
|
|
||
| ## <a name="setup" href="#setup">Setup</a> | ||
| Add to your project's composer.json | ||
| ```` | ||
| composer require portospire/suitecrmclient | ||
| ```` | ||
| ## <a name="usage" href="#usage">Usage</a> | ||
| This package is built to support Laminas Mezzio and Laminas MVC as well | ||
| as be available as a stand alone library. | ||
|
|
||
| An example to get a list of Web campaigns from a SuiteCRM instance: | ||
| ```` | ||
| $SuiteCRMClient->setServerDomain($server_domain); | ||
| $SuiteCRMClient->setClientId($client_id); | ||
| $SuiteCRMClient->setClientSecret($client_secret); | ||
| $filter = new \PortoSpire\SuiteCRMClient\Model\Filter(['campaign_type' => 'Web']); | ||
| $json = $SuiteCRMClient->getCampaigns([], ['size' => 20, 'number' => 1], 'name', $filter); // this will contain json of the results | ||
| $campaignsFull = $SuiteCRMClient->convertJsonToGenerics($json); // this converts the json to PHP objects | ||
| ```` | ||
| An example to submit a lead into a web-to-lead form in a SuiteCRM instance: | ||
| (You can extend the provided models (Model/WebToLead, etc) if you have custom fields) | ||
| ```` | ||
| $values = (array) $WebToLead; // expects an array of key=>value pairs where the keys match the different fields from the web-to-lead form | ||
| $SuiteCRMClient->setServerDomain($server_domain); | ||
| $SuiteCRMClient->setClientId($client_id); | ||
| $SuiteCRMClient->setClientSecret($client_secret); | ||
| $SuiteCRMClient->submitWebToLead($values, $campaign_id); // this must match the campaign id that the web-to-lead form is associated to in SuiteCRM | ||
| ```` | ||
| ### <a name="mezzio" href="#mezzio">Mezzio</a> | ||
| Add the ConfigProvider class to the config aggregator (typically found in config/config.php) | ||
| ```` | ||
| $aggregator = new ConfigAggregator([ | ||
| ... | ||
| \PortoSpire\SuiteCRMClient\ConfigProvider::class, | ||
| ... | ||
| ```` | ||
| Then use the client in your handlers/middleware as needed for your use cases. | ||
|
|
||
|
|
||
| ### <a name="laminasmvc" href="#laminasmvc">Laminas MVC</a> | ||
| There should be no additional steps beyond adding to your project's composer.json required to begin using the library with Laminas MVC. | ||
|
|
||
| ### <a name="standalone" href="#standalone">Standalone</a> | ||
| There should be no additional steps beyond adding to your project's composer.json required to begin using the library. |