freemancontingent/zohoreports-sdk

ZohoReports PHP SDK

UPDATE

This repo is for an outdated version of Zoho API., _(*1)

Zoho Reports PHP SDK

This is a PHP SDK that provides integration with Zoho Reports through their API., _(*2)

v0.1 - Features

• Import csv to Zoho Reports

Require

The only requirement is PHP >=5.5.0, _(*3)

Installing via Composer

The raccomended way is to install ZohoReports-SDK is through Composer., _(*4)

Please refer to Getting Started on how to download and install Composer., _(*5)

After you have downloaded/installed Composer, run, _(*6)

composer.phar require freemancontingent/zohoreports-sdk

or add it in your composer.json, _(*7)

{
    "require": {
        "freemancontingent/zohoreports-sdk": "dev-master"
    }
}

Prerequisites

You should have a valid Zoho login email address to use the API. If you do not have one, please Sign up into Zoho Reports and create a login., _(*8)

• Email - the Zoho Account email address
• Authtoken - How to generate a Zoho Authtoken for Zoho Reports
• Database - a database needs to be created in Zoho Reports

How to

INIT

You must provide your Zoho email, your Database name (the database in Zoho Reports), and your Zoho Authtoken, _(*9)

$zoho = new ZohoReports\ZohoReports('my-zoho-email', 'my-db', 'my-authtoken');

Import data to your Zoho Reports Database

The import is highly customizable, it supports almost all the different configurations provided by the Zoho Reports API., _(*10)

In most of the cases this will suits your need., _(*11)

$res = $zoho->import('somefile.csv', 'My-Table');

The first parameter is the full path to your csv file, the second parameter is the table in your Zoho Reports Database where your data will be imported., _(*12)

This will truncate My-Table in your Zoho Reports Database and import all the data from somefile.csv. If My-Table doesn't exists, it will be created., _(*13)

You can pass parameters (an array of parameters) to the import function that will override the default settings., _(*14)

$res = $zoho->import('somefile.csv', 'My-Table', ['param1' => 'my-value', ...]);

Parameters

Constraints

When defining your own parameters, in some case you need to provide more informations., _(*15)

• If type is 'UPDATEADD', you must provide a pk param, that defines your primary key, or your matching column used for comparison
• If format is CSV and autoIdentify is 'false', you must provide:
  • csvCommentChar, the comment char used in your csv file
  • csvDelimeter, the values delimeter, that can be set to:
    • 0 for COMMA
    • 1 for TAB
    • 2 for SEMICOLON
    • 3 for SPACE
  • csvQuoted, the text qualifier, that can be set to:
    • 0 for none
    • 1 for SINGLE QUOTE
    • 2 for DOUBLE QUOTE

Exceptions

There are two type of exception:, _(*16)

• InvalidParamsException, thrown if the params you have passed to the import function are invalid - Eg. $param['type'] = 'UPDATEADD' and you haven't provided $param['pk']
• InvalidFileException, thrown if the file you have passed doesn't exist

Examples

Include the ZohoReports.php file in your project, or if you prefer using an autoloader have a look at test.php, _(*17)

Simple import with default params, from csv file

$zoho = new ZohoReports\ZohoReports('my-zoho-email', 'my-db', 'my-authtoken');

try {
  $res = $zoho->import('path/to/somefile.csv', 'My-Table');
} catch(Exception $e) {
  echo $e->getMessage();
  exit();
}

Import type 'UPDATEADD'

$zoho = new ZohoReports\ZohoReports('my-zoho-email', 'my-db', 'my-authtoken');

try {
  $res = $zoho->import('path/to/somefile.csv', 'My-Table', [
    'type' => 'UPDATEADD',
    'pk'   => 'id'
  ]);
} catch(Exception $e) {
  echo $e->getMessage();
  exit();
}

Import multiple files

$zoho = new ZohoReports\ZohoReports('my-zoho-email', 'my-db', 'my-authtoken');

$myFilesToImport = [
  'path/to/movies.csv' => 'movie_id',
  'path/to/actors.csv' => 'actor_id',
  'path/to/genres.csv' => 'genre_id'
];

foreach ($myFilesToImport as $path => $pk) {
  try {
    $res = $zoho->import($path, basename($path), [
      'type' => 'UPDATEADD',
      'pk'   => $pk
    ]);
  } catch(ZohoReport\InvalidFileException $e) {
    myLogger("File {$path} not imported. Exception: {$e->getMessage()}");
    continue;
  } catch(ZohoReport\InvalidParamsException $e) {
    myLogger("Wrong parameter for {$path}. {$e->getMessage()}");
    exit();
  }
}