PHP SDK Samples - Bulk Read Operations

              Copy to Clipboard
              
<?php
namespace samples\bulkread;

use com\zoho\api\authenticator\OAuthBuilder;
use com\zoho\crm\api\dc\USDataCenter;
use com\zoho\crm\api\InitializeBuilder;
use com\zoho\crm\api\UserSignature;
use com\zoho\crm\api\bulkread\BulkReadOperations;
use com\zoho\crm\api\bulkread\CallBack;
use com\zoho\crm\api\util\Choice;
use com\zoho\crm\api\bulkread\Query;
use com\zoho\crm\api\bulkread\Criteria;
use com\zoho\crm\api\bulkread\ActionWrapper;
use com\zoho\crm\api\bulkread\SuccessResponse;
use com\zoho\crm\api\bulkread\APIException;
use com\zoho\crm\api\bulkread\RequestWrapper;
use com\zoho\crm\api\modules\Module;
use com\zoho\crm\api\fields\Field;
require_once "vendor/autoload.php";

class CreateBulkReadJob
{
    public static function initialize()
    {
        $user = new UserSignature('myname@mydomain.com');
        $environment = USDataCenter::PRODUCTION();
        $token = (new OAuthBuilder())
        ->clientId("1000.xxxx")
        ->clientSecret("xxxxxx")
        ->refreshToken("1000.xxxxx.xxxxx")
        ->build();
        (new InitializeBuilder())
            ->user($user)
            ->environment($environment)
            ->token($token)
            ->initialize();
    }

	public static function createBulkReadJob(string $moduleAPIName)
	{
		$bulkReadOperations = new BulkReadOperations();
		$requestWrapper = new RequestWrapper();
		$callback = new CallBack();
		$callback->setUrl("https://www.example.com/callback");
		$callback->setMethod(new Choice("post"));
		$requestWrapper->setCallback($callback);
        $query = new Query();
        $module = new Module();
        $module->setAPIName($moduleAPIName);
		$query->setModule($module);
		// $query->setCvid("34770610087501");
		$fieldAPINames = array();
		array_push($fieldAPINames, "Last_Name");
		$query->setFields($fieldAPINames);
		$query->setPage(1);
		$criteria = new Criteria();
        $criteria->setGroupOperator(new Choice("or"));
		$criteriaList = array();
		$group11 = new Criteria();
		$group11->setGroupOperator(new Choice("and"));
		$groupList11 = array();
        $group111 = new Criteria();
        $field = new Field();
        $field->setAPIName("Last_Name");
		$group111->setField($field);
		$group111->setComparator(new Choice("equal"));
		$group111->setValue("TestPHPSDK");
		array_push($groupList11, $group111);
        $group112 = new Criteria();
        $field = new Field();
        $field->setAPIName("Owner");
		$group112->setField($field);
		$group112->setComparator(new Choice("in"));
		$owner = array("34770610173021");
		$group112->setValue($owner);
		array_push($groupList11, $group112);
		$group11->setGroup($groupList11);
		array_push($criteriaList, $group11);
		$group12 = new Criteria();
		$group12->setGroupOperator(new Choice("or"));
		$groupList12 = array();
        $group121 = new Criteria();
        $field = new Field();
        $field->setAPIName("Company");
		$group121->setField($field);
		$group121->setComparator(new Choice("equal"));
		$group121->setValue("KK");
		array_push($groupList12, $group121);
        $group122 = new Criteria();
        $field = new Field();
        $field->setAPIName("Created_Time");
		$group122->setField($field);
		$group122->setComparator(new Choice("between"));
		$createdTime = array(date_create("2020-07-15T17:58:47+05:30")->setTimezone(new \DateTimeZone(date_default_timezone_get())), date_create("2020-10-15T17:58:47+05:30")->setTimezone(new \DateTimeZone(date_default_timezone_get())));
		$group122->setValue($createdTime);
		array_push($groupList12, $group122);
		$group12->setGroup($groupList12);
		array_push($criteriaList, $group12);
		$criteria->setGroup($criteriaList);
		$query->setCriteria($criteria);
		$requestWrapper->setQuery($query);
		// $requestWrapper->setFileType(new Choice("ics"));
        $response = $bulkReadOperations->createBulkReadJob($requestWrapper);
        if($response != null)
        {
            echo("Status code : " . $response->getStatusCode() . "\n");
            $actionHandler = $response->getObject();
            if($actionHandler instanceof ActionWrapper)
            {
                $actionWrapper = $actionHandler;
                $actionResponses = $actionWrapper->getData();
                foreach ($actionResponses as $actionResponse)
                {
                    if($actionResponse instanceof SuccessResponse)
                    {
                        $successResponse = $actionResponse;
                        echo("Status: " . $successResponse->getStatus()->getValue(). "\n");
                        echo("Code: " . $successResponse->getCode()->getValue(). "\n");
                        echo("Details: " );
                        foreach($successResponse->getDetails() as $key => $value)
                        {
                            echo($key . " : " ); print_r($value); echo("\n");
                        }
                        echo("Message: " . $successResponse->getMessage()->getValue(). "\n");
                    }
                    else if($actionResponse instanceof APIException)
                    {
                        $exception = $actionResponse;
                        echo("Status: " . $exception->getStatus()->getValue(). "\n");
                        echo("Code: " . $exception->getCode()->getValue(). "\n");
                        echo("Details: " );
                        foreach($exception->getDetails() as $key => $value)
                        {
                            echo($key . " : " ); print_r($value); echo("\n");
                        }
                        echo("Message: " . $exception->getMessage()->getValue(). "\n");
                    }
                }
            }
            else if($actionHandler instanceof APIException)
            {
            $exception = $actionHandler;
            echo("Status: " . $exception->getStatus()->getValue(). "\n");
            echo("Code: " . $exception->getCode()->getValue(). "\n");
            echo("Details: " );
            foreach($exception->getDetails() as $key => $value)
            {
                echo($key . " : " ); print_r($value); echo("\n");
            }
            echo("Message: " . $exception->getMessage()->getValue(). "\n");
            }
        }
    }
}

