ReportingCloud::assembleMergeSettings() - Code Metrics - Inspection of "Refactoring findAndReplace() and mergeDocument()" - TextControl/txtextcontrol-reportingcloud-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 296b9a...b2aef0 )

by Jonathan

created 2016-09-30 17:14 UTC

ReportingCloud::assembleMergeSettings() B

↳ Parent: Project

Complexity

Conditions	5
Paths	6

Size

Total Lines	23
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	18
CRAP Score	5

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	23
ccs	18
cts	18
cp	1
rs	8.5906
cc	5
eloc	14
nc	6
nop	1
crap	5

<?php

/**
 * ReportingCloud PHP Wrapper
 *
 * Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access ReportingCloud in PHP.
 *
 * @link      http://www.reporting.cloud to learn more about ReportingCloud
 * @link      https://github.com/TextControl/txtextcontrol-reportingcloud-php for the canonical source repository
 * @license   https://raw.githubusercontent.com/TextControl/txtextcontrol-reportingcloud-php/master/LICENSE.md
 * @copyright © 2016 Text Control GmbH
 */
namespace TxTextControl\ReportingCloud;

use GuzzleHttp\Psr7\Response;
use GuzzleHttp\RequestOptions;
use TxTextControl\ReportingCloud\Exception\InvalidArgumentException;
use TxTextControl\ReportingCloud\Filter\DateTimeToTimestamp as DateTimeToTimestampFilter;
use TxTextControl\ReportingCloud\PropertyMap\AccountSettings as AccountSettingsPropertyMap;
use TxTextControl\ReportingCloud\PropertyMap\TemplateInfo as TemplateInfoPropertyMap;
use TxTextControl\ReportingCloud\PropertyMap\TemplateList as TemplateListPropertyMap;
use TxTextControl\ReportingCloud\Validator\StaticValidator;

/**
 * ReportingCloud
 *
 * @package TxTextControl\ReportingCloud
 * @author  Jonathan Maron (@JonathanMaron)
 */
class ReportingCloud extends AbstractReportingCloud
{

    /**
     * GET methods
     * =================================================================================================================
     */

    /**
     * Return an array of merge blocks and merge fields in a template file in template storage.
     *
     * @param string  $templateName Template name
     *
     * @throws InvalidArgumentException
     *
     * @return array|null
     */
    public function getTemplateInfo($templateName)
    {
        $ret = null;

        $propertyMap = new TemplateInfoPropertyMap();

        StaticValidator::execute($templateName, 'TemplateName');

        $query = [
            'templateName' => $templateName,
        ];

        $records = $this->get('/templates/info', $query);

        if (is_array($records) && count($records) > 0) {
            $ret = $this->normalizeArrayKeys($records, $propertyMap);
        }

        return $ret;
    }

    /**
     * Return an array of binary data.
     * Each record in the array is the binary data of a thumbnail image
     *
     * @param string  $templateName Template name
     * @param integer $zoomFactor   Zoom factor
     * @param integer $fromPage     From page
     * @param integer $toPage       To page
     * @param string  $imageFormat  Image format
     *
     * @throws InvalidArgumentException
     *
     * @return array|null
     */
    public function getTemplateThumbnails($templateName, $zoomFactor, $fromPage, $toPage, $imageFormat)
    {
        $ret = null;

        StaticValidator::execute($templateName, 'TemplateName');
        StaticValidator::execute($zoomFactor  , 'ZoomFactor');
        StaticValidator::execute($fromPage    , 'Page');
        StaticValidator::execute($toPage      , 'Page');
        StaticValidator::execute($imageFormat , 'ImageFormat');

        $query = [
            'templateName' => $templateName,
            'zoomFactor'   => $zoomFactor,
            'fromPage'     => $fromPage,
            'toPage'       => $toPage,
            'imageFormat'  => $imageFormat,
        ];

        $records = $this->get('/templates/thumbnails', $query);

        if (is_array($records) && count($records) > 0) {
            $ret = [];
            foreach ($records as $index => $data) {
                $ret[$index] = base64_decode($data);
            }
        }

        return $ret;
    }

    /**
     * Return the number of templates in template storage
     *
     * @return integer|null
     */
    public function getTemplateCount()
    {
        return $this->get('/templates/count');
    }

