PHP SDK Samples - Variable Groups Operations
Get All Variable Groups
<?php
namespace samples\variablegroups;
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\variablegroups\APIException;
use com\zoho\crm\api\variablegroups\ResponseWrapper;
use com\zoho\crm\api\variablegroups\VariableGroupsOperations;
require_once "vendor/autoload.php";
class GetVariableGroups
{
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 getVariableGroups()
{
$variableGroupsOperations = new VariableGroupsOperations();
$response = $variableGroupsOperations->getVariableGroups();
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;
$variableGroups = $responseWrapper->getVariableGroups();
if($variableGroups != null)
{
foreach($variableGroups as $variableGroup)
{
echo("VariableGroup DisplayLabel: " . $variableGroup->getDisplayLabel() . "\n");
echo("VariableGroup APIName: " . $variableGroup->getAPIName() . "\n");
echo("VariableGroup Name: " . $variableGroup->getName() . "\n");
echo("VariableGroup Description: " . $variableGroup->getDescription() . "\n");
echo("VariableGroup ID: " . $variableGroup->getId() . "\n");
}
}
}
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");
}
}
}
}
GetVariableGroups::initialize();
GetVariableGroups::getVariableGroups();
?>
Get a Variable Group by its Group ID
<?php
namespace samples\variablegroups;
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\variablegroups\APIException;
use com\zoho\crm\api\variablegroups\ResponseWrapper;
use com\zoho\crm\api\variablegroups\VariableGroupsOperations;
require_once "vendor/autoload.php";
class GetVariableGroupById
{
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 getVariableGroupById(string $variableGroupId)
{
$variableGroupsOperations = new VariableGroupsOperations();
$response = $variableGroupsOperations->getVariableGroupById($variableGroupId);
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;
$variableGroups = $responseWrapper->getVariableGroups();
if($variableGroups != null)
{
foreach($variableGroups as $variableGroup)
{
echo("VariableGroup DisplayLabel: " . $variableGroup->getDisplayLabel() . "\n");
echo("VariableGroup APIName: " . $variableGroup->getAPIName() . "\n");
echo("VariableGroup Name: " . $variableGroup->getName() . "\n");
echo("VariableGroup Description: " . $variableGroup->getDescription() . "\n");
echo("VariableGroup ID: " . $variableGroup->getId() . "\n");
}
}
}
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");
}
}
}
}
GetVariableGroupById::initialize();
$variableGroupId = "34770613089001";
GetVariableGroupById::getVariableGroupById($variableGroupId);
?>
Get a Variable Group by its API Name
<?php
namespace samples\variablegroups;
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\variablegroups\APIException;
use com\zoho\crm\api\variablegroups\ResponseWrapper;
use com\zoho\crm\api\variablegroups\VariableGroupsOperations;
require_once "vendor/autoload.php";
class GetVariableGroupByAPIName
{
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 getVariableGroupByAPIName(string $variableGroupName)
{
$variableGroupsOperations = new VariableGroupsOperations();
$response = $variableGroupsOperations->getVariableGroupByAPIName($variableGroupName);
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;
$variableGroups = $responseWrapper->getVariableGroups();
if($variableGroups != null)
{
foreach($variableGroups as $variableGroup)
{
echo("VariableGroup DisplayLabel: " . $variableGroup->getDisplayLabel() . "\n");
echo("VariableGroup APIName: " . $variableGroup->getAPIName() . "\n");
echo("VariableGroup Name: " . $variableGroup->getName() . "\n");
echo("VariableGroup Description: " . $variableGroup->getDescription() . "\n");
echo("VariableGroup ID: " . $variableGroup->getId() . "\n");
}
}
}
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");
}
}
}
}
GetVariableGroupByAPIName::initialize();
$variableGroupId = "34770613089001";
GetVariableGroupByAPIName::getVariableGroupByAPIName($variableGroupId);
?>