CreateBulkReadJob::initialize();
$moduleAPIName = "Leads";
CreateBulkReadJob::createBulkReadJob($moduleAPIName);

 

              Copy to Clipboard
              
<?php
namespace samples\bulkread;

use com\zoho\api\authenticator\OAuthBuilder;
use com\zoho\crm\api\dc\USDataCenter;
use com\zoho\crm\api\InitializeBuilder;
use com\zoho\crm\api\UserSignature;
use com\zoho\crm\api\bulkread\BulkReadOperations;
use com\zoho\crm\api\bulkread\ResponseWrapper;
use com\zoho\crm\api\bulkread\Criteria;
use com\zoho\crm\api\bulkread\APIException;
require_once "vendor/autoload.php";

class GetBulkReadJobDetails
{
    public static function initialize()
    {
        $user = new UserSignature('myname@mydomain.com');
        $environment = USDataCenter::PRODUCTION();
        $token = (new OAuthBuilder())
        ->clientId("1000.xxxx")
        ->clientSecret("xxxxxx")
        ->refreshToken("1000.xxxxx.xxxxx")
        ->build();
        (new InitializeBuilder())
            ->user($user)
            ->environment($environment)
            ->token($token)
            ->initialize();
    }

	public static function getBulkReadJobDetails(string $jobId)
	{
		$bulkReadOperations = new BulkReadOperations();
        $response = $bulkReadOperations->getBulkReadJobDetails($jobId);
        if($response != null)
		{
            echo("Status code " . $response->getStatusCode() . "\n");
            if(in_array($response->getStatusCode(), array(204, 304)))
            {
                echo($response->getStatusCode() == 204? "No Content\n" : "Not Modified\n");
                return;
            }
            $responseHandler = $response->getObject();
            if($responseHandler instanceof ResponseWrapper)
            {
                $responseWrapper = $responseHandler;
                $jobDetails = $responseWrapper->getData();
                foreach($jobDetails as $jobDetail)
                {
                    echo("Bulkread Job ID: " . $jobDetail->getId(). "\n");
                    echo("Bulkread Operation: " . $jobDetail->getOperation(). "\n");
                    echo("Bulkread State: " . $jobDetail->getState()->getValue(). "\n");
                    $result = $jobDetail->getResult();
                    if($result != null)
                    {
                        echo("Bulkread Result Page: " . $result->getPage(). "\n");
                        echo("Bulkread Result Count: " . $result->getCount(). "\n");
                        echo("Bulkread Result Download URL: " . $result->getDownloadUrl(). "\n");
                        echo("Bulkread Result Per_Page: " . $result->getPerPage(). "\n");
                        echo("Bulkread Result MoreRecords: " . $result->getMoreRecords(). "\n");
                    }
                    $query = $jobDetail->getQuery();
                    if($query != null)
                    {
                        $fields = $query->getFields();
                        if($fields != null)
                        {
                            foreach($fields as $fieldName)
                            {
                                echo("Bulkread Query Fields: " . $fieldName. "\n");
                            }
                        }
                        $module = $query->getModule();
                        if($module != null)
                        {
                            echo("Bulkread Query Module Name : " . $module->getAPIName() . "\n");
                            echo("Bulkread Query Module Id : " . $module->getId() . "\n");
                        }
                        $criteria = $query->getCriteria();
                        if($criteria != null)
                        {
                            GetBulkReadJobDetails::printCriteria($criteria);
                        }
                        echo("Bulkread Query Page: " . $query->getPage(). "\n");
                        echo("Bulkread Query cvid: " . $query->getCvid(). "\n");
                    }
                    $createdBy = $jobDetail->getCreatedBy();
                    if($createdBy != null)
                    {
                        echo("Bulkread Created By User-ID: " . $createdBy->getId(). "\n");
                        echo("Bulkread Created By user-Name: " . $createdBy->getName(). "\n");
                    }
                    echo("Bulkread CreatedTime: " ); print_r($jobDetail->getCreatedTime()); echo("\n");
                    echo("Bulkread File Type: " . $jobDetail->getFileType(). "\n");
                }
            }
            else if($responseHandler instanceof APIException)
            {
                $exception = $responseHandler;
                echo("Status: " . $exception->getStatus()->getValue(). "\n");
                echo("Code: " . $exception->getCode()->getValue(). "\n");
                echo("Details: " );
                foreach($exception->getDetails() as $key => $value)
                {
                    echo($key . " : " . $value . "\n");
                }
                echo("Message: " . $exception->getMessage()->getValue(). "\n");
            }
        }
    }
	private static function printCriteria(Criteria $criteria)
    {
        $field = $criteria->getField();
        if($field != null)
        {
            echo("Bulkread Query Criteria Field Id: " . $field->getId(). "\n");
            echo("Bulkread Query Criteria Field APIName: " . $field->getAPIName(). "\n");
        }
		if($criteria->getComparator()!= null)
		{
			echo("Bulkread Query Criteria Comparator: " . $criteria->getComparator()->getValue(). "\n");
		}
		if($criteria->getValue() != null)
		{
            echo("Bulkread Query Criteria Value: "); print_r($criteria->getValue()); echo("\n");
		}
		$criteriaGroup = $criteria->getGroup();
		if($criteriaGroup != null)
		{
			foreach($criteriaGroup as $criteria1)
			{
				GetBulkReadJobDetails::printCriteria($criteria1);
			}
		}
		if($criteria->getGroupOperator() != null)
		{
			echo("Bulkread Query Criteria Group Operator: " . $criteria->getGroupOperator()->getValue(). "\n");
		}
    }
}