    /**
     * Return an array properties for the templates in template storage
     *
     * @return array|null
     */
    public function getTemplateList()

    {
        $ret = null;

        $propertyMap = new TemplateListPropertyMap();
        $filter      = new DateTimeToTimestampFilter();

        $records = $this->get('/templates/list');

        if (is_array($records) && count($records) > 0) {
            $ret = $this->normalizeArrayKeys($records, $propertyMap);
            foreach ($ret as $index => $record) {
                $key = 'modified';
                if (isset($record[$key])) {
                    $ret[$index][$key] = $filter->filter($record[$key]);
                }
            }
        }

        return $ret;
    }

    /**
     * Return the number of pages in a template in template storage
     *
     * @param string $templateName Template name
     *
     * @throws InvalidArgumentException
     *
     * @return bool
     */
    public function getTemplatePageCount($templateName)

    {
        StaticValidator::execute($templateName, 'TemplateName');

        $query = [
            'templateName' => $templateName,
        ];

        return (integer) $this->get('/templates/pagecount', $query);
    }

    /**
     * Return true, if the template exists in template storage
     *
     * @param string $templateName Template name
     *
     * @throws InvalidArgumentException
     *
     * @return bool
     */
    public function templateExists($templateName)

    {
        StaticValidator::execute($templateName, 'TemplateName');

        $query = [
            'templateName' => $templateName,
        ];

        return (boolean) $this->get('/templates/exists', $query);
    }

    /**
     * Return an array properties for the ReportingCloud account
     *
     * @return array|null
     */
    public function getAccountSettings()

    {
        $ret = null;

        $propertyMap = new AccountSettingsPropertyMap();
        $filter      = new DateTimeToTimestampFilter();

        $records = $this->get('/account/settings');

        if (is_array($records) && count($records) > 0) {
            $ret = $this->normalizeArrayKeys($records, $propertyMap);
            foreach ($ret as $index => $record) {
                $key = 'valid_until';
                if (isset($record[$key])) {
                    $ret[$index][$key] = $filter->filter($record[$key]);
                }
            }
        }

        return $ret;
    }

    /**
     * Download the binary data of a template from template storage
     *
     * @param string $templateName Template name
     *
     * @throws InvalidArgumentException
     *
     * @return null|resource
     */
    public function downloadTemplate($templateName)
    {
        $ret = null;

        StaticValidator::execute($templateName, 'TemplateName');

        $query = [
            'templateName' => $templateName,
        ];

        $data = $this->get('/templates/download', $query);

        if (null !== $data) {
            $ret = base64_decode($data);
        }

        return $ret;
    }

    /**
     * Execute a GET request via REST client
     *
     * @param string $uri   URI
     * @param array  $query Query
     *
     * @return mixed|null
     */
    protected function get($uri, $query = [])
    {
        $ret = null;

        $options = [
            RequestOptions::QUERY => $query,
        ];

        $response = $this->request('GET', $this->uri($uri), $options);

        if ($response instanceof Response) {
            if (200 === $response->getStatusCode()) {
                $body = (string) $response->getBody();
                $ret  = json_decode($body, true);
            }
        }

        return $ret;
    }


    /**
     * POST methods
     * =================================================================================================================
     */

    /**
     * Upload a template to template storage
     *
     * @param string $templateFilename Template name
     *
     * @throws InvalidArgumentException
     *
     * @return bool
     */
    public function uploadTemplate($templateFilename)

    {
        $ret = false;

        StaticValidator::execute($templateFilename, 'TemplateExtension');
        StaticValidator::execute($templateFilename, 'FileExists');

        $templateFilename = realpath($templateFilename);
        $templateName     = basename($templateFilename);

        $query = [
            'templateName' => $templateName,
        ];

        $body = file_get_contents($templateFilename);
        $body = base64_encode($body);
        $body = json_encode($body);

        $options = [
            RequestOptions::HEADERS => $this->headers(),
            RequestOptions::QUERY   => $query,
            RequestOptions::BODY    => $body,
        ];

        $response = $this->request('POST', $this->uri('/templates/upload'), $options);

        if ($response instanceof Response) {
            if (201 === $response->getStatusCode()) {
                $ret = true;
            }
        }

        return $ret;
    }

