ZohoClient - Code Metrics - Inspection of "Support for updateRelatedRecords, EU domain, vario..." - Wabel/zoho-crm-orm - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 1.1 (#29)

unknown

created 2018-07-27 08:33 UTC

ZohoClient B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	474
Duplicated Lines	5.7 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

Metric	Value
wmc	52
lcom	1
cbo	4
dl	27
loc	474
rs	7.44
c	0
b	0
f	0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	2
A	setEuDomain()	0	3	1
A	convertLead()	0	8	1
A	getFields()	0	6	1
A	deleteRecords()	0	9	1
A	getRecordById()	0	11	2
B	getRecords()	0	25	7
A	getDeletedRecordIds()	0	15	4
A	getRelatedRecords()	0	14	3
B	searchRecords()	0	24	6
A	getUsers()	0	18	6
A	insertRecords()	0	16	4
A	updateRecords()	13	13	3
A	updateRelatedRecords()	14	14	3
A	uploadFile()	0	7	1
A	downloadFile()	0	6	1
A	getModules()	0	4	1
A	call()	0	22	3
A	getRequestURI()	0	9	2

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like ZohoClient often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use ZohoClient, and based on these observations, apply Extract Interface, too.

<?php

namespace Wabel\Zoho\CRM;

use GuzzleHttp\Client;
use Wabel\Zoho\CRM\Exception\ZohoCRMResponseException;
use Wabel\Zoho\CRM\Request\Response;

/**
 * Client for provide interface with Zoho CRM.
 *
 * TODO : Add comments (a lot)
 */
class ZohoClient
{
    /**
     * URL for call request.
     *
     * @var string
     */
    protected $BASE_URI = 'https://crm.zoho.com/crm/private';

    /**
     * Token used for session of request.
     *
     * @var string
     */
    protected $authtoken;

    /**
     * Instance of the client.
     *
     * @var Client
     */
    protected $zohoRestClient;

    /**
     * Format selected for get request.
     *
     * @var string
     */
    protected $format;

    /**
     * Module selected for get request.
     *
     * @var string
     */
    protected $module;

    /**
     * Construct.
     *
     * @param string $authtoken      Token for connection
     * @param Client $zohoRestClient Guzzl Client for connection [optional]
     */
    public function __construct($authtoken, Client $zohoRestClient = null)
    {
        $this->authtoken = $authtoken;
        // Only XML format is supported for the time being
        $this->format = 'xml';
        $this->zohoRestClient = $zohoRestClient ?: new Client();
    }

    public function setEuDomain() {
    	$this->BASE_URI = 'https://crm.zoho.eu/crm/private';
    }

    /**
     * Implements convertLead API method.
     *
     * @param $leadId
     * @param $data
     * @param array $params
     *
     * @return Response The Response object
     *
     * @throws ZohoCRMResponseException
     */
    public function convertLead($leadId, $data, $params = array())
    {
        $module = 'Leads';
        $params['leadId'] = $leadId;
        $params['newFormat'] = 1;

        return $this->call($module, 'convertLead', $params, $data);
    }

    /**
     * Implements getFields API method.
     *
     * @return Response The Response object
     */
    public function getFields($module)
    {
        $params['newFormat'] = 1;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

        return $this->call($module, 'getFields', array());
    }

    /**
     * Implements deleteRecords API method.
     *
     * @param string $module
     * @param string $id     Id of the record
     *
     * @return Response The Response object
     *
     * @throws ZohoCRMResponseException
     */
    public function deleteRecords($module, $id)
    {
        $params = array(
            'id' => $id,
            'newFormat' => 1,
        );

        return $this->call($module, 'deleteRecords', $params);
    }

    /**
     * Implements getRecordById API method.
     *
     * @param string $module The module to use
     * @param string $id     Id of the record or a list of IDs separated by a semicolon
     *
     * @return Response The Response object
     *
     * @throws ZohoCRMResponseException
     */
    public function getRecordById($module, $id)
    {
        if (strpos($id, ';') === false) {
            $params['id'] = $id;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        } else {
            $params['idlist'] = $id;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        }
        $params['newFormat'] = 1;

        return $this->call($module, 'getRecordById', $params);
    }

    /**
     * Implements getRecords API method.
     *
     * @param $module
     * @param $sortColumnString
     * @param $sortOrderString
     * @param \DateTime $lastModifiedTime
     * @param $selectColumns
     * @param $fromIndex
     * @param $toIndex
     *
     * @return Response The Response object
     *
     * @throws ZohoCRMResponseException
     */
    public function getRecords($module, $sortColumnString = null, $sortOrderString = null, \DateTimeInterface $lastModifiedTime = null, $selectColumns = null, $fromIndex = null, $toIndex = null)
    {
        $params['newFormat'] = 1;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $params['version'] = 1;
        if ($selectColumns) {
            $params['selectColumns'] = $selectColumns;
        }
        if ($fromIndex) {
            $params['fromIndex'] = $fromIndex;
        }
        if ($toIndex) {
            $params['toIndex'] = $toIndex;
        }
        if ($sortColumnString) {
            $params['sortColumnString'] = $sortColumnString;
        }
        if ($sortOrderString) {
            $params['sortOrderString'] = $sortOrderString;
        }
        if ($lastModifiedTime) {
            $params['lastModifiedTime'] = $lastModifiedTime->format('Y-m-d H:i:s');
        }

        return $this->call($module, 'getRecords', $params);
    }

    /**
     * Implements getDeletedRecordIds API method.

     *
     * @param string             $module
     * @param \DateTimeInterface $lastModifiedTime
     * @param int                $fromIndex
     * @param int                $toIndex
     *
     * @return Response
     *
     * @throws ZohoCRMResponseException
     */
    public function getDeletedRecordIds($module, \DateTimeInterface $lastModifiedTime = null, $fromIndex = null, $toIndex = null)
    {
        $params = [];
        if ($fromIndex) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            $params['fromIndex'] = $fromIndex;
        }
        if ($toIndex) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            $params['toIndex'] = $toIndex;
        }
        if ($lastModifiedTime) {
            $params['lastModifiedTime'] = $lastModifiedTime->format('Y-m-d H:i:s');
        }

        return $this->call($module, 'getDeletedRecordIds', $params);
    }

    /**
     * Implements getRecords API method.
     *
     * @param $module
     * @param $id
     * @param $parentModule
     * @param null $fromIndex
     * @param null $toIndex
     *
     * @return Response
     *
     * @throws ZohoCRMResponseException
     */
    public function getRelatedRecords($module, $id, $parentModule, $fromIndex = null, $toIndex = null)
    {
        $params['id'] = $id;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $params['parentModule'] = $parentModule;
        $params['newFormat'] = 1;
        if ($fromIndex) {
            $params['fromIndex'] = $fromIndex;
        }
        if ($toIndex) {
            $params['toIndex'] = $toIndex;
        }

        return $this->call($module, 'getRelatedRecords', $params);
    }

    /**
     * Implements searchRecords API method.
     *
     * @param string    $module
     * @param string    $searchCondition
     * @param int       $fromIndex
     * @param int       $toIndex
     * @param \DateTime $lastModifiedTime
     * @param null      $selectColumns
     *
     * @return Response
     *
     * @throws ZohoCRMResponseException
     */
    public function searchRecords($module, $searchCondition = null, $fromIndex = null, $toIndex = null, $lastModifiedTime = null, $selectColumns = null)
    {
        if ($searchCondition) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $params['criteria'] = $searchCondition;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        } else {
            $params['criteria'] = '()';
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        }
        if ($fromIndex) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            $params['fromIndex'] = $fromIndex;
        }
        if ($toIndex) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            $params['toIndex'] = $toIndex;
        }
        if ($lastModifiedTime) {
            $params['lastModifiedTime'] = $lastModifiedTime->format('Y-m-d H:i:s');
        }
        if ($selectColumns) {
            $params['selectColumns'] = $selectColumns;
        }

        $params['newFormat'] = 1;

        return $this->call($module, 'searchRecords', $params);
    }

    /**
     * Implements getUsers API method.
     *
     * @param string $type The type of users you want retrieve (among AllUsers, ActiveUsers, DeactiveUsers, AdminUsers and ActiveConfirmedAdmins)
     *
     * @return Response The array of Zoho Beans parsed from the response
     *
     * @throws ZohoCRMResponseException
     */
    public function getUsers($type = 'AllUsers')
    {
        switch ($type) {
            case 'AllUsers':
            case 'ActiveUsers':
            case 'DeactiveUsers':
            case 'AdminUsers':
            case 'ActiveConfirmedAdmins':
                $params['type'] = $type;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
                break;
            default :
switch ($expr) {
    default : //wrong
        doSomething();
        break;
}

switch ($expr) {
    default: //right
        doSomething();
        break;
}
                $params['type'] = 'AllUsers';
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
                break;
        }
        $params['newFormat'] = 1;

        return $this->call('Users', 'getUsers', $params);
    }

    /**
     * Implements insertRecords API method.
     *
     * @param $module
     * @param \SimpleXMLElement$xmlData
     * @param bool $wfTrigger
     * @param int  $duplicateCheck
     * @param bool $isApproval
     *
     * @return Response
     *
     * @throws ZohoCRMResponseException
     */
    public function insertRecords($module, $xmlData, $wfTrigger = null, $duplicateCheck = null, $isApproval = null, $version = 4, $newFormat = 2)
    {
        if ($wfTrigger) {
            $params['wfTrigger'] = 'true';
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        }
        if ($duplicateCheck) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            $params['duplicateCheck'] = $duplicateCheck;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
        }
        if ($isApproval) {
            $params['isApproval'] = 'true';
        }
        $params['newFormat'] = $newFormat;
        $params['version'] = $version;

        return $this->call($module, 'insertRecords', $params, ['xmlData' => $xmlData->asXML()]);
    }

    /**
     * Implements updateRecords API method.
     *
     * @param $module
     * @param \SimpleXMLElement $xmlData
     * @param string            $id
     * @param bool              $wfTrigger
     *
     * @return Response
     *
     * @throws ZohoCRMResponseException
     */
    public function updateRecords($module, $xmlData, $id = null, $wfTrigger = null, $version = 4, $newFormat = 2)

    {
        $params['newFormat'] = $newFormat;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $params['version'] = $version;
        if ($wfTrigger) {
            $params['wfTrigger'] = 'true';
        }
        if ($id) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $params['id'] = $id;
        }

        return $this->call($module, 'updateRecords', $params, ['xmlData' => $xmlData->asXML()]);
    }

    /**
     * Implements updateRelatedRecords API method.
     *
     * @param $module
     * @param $relatedModule
     * @param \SimpleXMLElement $xmlData
     * @param string            $id
     * @param bool              $wfTrigger
     *
     * @return Response
     *
     * @throws ZohoCRMResponseException
     */
    public function updateRelatedRecords($module, $relatedModule, $xmlData, $id = null, $wfTrigger = null, $version = 4, $newFormat = 2)

    {
        $params['newFormat'] = $newFormat;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $params['version'] = $version;
        $params['relatedModule'] = $relatedModule;
        if ($wfTrigger) {
            $params['wfTrigger'] = 'true';
        }
        if ($id) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $params['id'] = $id;
        }

        return $this->call($module, 'updateRelatedRecords', $params, ['xmlData' => $xmlData->asXML()]);
    }

    /**
     * Implements uploadFile API method.
     *
     * @param $module
     * @param $id
     * @param $content
     *
     * @return Response
     *
     * @throws ZohoCRMResponseException
     */
    public function uploadFile($module, $id, $content)
    {
        $params['id'] = $id;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $params['content'] = $content;

        return $this->call($module, 'uploadFile', $params);
    }

    /**
     * Implements downloadFile API method.
     *
     * @param $module
     * @param $id
     *
     * @return Response
     *
     * @throws ZohoCRMResponseException
     */
    public function downloadFile($module, $id)
    {
        $params['id'] = $id;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

        return $this->call($module, 'downloadFile', $params);
    }

    /**
     * Returns a list of modules from Zoho.
     */
    public function getModules()
    {
        return $this->call('Info', 'getModules', ['type' => 'api']);
    }
    
    /**
     * Make the call using the client.
     *
     * @param string                   $module  The module to use
     * @param string                   $command Command to call
     * @param array                    $params  Options
/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param \SimpleXMLElement|string $data    Data to send [optional]
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param array                    $options Options to add for configurations [optional]
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return Response
     */
    public function call($module, $command, $getParams = array(), $postParams = array())
    {
        $getParams['authtoken'] = $this->authtoken;
        $getParams['scope'] = 'crmapi';

        $uri = $this->getRequestURI($module, $command);
        if(isset($postParams['xmlData'])){
            $postParams[]=[
                'name' => 'xmlData',
                'contents' => $postParams['xmlData']
            ];
            unset($postParams['xmlData']);
        }

	$response = $this->zohoRestClient->request('POST', $uri, ['query'=>$getParams,'multipart'=> $postParams]);
        $zohoResponse = new Response((string)$response->getBody(), $module, $command);
        if ($zohoResponse->ifSuccess()) {
            return $zohoResponse;
        } else {
            throw new ZohoCRMResponseException($zohoResponse);
        }
    }

    /**
     * Get the current request uri.
     *
     * @param  $module The module to use
     * @param string $command Command for get uri
     *
     * @return string
     */
    protected function getRequestURI($module, $command)
    {
        if (empty($module)) {
            throw new \RuntimeException('Zoho CRM module is not set.');
        }
        $parts = array($this->BASE_URI, $this->format, $module, $command);

        return implode('/', $parts);
    }
}


1			<?php
2
3			namespace Wabel\Zoho\CRM;
4
5			use GuzzleHttp\Client;
6			use Wabel\Zoho\CRM\Exception\ZohoCRMResponseException;
7			use Wabel\Zoho\CRM\Request\Response;
8
9			/**
10			* Client for provide interface with Zoho CRM.
11			*
12			* TODO : Add comments (a lot)
13			*/
14			class ZohoClient
15			{
16			/**
17			* URL for call request.
18			*
19			* @var string
20			*/
21			protected $BASE_URI = 'https://crm.zoho.com/crm/private';
22
23			/**
24			* Token used for session of request.
25			*
26			* @var string
27			*/
28			protected $authtoken;
29
30			/**
31			* Instance of the client.
32			*
33			* @var Client
34			*/
35			protected $zohoRestClient;
36
37			/**
38			* Format selected for get request.
39			*
40			* @var string

Wabel / zoho-crm-orm