Multi-User Support

The PHP SDK supports both single user and a multi-user app.

Multi-user App

Multi-users functionality is achieved using Initializer's static switchUser().

Copy to Clipboard
Initializer::switchUser($user, $environment, $token, $sdkConfig, $proxy);

To Remove a user's configuration in SDK. Use the below code

Copy to Clipboard
Initializer::removeUserConfiguration($user, $environment);

Copy to Clipboard
<?php
namespace multiuser;
use com\zoho\api\authenticator\OAuthToken;
use com\zoho\api\authenticator\TokenType;
use com\zoho\api\authenticator\store\FileStore;
use com\zoho\crm\api\Initializer;
use com\zoho\crm\api\UserSignature;
use com\zoho\crm\api\SDKConfigBuilder;
use com\zoho\crm\api\dc\USDataCenter;
use com\zoho\crm\api\logger\Logger;
use com\zoho\crm\api\logger\Levels;
use com\zoho\crm\api\HeaderMap;
use com\zoho\crm\api\ParameterMap;
use com\zoho\crm\api\record\RecordOperations;
use com\zoho\crm\api\record\GetRecordsHeader;
use com\zoho\crm\api\record\GetRecordsParam;
use com\zoho\crm\api\dc\EUDataCenter;
require_once 'vendor/autoload.php';
class MultiThread
{
    public function main()
    {
        $logger = Logger::getInstance(Levels::INFO, "/Users/user_name/Documents/php_sdk_log.log");
        $environment1 = USDataCenter::PRODUCTION();
        $user1 = new UserSignature("abc1@zoho.com");
        $tokenstore = new FileStore("/Users/user_name/Documents/php_sdk_token.txt");
        $token1 = new OAuthToken("clientId1", "clientSecrect1","REFRESH/GRANT token", TokenType.REFRESH/GRANT,"redirectURL1");
        $autoRefreshFields = false;
        $pickListValidation = false;
        // Create an instance of SDKConfig
        $sdkConfig = new SDKConfigBuilder()->setAutoRefreshFields($autoRefreshFields)->setPickListValidation($pickListValidation)->build();
        $resourcePath ="/Users/user_name/Documents/phpsdk-application";
        Initializer::initialize($user1, $environment1, $token1, $tokenstore, $sdkConfig, $resourcePath, $logger);
        $this->getRecords("Leads");
        $environment2 = EUDataCenter::PRODUCTION();
        $user2 = new UserSignature("abc2@zoho.eu");
        $token2 = new OAuthToken("clientId2", "clientSecrect2","REFRESH/GRANT token", TokenType.REFRESH/GRANT,"redirectURL2");
        $autoRefreshFields = false;
        Initializer::switchUser($user2, $environment2, $token2, $sdkConfig);
        // Initializer::removeUserConfiguration($user1, $environment1);
        $this->getRecords("Students");
        $autoRefreshFields = false;
        Initializer::switchUser($user1, $environment1, $token1, $sdkConfig);
        $this->getRecords("Contacts");
    }
    public function getRecords($moduleAPIName)
    {
        try
        {
            $recordOperations = new RecordOperations();
            $paramInstance = new ParameterMap();
            $paramInstance->add(GetRecordsParam::approved(), "false");
            $headerInstance = new HeaderMap();
            $ifmodifiedsince = date_create("2020-06-02T11:03:06+05:30")->setTimezone(new \DateTimeZone(date_default_timezone_get()));
            $headerInstance->add(GetRecordsHeader::IfModifiedSince(), $ifmodifiedsince);
            //Call getRecord method that takes paramInstance, moduleAPIName as parameter
            $response = $recordOperations->getRecords($moduleAPIName,$paramInstance, $headerInstance);
            echo($response->getStatusCode() . "\n");
            print_r($response->getObject());
            echo("\n");
        }
        catch (\Exception $e)
        {
            print_r($e);
        }
    }
}
$obj = new MultiThread();
$obj->main();
?>

1. The program execution starts from main().

2. The details of user1 is given in the variables user1, token1, environment1.

3. Similarly, the details of another user user2 is given in the variables user2, token2, environment2.

4. Then, the Switch user function is used to switch between the User 1 and User 2 as required.

5. Based on the latest switched user, the $this->getRecords($moduleAPIName) will fetch record.

SDK Sample Code