    /**
     * Convert a document on the local file system to a different format
     *
     * @param string $documentFilename Document filename
     * @param string $returnFormat     Return format
     *
     * @throws InvalidArgumentException
     *
     * @return null|resource
     */
    public function convertDocument($documentFilename, $returnFormat)

    {
        $ret = null;

        StaticValidator::execute($documentFilename, 'DocumentExtension');
        StaticValidator::execute($documentFilename, 'FileExists');
        StaticValidator::execute($returnFormat    , 'ReturnFormat');

        $query = [
            'returnFormat' => $returnFormat,
        ];

        $documentFilename = realpath($documentFilename);

        $body = file_get_contents($documentFilename);
        $body = base64_encode($body);
        $body = json_encode($body);

        $options = [
            RequestOptions::HEADERS => $this->headers(),
            RequestOptions::QUERY   => $query,
            RequestOptions::BODY    => $body,
        ];

        $response = $this->request('POST', $this->uri('/document/convert'), $options);

        if ($response instanceof Response) {
            if (200 === $response->getStatusCode()) {
                $body = (string) $response->getBody();
                $ret  = base64_decode($body);
            }
        }

        return $ret;
    }

    /**
     * Merge data into a template and return an array of binary data.
     * Each record in the array is the binary data of one document
     *
     * @param array   $mergeData         Array of merge data
     * @param string  $returnFormat      Return format
     * @param string  $templateName      Template name
     * @param string  $templateFilename  Template filename on local file system
     * @param boolean $append            Append flag
     * @param array   $mergeSettings     Array of merge settings
     *
     * @throws InvalidArgumentException
     *
     * @return null|string
     */
    public function mergeDocument($mergeData, $returnFormat, $templateName = null, $templateFilename = null,
                                    $append = null, $mergeSettings = [])
    {
        $ret = null;

        StaticValidator::execute($mergeData   , 'TypeArray');
        StaticValidator::execute($returnFormat, 'ReturnFormat');

        if (null !== $templateName) {
            StaticValidator::execute($templateName, 'TemplateName');
        }

        if (null !== $templateFilename) {

            StaticValidator::execute($templateFilename, 'TemplateExtension');
            StaticValidator::execute($templateFilename, 'FileExists');
            $templateFilename = realpath($templateFilename);
        }

        // This boolean value MUST be passed as a string to prevent Guzzle converting the
        // query parameter to ?append=0 or ?append=1, which the backend does not recognize.
        // The backend only recognizes query parameter ?append=true and ?append=false.
        if (null !== $append) {
            StaticValidator::execute($append, 'TypeBoolean');
            if (true === $append) {
                $append = 'true';
            } else {
                $append = 'false';
            }
        }

        StaticValidator::execute($mergeSettings, 'TypeArray');

        $query = [
            'returnFormat' => $returnFormat,
            'append'       => $append,
        ];

        if (null !== $templateName) {
            $query['templateName'] = $templateName;
        }

        $mergeBody = [
            'mergeData' => $mergeData,
        ];

        if (null !== $templateFilename) {

            $template = file_get_contents($templateFilename);
            $template = base64_encode($template);
            $mergeBody['template'] = $template;
        }

        if (count($mergeSettings) > 0) {
            $mergeBody['mergeSettings'] = $this->assembleMergeSettings($mergeSettings);
        }

        $options = [
            RequestOptions::HEADERS => $this->headers(),
            RequestOptions::QUERY   => $query,
            RequestOptions::BODY    => json_encode($mergeBody),
        ];

        $response = $this->request('POST', $this->uri('/document/merge'), $options);

        if ($response instanceof Response) {
            if (200 === $response->getStatusCode()) {
                $body = (string) $response->getBody();
                $body = json_decode($body);
                if (is_array($body) && count($body) > 0) {
                    $ret = [];
                    foreach ($body as $record) {
                        array_push($ret, base64_decode($record));
                    }
                }
            }
        }

        return $ret;
    }