GetBulkReadJobDetails::initialize();
$jobId = "347706118193001";
GetBulkReadJobDetails::getBulkReadJobDetails($jobId);
 

              Copy to Clipboard
              
<?php
namespace samples\bulkread;

use com\zoho\api\authenticator\OAuthBuilder;
use com\zoho\crm\api\dc\USDataCenter;
use com\zoho\crm\api\InitializeBuilder;
use com\zoho\crm\api\UserSignature;
use com\zoho\crm\api\bulkread\BulkReadOperations;
use com\zoho\crm\api\bulkread\APIException;
use com\zoho\crm\api\bulkread\FileBodyWrapper;
require_once "vendor/autoload.php";

class DownloadResult
{
    public static function initialize()
    {
        $user = new UserSignature('myname@mydomain.com');
        $environment = USDataCenter::PRODUCTION();
        $token = (new OAuthBuilder())
        ->clientId("1000.xxxx")
        ->clientSecret("xxxxxx")
        ->refreshToken("1000.xxxxx.xxxxx")
        ->build();
        (new InitializeBuilder())
            ->user($user)
            ->environment($environment)
            ->token($token)
            ->initialize();
    }

	public static function downloadResult(string $jobId, string $destinationFolder)
	{
		$bulkReadOperations = new BulkReadOperations();
        $response = $bulkReadOperations->downloadResult($jobId);
        if($response != null)
		{
            echo("Status code " . $response->getStatusCode() . "\n");
            if(in_array($response->getStatusCode(), array(204, 304)))
            {
                echo($response->getStatusCode() == 204? "No Content\n" : "Not Modified\n");
                return;
            }
            $responseHandler = $response->getObject();
            if($responseHandler instanceof FileBodyWrapper)
            {
                $fileBodyWrapper = $responseHandler;
                $streamWrapper = $fileBodyWrapper->getFile();
                $fp = fopen($destinationFolder."/".$streamWrapper->getName(), "w");
                $stream = $streamWrapper->getStream();
                fputs($fp, $stream);
                fclose($fp);
            }
            else if($responseHandler instanceof APIException)
            {
                $exception = $responseHandler;
                echo("Status: " . $exception->getStatus()->getValue() . "\n");
                echo("Code: " . $exception->getCode()->getValue() . "\n");
                if($exception->getDetails() != null)
                {
                    echo("Details: \n");
                    foreach ($exception->getDetails() as $keyName => $keyValue)
                    {
                        echo($keyName . ": " . $keyValue . "\n");
                    }
                }
                echo("Message: " . $exception->getMessage()->getValue() . "\n");
            }
        }
    }
}

DownloadResult::initialize();
$jobId = "347706118193001";
$destinationFolder = "/Documents";
DownloadResult::downloadResult($jobId, $destinationFolder);