Download the PHP package jbtje/vtiger-laravel without Composer

On this page you can find all versions of the php package jbtje/vtiger-laravel. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of jbtje/vtiger-laravel

Informations about the package vtiger-laravel

Vtiger 7.4.0 open source (Laravel 8 Package)

This package might work with older versions of Vtiger, and possibly with laravel 6 or 7.

BerliCRM (based on Vtiger) has a better documentation, files are added in the documentation folder.

Use the Vtiger webservice (REST) API from within Laravel for the following operations.

See Third Party App Integration (REST APIs)

Installation, Configuration and Usage

Installing

  1. In order to install the Vtiger package in your Laravel project, just run the composer require command from your terminal:

  2. Add ENV variables:

Username and Access Key can be found within Vtiger under My Preferences

  1. Optional: Publish the configuration file:

Configuration

You can create a new user in Vtiger for the API to use, or use an existing user.

Usage

Include the Vtiger package in your controller:

ListTypes

List types is a command to provide you with all possible types the Vtiger CRM supports. For each type, you can run the describe() command, to obtain the data structure.

Obtain all the list types:

For a clean install, this will return: (click to expand)

Describe

To obtain the data sctructure of a module in Vtiger, run the describe method with the module name. Module names can be obtained using listTypes()

Partial result for "Contacts": (click to expand) _Please note the `mandatory` field._

Create

To insert a record into the CRM, first create an array of data to insert. Using describe(), you can see which fields are mandatory.

Retrieve

To retrieve a record from the CRM, you need the id of the record you want to find (i.e. '4x1').

Update

The easiest way to update a record in the CRM is to retrieve the record first.

Then update the object:

Delete

To delete a record from the CRM, you need the id of the record you want to delete (e.g. '4x1').

Lookup

This function uses the Vtiger Lookup API endpoint to search for a single piece of information within multiple columns of a Vtiger module. This function is often multitudes faster than the search function.

Search

This function is a sql query builder wrapped around the query function. Accepts instance of laravels QueryBuilder.

By default, the function will quote but not escape your inputs, if you wish for your data to not be quoted, set the 2nd paramater to false:

Also keep in mind that Vtiger has several limitations on it's sql query capabilities. You can not use conditional grouping i.e "where (firstname = 'John' AND 'lastname = 'Doe') OR (firstname = 'Jane' AND lastname = 'Smith')" will fail.

Query

To use the Query Operation , you first need to create the SQL query.

Then run the query...

Contributing

Please report any issue you find in the issues page. Pull requests are more than welcome.

License

This project is licensed under the MIT licence - see the LICENSE.md file for details

Contributors

This package is based upon Clystnet/Vtiger

This project follows the all-contributors specification. Contributions of any kind welcome!

All versions of vtiger-laravel with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4|^8.0
ext-json Version *
guzzlehttp/guzzle Version ^7.4
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package jbtje/vtiger-laravel contains the following files

Loading the files please wait ....