    /**
     * Perform find and replace in template and return binary data.
     *
     * @param array   $findAndReplaceData  Array of find and replace data
     * @param string  $returnFormat        Return format
     * @param string  $templateName        Template name
     * @param string  $templateFilename    Template filename on local file system
     * @param array   $mergeSettings       Array of merge settings
     *
     * @throws InvalidArgumentException
     *
     * @return null|string
     */
    public function findAndReplace($findAndReplaceData, $returnFormat, $templateName = null, $templateFilename = null,
                                   $mergeSettings = [])
    {
        $ret = null;

        StaticValidator::execute($findAndReplaceData, 'TypeArray');
        StaticValidator::execute($returnFormat      , 'ReturnFormat');

        if (null !== $templateName) {
            StaticValidator::execute($templateName, 'TemplateName');
        }

        if (null !== $templateFilename) {

            StaticValidator::execute($templateFilename, 'TemplateExtension');
            StaticValidator::execute($templateFilename, 'FileExists');
            $templateFilename = realpath($templateFilename);
        }

        StaticValidator::execute($mergeSettings, 'TypeArray');

        $query = [
            'returnFormat' => $returnFormat,
        ];

        if (null !== $templateName) {
            $query['templateName'] = $templateName;
        }

        $findAndReplaceBody = [
            'findAndReplaceData' => $findAndReplaceData,
        ];

        if (null !== $templateFilename) {

            $template = file_get_contents($templateFilename);
            $template = base64_encode($template);
            $findAndReplaceBody['template'] = $template;
        }

        if (count($mergeSettings) > 0) {
            $findAndReplaceBody['mergeSettings'] = $this->assembleMergeSettings($mergeSettings);
        }

        $options = [
            RequestOptions::HEADERS => $this->headers(),
            RequestOptions::QUERY   => $query,
            RequestOptions::BODY    => json_encode($findAndReplaceBody),
        ];

        $response = $this->request('POST', $this->uri('/document/findandreplace'), $options);

        if ($response instanceof Response) {
            if (200 === $response->getStatusCode()) {
                $body = (string) $response->getBody();
                $ret = base64_decode($body);
            }
        }

        return $ret;
    }


    /**
     * DELETE methods
     * =================================================================================================================
     */

    /**
     * Delete a template in template storage
     *
     * @param string $templateName Template name
     *
     * @throws InvalidArgumentException
     *
     * @return bool
     */
    public function deleteTemplate($templateName)
    {
        $ret = false;

        StaticValidator::execute($templateName, 'TemplateName');

        $query = [
            'templateName' => $templateName,
        ];

        $options = [
            RequestOptions::QUERY => $query,
        ];

        $response = $this->request('DELETE', $this->uri('/templates/delete'), $options);

        if ($response instanceof Response) {
            if (204 === $response->getStatusCode()) {
                $ret = true;
            }
        }

        return $ret;
    }
}

