PHP SDK Samples - Modules Operations
Get Modules
Get a Module
<?php
namespace com\zoho\crm\sample\modules;
use com\zoho\crm\api\HeaderMap;
use com\zoho\crm\api\modules\APIException;
use com\zoho\crm\api\modules\ActionWrapper;
use com\zoho\crm\api\modules\BodyWrapper;
use com\zoho\crm\api\modules\Module;
use com\zoho\crm\api\modules\ModulesOperations;
use com\zoho\crm\api\modules\ResponseWrapper;
use com\zoho\crm\api\modules\SuccessResponse;
use com\zoho\crm\api\profiles\Profile;
use com\zoho\crm\api\modules\GetModulesHeader;
class Modules
{
/**
* Get Module
* This method is used to get metadata about single module with it's API Name and print the response.
* @param apiName The API Name of the module to obtain metadata
* @throws Exception
*/
public static function getModule(string $moduleAPIName)
{
//example, moduleAPIName = "Leads";
//Get instance of ModulesOperations Class
$moduleOperations = new ModulesOperations();
//Call getModule method that takes moduleAPIName as parameter
$response = $moduleOperations->getModule($moduleAPIName);
if($response != null)
{
//Get the status code from response
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;
}
//Get object from response
$responseHandler = $response->getObject();
if($responseHandler instanceof ResponseWrapper)
{
//Get the received ResponseWrapper instance
$responseWrapper = $responseHandler;
//Get the list of obtained Module instances
$modules = $responseWrapper->getModules();
foreach($modules as $module)
{
//Get the Name of each Module
echo("Module Name: " . $module->getName() . "\n");
//Get the GlobalSearchSupported of each Module
echo("Module GlobalSearchSupported: " . $module->getGlobalSearchSupported() . "\n");
//Get the KanbanView of each Module
echo("Module KanbanView: " . $module->getKanbanView() . "\n");
//Get the Deletable of each Module
echo("Module Deletable: " . $module->getDeletable() . "\n");
//Get the Description of each Module
echo("Module Description: " . $module->getDescription() . "\n");
//Get the Creatable of each Module
echo("Module Creatable: " . $module->getCreatable() . "\n");
//Get the FilterStatus of each Module
echo("Module FilterStatus: " . $module->getFilterStatus() . "\n");
//Get the InventoryTemplateSupported of each Module
echo("Module InventoryTemplateSupported: " . $module->getInventoryTemplateSupported() . "\n");
if($module->getModifiedTime() != null)
{
//Get the ModifiedTime of each Module
echo("Module ModifiedTime: ");
print_r($module->getModifiedTime());
echo("\n");
}
//Get the PluralLabel of each Module
echo("Module PluralLabel: " . $module->getPluralLabel() . "\n");
//Get the PresenceSubMenu of each Module
echo("Module PresenceSubMenu: " . $module->getPresenceSubMenu() . "\n");
//Get the TriggersSupported of each Module
echo("Module TriggersSupported: " . $module->getTriggersSupported() . "\n");
//Get the Id of each Module
echo("Module Id: " . $module->getId() . "\n");
//Get the RelatedListProperties instance of each Module
$relatedListProperties = $module->getRelatedListProperties();
//Check if relatedListProperties is not null
if($relatedListProperties != null)
{
//Get the SortBy of each RelatedListProperties
echo("Module RelatedListProperties SortBy: " . $relatedListProperties->getSortBy() . "\n");
//Get List of fields APIName
$fields = $relatedListProperties->getFields();
//Check if fields is not null
if($fields != null)
{
foreach($fields as $fieldName)
{
//Get the Field Name
echo("Module RelatedListProperties Fields: " . $fieldName . "\n");
}
}
//Get the Name of RelatedListProperties
echo("Module RelatedListProperties SortOrder: " . $relatedListProperties->getSortOrder() . "\n");
}
//Get List of properties field APIName
$properties = $module->getProperties();
//Check if properties is not null
if($properties != null)
{
foreach($properties as $fieldName)
{
//Get the Field Name
echo("Module Properties Fields: " . $fieldName . "\n");
}
}
//Get the PerPage of each Module
echo("Module PerPage: " . $module->getPerPage() . "\n");
//Get the Visibility of each Module
echo("Module Visibility: " . $module->getVisibility() . "\n");
//Get the Convertable of each Module
echo("Module Convertable: " . $module->getConvertable() . "\n");
//Get the Editable of each Module
echo("Module Editable: " . $module->getEditable() . "\n");
//Get the EmailtemplateSupport of each Module
echo("Module EmailtemplateSupport: " . $module->getEmailtemplateSupport() . "\n");
//Get the list of Profile instance each Module
$profiles = $module->getProfiles();
//Check if profiles is not null
if($profiles != null)
{
foreach($profiles as $profile)
{
//Get the Name of each Profile
echo("Module Profile Name: " . $profile->getName() . "\n");
//Get the Id of each Profile
echo("Module Profile Id: " . $profile->getId() . "\n");
}
}
//Get the FilterSupported of each Module
echo("Module FilterSupported: " . $module->getFilterSupported() . "\n");
//Get the DisplayField of each Module
echo("Module DisplayField: " . $module->getDisplayField() . "\n");
//Get List of SearchLayoutFields APIName
$searchLayoutFields = $module->getSearchLayoutFields();
//Check if searchLayoutFields is not null
if($searchLayoutFields != null)
{
foreach($searchLayoutFields as $fieldName)
{
//Get the Field Name
echo("Module SearchLayoutFields Fields: " . $fieldName . "\n");
}
}
//Get the KanbanViewSupported of each Module
echo("Module KanbanViewSupported: " . $module->getKanbanViewSupported() . "\n");
//Get the ShowAsTab of each Module
echo("Module ShowAsTab: " . $module->getShowAsTab() . "\n");
//Get the WebLink of each Module
echo("Module WebLink: " . $module->getWebLink() . "\n");
//Get the SequenceNumber of each Module
echo("Module SequenceNumber: " . $module->getSequenceNumber() . "\n");
//Get the SingularLabel of each Module
echo("Module SingularLabel: " . $module->getSingularLabel() . "\n");
//Get the Viewable of each Module
echo("Module Viewable: " . $module->getViewable() . "\n");
//Get the APISupported of each Module
echo("Module APISupported: " . $module->getAPISupported() . "\n");
//Get the APIName of each Module
echo("Module APIName: " . $module->getAPIName() . "\n");
//Get the QuickCreate of each Module
echo("Module QuickCreate: " . $module->getQuickCreate() . "\n");
//Get the modifiedBy User instance of each Module
$modifiedBy = $module->getModifiedBy();
//Check if modifiedBy is not null
if($modifiedBy != null)
{
//Get the name of the modifiedBy User
echo("Module Modified By User-Name: " . $modifiedBy->getName() . "\n");
//Get the ID of the modifiedBy User
echo("Module Modified By User-ID: " . $modifiedBy->getId() . "\n");
}
//Get the GeneratedType of each Module
echo("Module GeneratedType: " . $module->getGeneratedType()->getValue() . "\n");
//Get the FeedsRequired of each Module
echo("Module FeedsRequired: " . $module->getFeedsRequired() . "\n");
//Get the ScoringSupported of each Module
echo("Module ScoringSupported: " . $module->getScoringSupported() . "\n");
//Get the WebformSupported of each Module
echo("Module WebformSupported: " . $module->getWebformSupported() . "\n");
//Get the list of Argument instance each Module
$arguments = $module->getArguments();
//Check if arguments is not null
if($arguments != null)
{
foreach($arguments as $argument)
{
//Get the Name of each Argument
echo("Module Argument Name: " . $argument->getName() . "\n");
//Get the Value of each Argument
echo("Module Argument Value: " . $argument->getValue() . "\n");
}
}
//Get the ModuleName of each Module
echo("Module ModuleName: " . $module->getModuleName() . "\n");
//Get the BusinessCardFieldLimit of each Module
echo("Module BusinessCardFieldLimit: " . $module->getBusinessCardFieldLimit() . "\n");
//Get the CustomView instance of each Module
$customView = $module->getCustomView();
//Check if customView is not null
if($customView != null)
{
self::printCustomView($customView);
}
//Get the parentModule Module instance of each Module
$parentModule = $module->getParentModule();
//Check if arguments is not null
if($parentModule != null && $parentModule->getAPIName() != null)
{
//Get the Name of Parent Module
echo("Module Parent Module Name: " . $parentModule->getAPIName() . "\n");
//Get the Value of Parent Module
echo("Module Parent Module Id: " . $parentModule->getId() . "\n");
}
}
}
//Check if the request returned an exception
else if($responseHandler instanceof APIException)
{
//Get the received APIException instance
$exception = $responseHandler;
//Get the Status
echo("Status: " . $exception->getStatus()->getValue() . "\n");
//Get the Code
echo("Code: " . $exception->getCode()->getValue() . "\n");
if($exception->getDetails() != null)
{
echo("Details: " );
//Get the details map4
foreach($exception->getDetails() as $key => $value)
{
//Get each value in the map
echo($key . ": " .$value . "\n");
}
}
//Get the Message
echo("Message: " . $exception->getMessage()->getValue() . "\n");
}
}
}
private static function printCustomView($customView)
{
//Get the DisplayValue of the CustomView
echo("Module CustomView DisplayValue: " . $customView->getDisplayValue() . "\n");
//Get the SharedType of the CustomView
echo("Module CustomView SharedType: " . $customView->getSharedType() . "\n");
//Get the SystemName of the CustomView
echo("Module CustomView SystemName: " . $customView->getSystemName() . "\n");
// Get the Criteria instance of the CustomView
$criteria = $customView->getCriteria();
//Check if criteria is not null
if($criteria != null)
{
self::printCriteria($criteria);
}
//Get the list of SharedDetails instance of the CustomView
$sharedDetails = $customView->getSharedDetails();
if($sharedDetails != null)
{
foreach($sharedDetails as $sharedDetail)
{
//Get the Name of the each SharedDetails
echo("Module SharedDetails Name: " . $sharedDetail->getName() . "\n");
//Get the ID of the each SharedDetails
echo("Module SharedDetails ID: " . $sharedDetail->getId() . "\n");
//Get the Type of the each SharedDetails
echo("Module SharedDetails Type: " . $sharedDetail->getType() . "\n");
//Get the Subordinates of the each SharedDetails
echo("Module SharedDetails Subordinates: " . $sharedDetail->getSubordinates() . "\n");
}
}
//Get the SortBy of the CustomView
echo("Module CustomView SortBy: " . $customView->getSortBy() . "\n");
//Get the Offline of the CustomView
echo("Module CustomView Offline: " . $customView->getOffline() . "\n");
//Get the Default of the CustomView
echo("Module CustomView Default: " . $customView->getDefault() . "\n");
//Get the SystemDefined of the CustomView
echo("Module CustomView SystemDefined: " . $customView->getSystemDefined() . "\n");
//Get the Name of the CustomView
echo("Module CustomView Name: " . $customView->getName() . "\n");
//Get the ID of the CustomView
echo("Module CustomView ID: " . $customView->getId() . "\n");
//Get the Category of the CustomView
echo("Module CustomView Category: " . $customView->getCategory() . "\n");
//Get the list of string
$fields = $customView->getFields();
if($fields != null)
{
foreach($fields as $field)
{
echo($field . "\n");
}
}
if($customView->getFavorite() != null)
{
//Get the Favorite of the CustomView
echo("Module CustomView Favorite: " . $customView->getFavorite() . "\n");
}
if($customView->getSortOrder() != null)
{
//Get the SortOrder of the CustomView
echo("Module CustomView SortOrder: " . $customView->getSortOrder() . "\n");
}
}
private static function printCriteria($criteria)
{
if($criteria->getComparator() != null)
{
//Get the Comparator of the Criteria
echo("Module CustomView Criteria Comparator: " . $criteria->getComparator()->getValue() . "\n");
}
//Get the Field of the Criteria
echo("Module CustomView Criteria Field: " . $criteria->getField() . "\n");
if($criteria->getValue() != null)
{
//Get the Value of the Criteria
echo("Module CustomView Criteria Value: " . $criteria->getValue() . "\n");
}
// Get the List of Criteria instance of each Criteria
$criteriaGroup = $criteria->getGroup();
if($criteriaGroup != null)
{
foreach($criteriaGroup as $criteria1)
{
self::printCriteria($criteria1);
}
}
if($criteria->getGroupOperator() != null)
{
//Get the Group Operator of the Criteria
echo("Module CustomView Criteria Group Operator: " . $criteria->getGroupOperator()->getValue() . "\n");
}
}
}
Update the Module by its Module API Name
<?php
namespace com\zoho\crm\sample\modules;
use com\zoho\crm\api\HeaderMap;
use com\zoho\crm\api\modules\APIException;
use com\zoho\crm\api\modules\ActionWrapper;
use com\zoho\crm\api\modules\BodyWrapper;
use com\zoho\crm\api\modules\Module;
use com\zoho\crm\api\modules\ModulesOperations;
use com\zoho\crm\api\modules\ResponseWrapper;
use com\zoho\crm\api\modules\SuccessResponse;
use com\zoho\crm\api\profiles\Profile;
use com\zoho\crm\api\modules\GetModulesHeader;
class Modules
{
/**
* Update Module By APIName
* This method is used to update module details using module APIName and print the response.
* @param moduleAPIName The API Name of the module that you want to update
* @throws Exception
*/
public static function updateModuleByAPIName(string $moduleAPIName)
{
//example, apiName = "Leads";
//Get instance of ModulesOperations Class
$moduleOperations = new ModulesOperations();
$modules = array();
$profiles = array();
//Get instance of Profile Class
$profile = new Profile();
//To set the Profile Id
$profile->setId("34770610026014");
$profile->setDelete(true);
array_push($profiles, $profile);
$module = new Module();
$module->setProfiles($profiles);
array_push($modules , $module);
$request = new BodyWrapper();
$request->setModules($modules);
//Call updateModuleByAPIName method that takes BodyWrapper instance and moduleAPIName as parameter
$response = $moduleOperations->updateModuleByAPIName($moduleAPIName,$request);
if($response != null)
{
//Get the status code from response
echo("Status code " . $response->getStatusCode() . "\n");
//Get object from response
$actionHandler = $response->getObject();
if($actionHandler instanceof ActionWrapper)
{
//Get the received ActionWrapper instance
$actionWrapper = $actionHandler;
//Get the list of obtained ActionResponse instances
$actionResponses = $actionWrapper->getModules();
foreach ($actionResponses as $actionResponse)
{
//Check if the request is successful
if($actionResponse instanceof SuccessResponse)
{
//Get the received SuccessResponse instance
$successResponse = $actionResponse;
//Get the Status
echo("Status: " . $successResponse->getStatus()->getValue() . "\n");
//Get the Code
echo("Code: " . $successResponse->getCode()->getValue() . "\n");
echo("Details: " );
if($successResponse->getDetails() != null)
{
//Get the details map
foreach ($successResponse->getDetails() as $keyName => $keyValue)
{
//Get each value in the map
echo($keyName . ": " . $keyValue . "\n");
}
}
//Get the Message
echo("Message: " . $successResponse->getMessage()->getValue() . "\n");
}
//Check if the request returned an exception
else if($actionResponse instanceof APIException)
{
//Get the received APIException instance
$exception = $actionResponse;
//Get the Status
echo("Status: " . $exception->getStatus()->getValue() . "\n");
//Get the Code
echo("Code: " . $exception->getCode()->getValue() . "\n");
echo("Details: " );
if($exception->getDetails() != null)
{
//Get the details map
foreach ($exception->getDetails() as $keyName => $keyValue)
{
//Get each value in the map
echo($keyName . ": " . $keyValue . "\n");
}
}
//Get the Message
echo("Message: " . $exception->getMessage()->getValue() . "\n");
}
}
}
//Check if the request returned an exception
else if($actionHandler instanceof APIException)
{
//Get the received APIException instance
$exception = $actionHandler;
//Get the Status
echo("Status: " . $exception->getStatus()->getValue() . "\n");
//Get the Code
echo("Code: " . $exception->getCode()->getValue() . "\n");
if($exception->getDetails() != null)
{
echo("Details: \n");
//Get the details map
foreach ($exception->getDetails() as $keyName => $keyValue)
{
//Get each value in the map
echo($keyName . ": " . $keyValue . "\n");
}
}
//Get the Message
echo("Message: " . $exception->getMessage()->getValue() . "\n");
}
}
}
}
Update a Module by its ID
<?php
namespace com\zoho\crm\sample\modules;
use com\zoho\crm\api\HeaderMap;
use com\zoho\crm\api\modules\APIException;
use com\zoho\crm\api\modules\ActionWrapper;
use com\zoho\crm\api\modules\BodyWrapper;
use com\zoho\crm\api\modules\Module;
use com\zoho\crm\api\modules\ModulesOperations;
use com\zoho\crm\api\modules\ResponseWrapper;
use com\zoho\crm\api\modules\SuccessResponse;
use com\zoho\crm\api\profiles\Profile;
use com\zoho\crm\api\modules\GetModulesHeader;
class Modules
{
/**
* Update Module By Id
* This method is used to update module details using module Id and print the response.
* @param moduleId - The Id of the module to obtain metadata
* @throws Exception
*/
public static function updateModuleById(string $moduleID)
{
//example, moduleAPIName = "Leads";
//Get instance of ModulesOperations Class
$moduleOperations = new ModulesOperations();
$modules = array();
$profiles = array();
//Get instance of Profile Class
$profile = new Profile();
$profile->setId("34770610026014");
// $profile->setDelete(true);
array_push($profiles, $profile);
$module = new Module();
$module->setProfiles($profiles);
$module->setAPIName("apiName2");
array_push($modules, $module);
$request = new BodyWrapper();
$request->setModules($modules);
//Call getModule method that takes BodyWrapper instance and moduleAPIName as parameter
$response = $moduleOperations->updateModuleById($moduleID,$request);
if($response != null)
{
//Get the status code from response
echo("Status code " . $response->getStatusCode() . "\n");
//Get object from response
$actionHandler = $response->getObject();
if($actionHandler instanceof ActionWrapper)
{
//Get the received ActionWrapper instance
$actionWrapper = $actionHandler;
//Get the list of obtained action responses
$actionResponses = $actionWrapper->getModules();
foreach ($actionResponses as $actionResponse)
{
//Check if the request is successful
if($actionResponse instanceof SuccessResponse)
{
//Get the received SuccessResponse instance
$successResponse = $actionResponse;
//Get the Status
echo("Status: " . $successResponse->getStatus()->getValue() . "\n");
//Get the Code
echo("Code: " . $successResponse->getCode()->getValue() . "\n");
echo("Details: " );
if($successResponse->getDetails() != null)
{
//Get the details map
foreach ($successResponse->getDetails() as $keyName => $keyValue)
{
//Get each value in the map
echo($keyName . ": " . $keyValue . "\n");
}
}
//Get the Message
echo("Message: " . $successResponse->getMessage()->getValue() . "\n");
}
//Check if the request returned an exception
else if($actionResponse instanceof APIException)
{
//Get the received APIException instance
$exception = $actionResponse;
//Get the Status
echo("Status: " . $exception->getStatus()->getValue() . "\n");
//Get the Code
echo("Code: " . $exception->getCode()->getValue() . "\n");
echo("Details: " );
if($exception->getDetails() != null)
{
//Get the details map
foreach ($exception->getDetails() as $keyName => $keyValue)
{
//Get each value in the map
echo($keyName . ": " . $keyValue . "\n");
}
}
//Get the Message
echo("Message: " . $exception->getMessage()->getValue() . "\n");
}
}
}
//Check if the request returned an exception
else if($actionHandler instanceof APIException)
{
//Get the received APIException instance
$exception = $actionHandler;
//Get the Status
echo("Status: " . $exception->getStatus()->getValue() . "\n");
//Get the Code
echo("Code: " . $exception->getCode()->getValue() . "\n");
if($exception->getDetails() != null)
{
echo("Details: \n");
//Get the details map
foreach ($exception->getDetails() as $keyName => $keyValue)
{
//Get each value in the map
echo($keyName . ": " . $keyValue . "\n");
}
}
//Get the Message
echo("Message: " . $exception->getMessage()->getValue() . "\n");
}
}
}
}