Copy to Clipboard
<?php
namespace index;
use com\zoho\api\authenticator\OAuthToken;
use com\zoho\api\authenticator\TokenType;
use com\zoho\api\authenticator\store\DBStore;
use com\zoho\api\authenticator\store\FileStore;
use com\zoho\crm\api\Initializer;
use com\zoho\crm\api\UserSignature;
use com\zoho\crm\api\SDKConfigBuilder;
use com\zoho\crm\api\dc\USDataCenter;
use com\zoho\crm\api\logger\Logger;
use com\zoho\crm\api\logger\Levels;
use com\zoho\crm\api\record\RecordOperations;
use com\zoho\crm\api\HeaderMap;
use com\zoho\crm\api\ParameterMap;
use com\zoho\crm\api\record\GetRecordsHeader;
use com\zoho\crm\api\record\GetRecordsParam;
use com\zoho\crm\api\record\ResponseWrapper;
require_once 'vendor/autoload.php';
class Record
{
    public static function getRecord()
    {
        /*
            * Create an instance of Logger Class that takes two parameters
            * 1 -> Level of the log messages to be logged. Can be configured by typing Levels "::" and choose any level from the list displayed.
            * 2 -> Absolute file path, where messages need to be logged.
        */
        $logger = Logger::getInstance(Levels::INFO, "/Users/user_name/Documents/php_sdk_log.log");
        //Create an UserSignature instance that takes user Email as parameter
        $user = new UserSignature("abc@zoho.com");
        /*
            * Configure the environment
            * which is of the pattern Domain.Environment
            * Available Domains: USDataCenter, EUDataCenter, INDataCenter, CNDataCenter, AUDataCenter
            * Available Environments: PRODUCTION(), DEVELOPER(), SANDBOX()
        */
        $environment = USDataCenter::PRODUCTION();
        //Create a Token instance
        $token = new OAuthToken("clientId", "clientSecrect", "redirectURL", "REFRESH/GRANT token", TokenType.REFRESH/GRANT);
        //Create an instance of TokenStore
        // $tokenstore = new DBStore();
        $tokenstore = new FileStore("/Users/user_name/Documents/php_sdk_token.txt");
        $autoRefreshFields = false;
        $pickListValidation = false;
        // Create an instance of SDKConfig
        $sdkConfig = new SDKConfigBuilder()->setAutoRefreshFields($autoRefreshFields)->setPickListValidation($pickListValidation)->build();
        $resourcePath ="/Users/user_name/Documents/phpsdk-application";
       /*
        * Call static initialize method of Initializer class that takes the following arguments
        * 1 -> UserSignature instance
        * 2 -> Environment instance
        * 3 -> Token instance
        * 4 -> TokenStore instance
        * 5 -> SDKConfig instance
        * 6 -> resourcePath -A String
        * 7 -> Log instance (optional)
        * 8 -> RequestProxy instance (optional)
        */
        Initializer::initialize($user, $environment, $token, $tokenstore, $sdkConfig, $resourcePath, $logger);
        try
        {
            $recordOperations = new RecordOperations();
            $paramInstance = new ParameterMap();
            $paramInstance->add(GetRecordsParam::approved(), "both");
            $headerInstance = new HeaderMap();
            $ifmodifiedsince = date_create("2020-06-02T11:03:06+05:30")->setTimezone(new \DateTimeZone(date_default_timezone_get()));
            $headerInstance->add(GetRecordsHeader::IfModifiedSince(), $ifmodifiedsince);
            $moduleAPIName = "Leads";
            //Call getRecord method that takes paramInstance, moduleAPIName as parameter
            $response = $recordOperations->getRecords($moduleAPIName,$paramInstance, $headerInstance);
            if($response != null)
            {
                //Get the status code from response
                echo("Status Code: " . $response->getStatusCode() . "\n");
                //Get object from response
                $responseHandler = $response->getObject();
                if($responseHandler instanceof ResponseWrapper)
                {
                    //Get the received ResponseWrapper instance
                    $responseWrapper = $responseHandler;
                    //Get the list of obtained Record instances
                    $records = $responseWrapper->getData();
                    if($records != null)
                    {
                        $recordClass = 'com\zoho\crm\api\record\Record';
                        foreach($records as $record)
                        {
                            //Get the ID of each Record
                            echo("Record ID: " . $record->getId() . "\n");
                            //Get the createdBy User instance of each Record
                            $createdBy = $record->getCreatedBy();
                            //Check if createdBy is not null
                            if($createdBy != null)
                            {
                                //Get the ID of the createdBy User
                                echo("Record Created By User-ID: " . $createdBy->getId() . "\n");
                                //Get the name of the createdBy User
                                echo("Record Created By User-Name: " . $createdBy->getName() . "\n");
                                //Get the Email of the createdBy User
                                echo("Record Created By User-Email: " . $createdBy->getEmail() . "\n");
                            }
                            //Get the CreatedTime of each Record
                            echo("Record CreatedTime: ");
                            print_r($record->getCreatedTime());
                            echo("\n");
                            //Get the modifiedBy User instance of each Record
                            $modifiedBy = $record->getModifiedBy();
                            //Check if modifiedBy is not null
                            if($modifiedBy != null)
                            {
                                //Get the ID of the modifiedBy User
                                echo("Record Modified By User-ID: " . $modifiedBy->getId() . "\n");
                                //Get the name of the modifiedBy User
                                echo("Record Modified By User-Name: " . $modifiedBy->getName() . "\n");
                                //Get the Email of the modifiedBy User
                                echo("Record Modified By User-Email: " . $modifiedBy->getEmail() . "\n");
                            }
                            //Get the ModifiedTime of each Record
                            echo("Record ModifiedTime: ");
                            print_r($record->getModifiedTime());
                            print_r("\n");
                            //Get the list of Tag instance each Record
                            $tags = $record->getTag();
                            //Check if tags is not null
                            if($tags != null)
                            {
                                foreach($tags as $tag)
                                {
                                    //Get the Name of each Tag
                                    echo("Record Tag Name: " . $tag->getName() . "\n");
                                    //Get the Id of each Tag
                                    echo("Record Tag ID: " . $tag->getId() . "\n");
                                }
                            }
                            //To get particular field value
                            echo("Record Field Value: " . $record->getKeyValue("Last_Name") . "\n");// FieldApiName
                            echo("Record KeyValues : \n" );
                            //Get the KeyValue map
                            foreach($record->getKeyValues() as $keyName => $value)
                            {
                                echo("Field APIName" . $keyName . " \tValue : ");
                                print_r($value);
                                echo("\n");
                            }
                        }
                    }
                }
            }
        }
        catch (\Exception $e)
        {
            print_r($e);
        }
    }
}
Record::getRecord();
?>

Record Response