1			<?php
2
3			/**
4			* ReportingCloud PHP Wrapper
5			*
6			* Official wrapper (authored by Text Control GmbH, publisher of ReportingCloud) to access ReportingCloud in PHP.
7			*
8			* @link http://www.reporting.cloud to learn more about ReportingCloud
9			* @link https://github.com/TextControl/txtextcontrol-reportingcloud-php for the canonical source repository
10			* @license https://raw.githubusercontent.com/TextControl/txtextcontrol-reportingcloud-php/master/LICENSE.md
11			* @copyright © 2016 Text Control GmbH
12			*/
13			namespace TxTextControl\ReportingCloud;
14
15			use GuzzleHttp\Psr7\Response;
16			use GuzzleHttp\RequestOptions;
17			use TxTextControl\ReportingCloud\Exception\InvalidArgumentException;
18			use TxTextControl\ReportingCloud\Filter\DateTimeToTimestamp as DateTimeToTimestampFilter;
19			use TxTextControl\ReportingCloud\PropertyMap\AccountSettings as AccountSettingsPropertyMap;
20			use TxTextControl\ReportingCloud\PropertyMap\TemplateInfo as TemplateInfoPropertyMap;
21			use TxTextControl\ReportingCloud\PropertyMap\TemplateList as TemplateListPropertyMap;
22			use TxTextControl\ReportingCloud\Validator\StaticValidator;
23
24			/**
25			* ReportingCloud
26			*
27			* @package TxTextControl\ReportingCloud
28			* @author Jonathan Maron (@JonathanMaron)
29			*/
30			class ReportingCloud extends AbstractReportingCloud
31			{
32
33			/**
34			* GET methods
35			* =================================================================================================================
36			*/
37
38			/**
39			* Return an array of merge blocks and merge fields in a template file in template storage.
40			*
41			* @param string $templateName Template name
42			*
43			* @throws InvalidArgumentException
44			*
45			* @return array\|null
46			*/
47	1		public function getTemplateInfo($templateName)
48			{
49	1		$ret = null;
50
51	1		$propertyMap = new TemplateInfoPropertyMap();
52
53	1		StaticValidator::execute($templateName, 'TemplateName');
54
55			$query = [
56	1		'templateName' => $templateName,
57	1		];
58
59	1		$records = $this->get('/templates/info', $query);
60
61	1		if (is_array($records) && count($records) > 0) {
62	1		$ret = $this->normalizeArrayKeys($records, $propertyMap);
63	1		}
64
65	1		return $ret;
66			}
67
68			/**
69			* Return an array of binary data.
70			* Each record in the array is the binary data of a thumbnail image
71			*
72			* @param string $templateName Template name
73			* @param integer $zoomFactor Zoom factor
74			* @param integer $fromPage From page
75			* @param integer $toPage To page
76			* @param string $imageFormat Image format
77			*
78			* @throws InvalidArgumentException
79			*
80			* @return array\|null
81			*/
82	6		public function getTemplateThumbnails($templateName, $zoomFactor, $fromPage, $toPage, $imageFormat)
83			{
84	6		$ret = null;
85
86	6		StaticValidator::execute($templateName, 'TemplateName');
87	5		StaticValidator::execute($zoomFactor , 'ZoomFactor');
88	4		StaticValidator::execute($fromPage , 'Page');
89	3		StaticValidator::execute($toPage , 'Page');
90	2		StaticValidator::execute($imageFormat , 'ImageFormat');
91
92			$query = [
93	1		'templateName' => $templateName,
94	1		'zoomFactor' => $zoomFactor,
95	1		'fromPage' => $fromPage,
96	1		'toPage' => $toPage,
97	1		'imageFormat' => $imageFormat,
98	1		];
99
100	1		$records = $this->get('/templates/thumbnails', $query);
101
102	1		if (is_array($records) && count($records) > 0) {
103	1		$ret = [];
104	1		foreach ($records as $index => $data) {
105	1		$ret[$index] = base64_decode($data);
106	1		}
107	1		}
108
109	1		return $ret;
110			}
111
112			/**
113			* Return the number of templates in template storage
114			*
115			* @return integer\|null
116			*/
117	1		public function getTemplateCount()
118			{
119	1		return $this->get('/templates/count');
120			}
121
122			/**
123			* Return an array properties for the templates in template storage
124			*
125			* @return array\|null
126			*/
127	1	View Code Duplication	public function getTemplateList()
			0 ignored issues – show Duplication introduced 2016-08-30 10:24 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
128			{
129	1		$ret = null;
130
131	1		$propertyMap = new TemplateListPropertyMap();
132	1		$filter = new DateTimeToTimestampFilter();
133
134	1		$records = $this->get('/templates/list');
135
136	1		if (is_array($records) && count($records) > 0) {
137	1		$ret = $this->normalizeArrayKeys($records, $propertyMap);
138	1		foreach ($ret as $index => $record) {
139	1		$key = 'modified';
140	1		if (isset($record[$key])) {
141	1		$ret[$index][$key] = $filter->filter($record[$key]);
142	1		}
143	1		}
144	1		}
145
146	1		return $ret;
147			}
148
149			/**
150			* Return the number of pages in a template in template storage
151			*
152			* @param string $templateName Template name
153			*
154			* @throws InvalidArgumentException
155			*
156			* @return bool
157			*/
158	2	View Code Duplication	public function getTemplatePageCount($templateName)
			0 ignored issues – show Duplication introduced 2016-07-18 07:30 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
159			{
160	2		StaticValidator::execute($templateName, 'TemplateName');
161
162			$query = [
163	1		'templateName' => $templateName,
164	1		];
165
166	1		return (integer) $this->get('/templates/pagecount', $query);
167			}
168
169			/**
170			* Return true, if the template exists in template storage
171			*
172			* @param string $templateName Template name
173			*
174			* @throws InvalidArgumentException
175			*
176			* @return bool
177			*/
178	2	View Code Duplication	public function templateExists($templateName)
			0 ignored issues – show Duplication introduced 2016-07-18 07:30 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
179			{
180	2		StaticValidator::execute($templateName, 'TemplateName');
181
182			$query = [
183	1		'templateName' => $templateName,
184	1		];
185
186	1		return (boolean) $this->get('/templates/exists', $query);
187			}
188
189			/**
190			* Return an array properties for the ReportingCloud account
191			*
192			* @return array\|null
193			*/
194	1	View Code Duplication	public function getAccountSettings()
			0 ignored issues – show Duplication introduced 2016-08-30 10:24 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
195			{
196	1		$ret = null;
197
198	1		$propertyMap = new AccountSettingsPropertyMap();
199	1		$filter = new DateTimeToTimestampFilter();
200
201	1		$records = $this->get('/account/settings');
202
203	1		if (is_array($records) && count($records) > 0) {
204	1		$ret = $this->normalizeArrayKeys($records, $propertyMap);
205	1		foreach ($ret as $index => $record) {
206	1		$key = 'valid_until';
207	1		if (isset($record[$key])) {
208			$ret[$index][$key] = $filter->filter($record[$key]);
209			}
210	1		}
211	1		}
212
213	1		return $ret;
214			}
215
216			/**
217			* Download the binary data of a template from template storage
218			*
219			* @param string $templateName Template name
220			*
221			* @throws InvalidArgumentException
222			*
223			* @return null\|resource
224			*/
225	2		public function downloadTemplate($templateName)
226			{
227	2		$ret = null;
228
229	2		StaticValidator::execute($templateName, 'TemplateName');
230
231			$query = [
232	1		'templateName' => $templateName,
233	1		];
234
235	1		$data = $this->get('/templates/download', $query);
236
237	1		if (null !== $data) {
238	1		$ret = base64_decode($data);
239	1		}
240
241	1		return $ret;
242			}
243
244			/**
245			* Execute a GET request via REST client
246			*
247			* @param string $uri URI
248			* @param array $query Query
249			*
250			* @return mixed\|null
251			*/
252	8		protected function get($uri, $query = [])
253			{
254	8		$ret = null;
255
256			$options = [
257	8		RequestOptions::QUERY => $query,
258	8		];
259
260	8		$response = $this->request('GET', $this->uri($uri), $options);
261
262	8		if ($response instanceof Response) {
263	8		if (200 === $response->getStatusCode()) {
264	8		$body = (string) $response->getBody();
265	8		$ret = json_decode($body, true);
266	8		}
267	8		}
268
269	8		return $ret;
270			}
271
272
273			/**
274			* POST methods
275			* =================================================================================================================
276			*/
277
278			/**
279			* Upload a template to template storage
280			*
281			* @param string $templateFilename Template name
282			*
283			* @throws InvalidArgumentException
284			*
285			* @return bool
286			*/
287	12	View Code Duplication	public function uploadTemplate($templateFilename)
			0 ignored issues – show Duplication introduced 2016-07-18 07:30 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
288			{
289	12		$ret = false;
290
291	12		StaticValidator::execute($templateFilename, 'TemplateExtension');
292	9		StaticValidator::execute($templateFilename, 'FileExists');
293
294	8		$templateFilename = realpath($templateFilename);
295	8		$templateName = basename($templateFilename);
296
297			$query = [
298	8		'templateName' => $templateName,
299	8		];
300
301	8		$body = file_get_contents($templateFilename);
302	8		$body = base64_encode($body);
303	8		$body = json_encode($body);
304
305			$options = [
306	8		RequestOptions::HEADERS => $this->headers(),
307	8		RequestOptions::QUERY => $query,
308	8		RequestOptions::BODY => $body,
309	8		];
310
311	8		$response = $this->request('POST', $this->uri('/templates/upload'), $options);
312
313	8		if ($response instanceof Response) {
314	8		if (201 === $response->getStatusCode()) {
315	8		$ret = true;
316	8		}
317	8		}
318
319	8		return $ret;
320			}
321
322			/**
323			* Convert a document on the local file system to a different format
324			*
325			* @param string $documentFilename Document filename
326			* @param string $returnFormat Return format
327			*
328			* @throws InvalidArgumentException
329			*
330			* @return null\|resource
331			*/
332	6	View Code Duplication	public function convertDocument($documentFilename, $returnFormat)
			0 ignored issues – show Duplication introduced 2016-07-18 07:30 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
333			{
334	6		$ret = null;
335
336	6		StaticValidator::execute($documentFilename, 'DocumentExtension');
337	3		StaticValidator::execute($documentFilename, 'FileExists');
338	2		StaticValidator::execute($returnFormat , 'ReturnFormat');
339
340			$query = [
341	1		'returnFormat' => $returnFormat,
342	1		];
343
344	1		$documentFilename = realpath($documentFilename);
345
346	1		$body = file_get_contents($documentFilename);
347	1		$body = base64_encode($body);
348	1		$body = json_encode($body);
349
350			$options = [
351	1		RequestOptions::HEADERS => $this->headers(),
352	1		RequestOptions::QUERY => $query,
353	1		RequestOptions::BODY => $body,
354	1		];
355
356	1		$response = $this->request('POST', $this->uri('/document/convert'), $options);
357
358	1		if ($response instanceof Response) {
359	1		if (200 === $response->getStatusCode()) {
360	1		$body = (string) $response->getBody();
361	1		$ret = base64_decode($body);
362	1		}
363	1		}
364
365	1		return $ret;
366			}
367
368			/**
369			* Merge data into a template and return an array of binary data.
370			* Each record in the array is the binary data of one document
371			*
372			* @param array $mergeData Array of merge data
373			* @param string $returnFormat Return format
374			* @param string $templateName Template name
375			* @param string $templateFilename Template filename on local file system
376			* @param boolean $append Append flag
377			* @param array $mergeSettings Array of merge settings
378			*
379			* @throws InvalidArgumentException
380			*
381			* @return null\|string
382			*/
383	13		public function mergeDocument($mergeData, $returnFormat, $templateName = null, $templateFilename = null,
384			$append = null, $mergeSettings = [])
385			{
386	13		$ret = null;
387
388	13		StaticValidator::execute($mergeData , 'TypeArray');
389	13		StaticValidator::execute($returnFormat, 'ReturnFormat');
390
391	12		if (null !== $templateName) {
392	2		StaticValidator::execute($templateName, 'TemplateName');
393	1		}
394
395	11	View Code Duplication	if (null !== $templateFilename) {
			0 ignored issues – show Duplication introduced 2016-09-30 14:30 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
396	10		StaticValidator::execute($templateFilename, 'TemplateExtension');
397	7		StaticValidator::execute($templateFilename, 'FileExists');
398	6		$templateFilename = realpath($templateFilename);
399	6		}
400
401			// This boolean value MUST be passed as a string to prevent Guzzle converting the
402			// query parameter to ?append=0 or ?append=1, which the backend does not recognize.
403			// The backend only recognizes query parameter ?append=true and ?append=false.
404	7		if (null !== $append) {
405	6		StaticValidator::execute($append, 'TypeBoolean');
406	5		if (true === $append) {
407	1		$append = 'true';
408	2		} else {
409	4		$append = 'false';
410			}
411	5		}
412
413	6		StaticValidator::execute($mergeSettings, 'TypeArray');
414
415			$query = [
416	5		'returnFormat' => $returnFormat,
417	5		'append' => $append,
418	5		];
419
420	5		if (null !== $templateName) {
421	1		$query['templateName'] = $templateName;
422	1		}
423
424			$mergeBody = [
425	5		'mergeData' => $mergeData,
426	5		];
427
428	5	View Code Duplication	if (null !== $templateFilename) {
			0 ignored issues – show Duplication introduced 2016-09-30 14:30 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
429	4		$template = file_get_contents($templateFilename);
430	4		$template = base64_encode($template);
431	4		$mergeBody['template'] = $template;
432	4		}
433
434	5		if (count($mergeSettings) > 0) {
435	4		$mergeBody['mergeSettings'] = $this->assembleMergeSettings($mergeSettings);
436	2		}
437
438			$options = [
439	3		RequestOptions::HEADERS => $this->headers(),
440	3		RequestOptions::QUERY => $query,
441	3		RequestOptions::BODY => json_encode($mergeBody),
442	3		];
443
444	3		$response = $this->request('POST', $this->uri('/document/merge'), $options);
445
446	3		if ($response instanceof Response) {
447	3		if (200 === $response->getStatusCode()) {
448	3		$body = (string) $response->getBody();
449	3		$body = json_decode($body);
450	3		if (is_array($body) && count($body) > 0) {
451	3		$ret = [];
452	3		foreach ($body as $record) {
453	3		array_push($ret, base64_decode($record));
454	3		}
455	3		}
456	3		}
457	3		}
458
459	3		return $ret;
460			}
461
462			/**
463			* Perform find and replace in template and return binary data.
464			*
465			* @param array $findAndReplaceData Array of find and replace data
466			* @param string $returnFormat Return format
467			* @param string $templateName Template name
468			* @param string $templateFilename Template filename on local file system
469			* @param array $mergeSettings Array of merge settings
470			*
471			* @throws InvalidArgumentException
472			*
473			* @return null\|string
474			*/
475			public function findAndReplace($findAndReplaceData, $returnFormat, $templateName = null, $templateFilename = null,
476			$mergeSettings = [])
477			{
478			$ret = null;
479
480			StaticValidator::execute($findAndReplaceData, 'TypeArray');
481			StaticValidator::execute($returnFormat , 'ReturnFormat');
482
483			if (null !== $templateName) {
484			StaticValidator::execute($templateName, 'TemplateName');
485			}
486
487		View Code Duplication	if (null !== $templateFilename) {
			0 ignored issues – show Duplication introduced 2016-09-30 14:30 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
488			StaticValidator::execute($templateFilename, 'TemplateExtension');
489			StaticValidator::execute($templateFilename, 'FileExists');
490			$templateFilename = realpath($templateFilename);
491			}
492
493			StaticValidator::execute($mergeSettings, 'TypeArray');
494
495			$query = [
496			'returnFormat' => $returnFormat,
497			];
498
499			if (null !== $templateName) {
500			$query['templateName'] = $templateName;
501			}
502
503			$findAndReplaceBody = [
504			'findAndReplaceData' => $findAndReplaceData,
505			];
506
507		View Code Duplication	if (null !== $templateFilename) {
			0 ignored issues – show Duplication introduced 2016-09-30 14:30 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
508			$template = file_get_contents($templateFilename);
509			$template = base64_encode($template);
510			$findAndReplaceBody['template'] = $template;
511			}
512
513			if (count($mergeSettings) > 0) {
514			$findAndReplaceBody['mergeSettings'] = $this->assembleMergeSettings($mergeSettings);
515			}
516
517			$options = [
518			RequestOptions::HEADERS => $this->headers(),
519			RequestOptions::QUERY => $query,
520			RequestOptions::BODY => json_encode($findAndReplaceBody),
521			];
522
523			$response = $this->request('POST', $this->uri('/document/findandreplace'), $options);
524
525			if ($response instanceof Response) {
526			if (200 === $response->getStatusCode()) {
527			$body = (string) $response->getBody();
528			$ret = base64_decode($body);
529			}
530			}
531
532			return $ret;
533			}
534
535
536			/**
537			* DELETE methods
538			* =================================================================================================================
539			*/
540
541			/**
542			* Delete a template in template storage
543			*
544			* @param string $templateName Template name
545			*
546			* @throws InvalidArgumentException
547			*
548			* @return bool
549			*/
550	10		public function deleteTemplate($templateName)
551			{
552	10		$ret = false;
553
554	10		StaticValidator::execute($templateName, 'TemplateName');
555
556			$query = [
557	9		'templateName' => $templateName,
558	9		];
559
560			$options = [
561	9		RequestOptions::QUERY => $query,
562	9		];
563
564	9		$response = $this->request('DELETE', $this->uri('/templates/delete'), $options);
565
566	8		if ($response instanceof Response) {
567	8		if (204 === $response->getStatusCode()) {
568	8		$ret = true;
569	8		}
570	8		}
571
572	8		return $ret;
573			}
574			}

TextControl / txtextcontrol-reportingcloud-php

Push — master ( 296b9a...b2aef0 )

ReportingCloud::assembleMergeSettings() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like