SmartExportRenderer::saveCsv() - Code Metrics - Inspection of "updates" - mambax7/smartobject - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bf34f3...88111b )

by Michael

created 2018-03-21 16:40 UTC

SmartExportRenderer::saveCsv() C

↳ Parent: SmartExportRenderer

Complexity

Conditions	10
Paths	72

Size

Total Lines	51
Code Lines	36

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	10
eloc	36
nc	72
nop	1
dl	0
loc	51
rs	6
c	0
b	0
f	0

How to fix Long Method Complexity

<?php namespace XoopsModules\Smartobject;

/*
 * You may not change or alter any portion of this comment or credits
 * of supporting developers from this source code or any supporting source code
 * which is considered copyrighted (c) material of the original comment or credit authors.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 */

/**
 * @copyright    XOOPS Project https://xoops.org/
 * @license      GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 * @package
 * @since
 * @author     XOOPS Development Team
 */

use XoopsModules\Smartobject;

/**
 * Contains the classes for easily exporting data
 *
 * @license GNU
 * @author  marcan <[email protected]>
 * @link    http://www.smartfactory.ca The SmartFactory
 * @package SmartObject
 */


/**
 * SmartExportRenderer class
 *
 * Class that renders a set of data into a specific export format
 *
 * @package SmartObject
 * @author  marcan <[email protected]>
 * @link    http://www.smartfactory.ca The SmartFactory
 */
class SmartExportRenderer
{
    public $data;
    public $format;
    public $filename;
    public $filepath;
    public $options;

    /**
     * Constructor
     *
     * @param array       $data     contains the data to be exported
     * @param bool|string $filename name of the file in which the exported data will be saved
     * @param bool|string $filepath path where the file will be saved
     * @param string      $format   format of the ouputed export. Currently only supports CSV
     * @param array       $options  options of the format to be exported in
     */
    public function __construct(
        $data,
        $filename = false,
        $filepath = false,
        $format = 'csv',
        $options = ['separator' => ';']
    ) {
        $this->data     = $data;
        $this->format   = $format;
        $this->filename = $filename;
        $this->filepath = $filepath;
        $this->options  = $options;
    }

    /**
     * @param         $dataArray
     * @param         $separator
     * @param  string $trim
     * @param  bool   $removeEmptyLines
     * @return string
     */
    public function arrayToCsvString($dataArray, $separator, $trim = 'both', $removeEmptyLines = true)

    {
        if (!is_array($dataArray) || empty($dataArray)) {
            return '';
        }
        switch ($trim) {
            case 'none':
                $trimFunction = false;
                break;
            case 'left':
                $trimFunction = 'ltrim';
                break;
            case 'right':
                $trimFunction = 'rtrim';
                break;
            default: //'both':
                $trimFunction = 'trim';
                break;
        }
        $ret = [];
        foreach ($dataArray as $key => $field) {
            $ret[$key] = $this->valToCsvHelper($field, $separator, $trimFunction);
        }

        return implode($separator, $ret);
    }

    /**
     * @param $val
     * @param $separator
     * @param $trimFunction
     * @return mixed|string
     */
    public function valToCsvHelper($val, $separator, $trimFunction)
    {
        if ($trimFunction) {
            $val = $trimFunction($val);
        }
        //If there is a separator (;) or a quote (") or a linebreak in the string, we need to quote it.
        $needQuote = false;
        do {
            if (false !== strpos($val, '"')) {
                $val       = str_replace('"', '""', $val);
                $needQuote = true;
                break;
            }
            if (false !== strpos($val, $separator)) {
                $needQuote = true;
                break;
            }
            if ((false !== strpos($val, "\n")) || (false !== strpos($val, "\r"))) { // \r is for mac
                $needQuote = true;
                break;
            }
        } while (false);
        if ($needQuote) {
            $val = '"' . $val . '"';
        }

        return $val;
    }

    public function execute()
    {
        $exportFileData = '';

        switch ($this->format) {
            case 'csv':
                $separator      = isset($this->options['separator']) ? $this->options['separator'] : ';';
                $firstRow       = implode($separator, $this->data['columnsHeaders']);
                $exportFileData .= $firstRow . "\r\n";

                foreach ($this->data['rows'] as $cols) {
                    $exportFileData .= $this->arrayToCsvString($cols, $separator) . "\r\n";
                }
                break;
        }
        $this->saveExportFile($exportFileData);
    }

    /**
     * @param $content
     */
    public function saveExportFile($content)
    {
        switch ($this->format) {
            case 'csv':
                $this->saveCsv($content);
                break;
        }
    }

    /**
     * @param $content
     */
    public function saveCsv($content)
    {
        if (!$this->filepath) {
            $this->filepath = XOOPS_UPLOAD_PATH . '/';
        }
        if (!$this->filename) {
            $this->filename .= time();
            $this->filename .= '.csv';
        }

        $fullFileName = $this->filepath . $this->filename;

        if (!$handle = fopen($fullFileName, 'a+')) {
            trigger_error('Unable to open ' . $fullFileName, E_USER_WARNING);
        } elseif (false === fwrite($handle, $content)) {
            trigger_error('Unable to write in ' . $fullFileName, E_USER_WARNING);
        } else {
            $mimeType  = 'text/csv';
            $file      = strrev($this->filename);
            $temp_name = strtolower(strrev(substr($file, 0, strpos($file, '--'))));
            if ('' === $temp_name) {
                $file_name = $this->filename;
            } else {
                $file_name = $temp_name;
            }
            $fullFileName = $this->filepath . stripslashes(trim($this->filename));

            if (ini_get('zlib.output_compression')) {
                ini_set('zlib.output_compression', 'Off');
            }

            header('Pragma: public');
            header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
            header('Cache-Control: private', false);
            header('Content-Transfer-Encoding: binary');
            if (isset($mimeType)) {
                header('Content-Type: ' . $mimeType);
            }

            header('Content-Disposition: attachment; filename=' . $file_name);

            if (isset($mimeType) && false !== strpos($mimeType, 'text/')) {
                $fp = fopen($fullFileName, 'r');
            } else {
                $fp = fopen($fullFileName, 'rb');
            }
            fpassthru($fp);
            exit();
        }
        fclose($handle);
    }
}


1			<?php namespace XoopsModules\Smartobject;
2
3			/*
4			* You may not change or alter any portion of this comment or credits
5			* of supporting developers from this source code or any supporting source code
6			* which is considered copyrighted (c) material of the original comment or credit authors.
7			*
8			* This program is distributed in the hope that it will be useful,
9			* but WITHOUT ANY WARRANTY; without even the implied warranty of
10			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
11			*/
12
13			/**
14			* @copyright XOOPS Project https://xoops.org/
15			* @license GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
16			* @package
17			* @since
18			* @author XOOPS Development Team
19			*/
20
21			use XoopsModules\Smartobject;
22
23			/**
24			* Contains the classes for easily exporting data
25			*
26			* @license GNU
27			* @author marcan <[email protected]>
28			* @link http://www.smartfactory.ca The SmartFactory
29			* @package SmartObject
30			*/
31
32
33			/**
34			* SmartExportRenderer class
35			*
36			* Class that renders a set of data into a specific export format
37			*
38			* @package SmartObject
39			* @author marcan <[email protected]>
40			* @link http://www.smartfactory.ca The SmartFactory
41			*/
42			class SmartExportRenderer
43			{
44			public $data;
45			public $format;
46			public $filename;
47			public $filepath;
48			public $options;
49
50			/**
51			* Constructor
52			*
53			* @param array $data contains the data to be exported
54			* @param bool\|string $filename name of the file in which the exported data will be saved
55			* @param bool\|string $filepath path where the file will be saved
56			* @param string $format format of the ouputed export. Currently only supports CSV
57			* @param array $options options of the format to be exported in
58			*/
59			public function __construct(
60			$data,
61			$filename = false,
62			$filepath = false,
63			$format = 'csv',
64			$options = ['separator' => ';']
65			) {
66			$this->data = $data;
67			$this->format = $format;
68			$this->filename = $filename;
69			$this->filepath = $filepath;
70			$this->options = $options;
71			}
72
73			/**
74			* @param $dataArray
75			* @param $separator
76			* @param string $trim
77			* @param bool $removeEmptyLines
78			* @return string
79			*/
80			public function arrayToCsvString($dataArray, $separator, $trim = 'both', $removeEmptyLines = true)
			0 ignored issues – show Unused Code introduced 2017-08-04 04:21 UTC by Report Bug Copy Issue Report The parameter `$removeEmptyLines` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
81			{
82			if (!is_array($dataArray) \|\| empty($dataArray)) {
83			return '';
84			}
85			switch ($trim) {
86			case 'none':
87			$trimFunction = false;
88			break;
89			case 'left':
90			$trimFunction = 'ltrim';
91			break;
92			case 'right':
93			$trimFunction = 'rtrim';
94			break;
95			default: //'both':
96			$trimFunction = 'trim';
97			break;
98			}
99			$ret = [];
100			foreach ($dataArray as $key => $field) {
101			$ret[$key] = $this->valToCsvHelper($field, $separator, $trimFunction);
102			}
103
104			return implode($separator, $ret);
105			}
106
107			/**
108			* @param $val
109			* @param $separator
110			* @param $trimFunction
111			* @return mixed\|string
112			*/
113			public function valToCsvHelper($val, $separator, $trimFunction)
114			{
115			if ($trimFunction) {
116			$val = $trimFunction($val);
117			}
118			//If there is a separator (;) or a quote (") or a linebreak in the string, we need to quote it.
119			$needQuote = false;
120			do {
121			if (false !== strpos($val, '"')) {
122			$val = str_replace('"', '""', $val);
123			$needQuote = true;
124			break;
125			}
126			if (false !== strpos($val, $separator)) {
127			$needQuote = true;
128			break;
129			}
130			if ((false !== strpos($val, "\n")) \|\| (false !== strpos($val, "\r"))) { // \r is for mac
131			$needQuote = true;
132			break;
133			}
134			} while (false);
135			if ($needQuote) {
136			$val = '"' . $val . '"';
137			}
138
139			return $val;
140			}
141
142			public function execute()
143			{
144			$exportFileData = '';
145
146			switch ($this->format) {
147			case 'csv':
148			$separator = isset($this->options['separator']) ? $this->options['separator'] : ';';
149			$firstRow = implode($separator, $this->data['columnsHeaders']);
150			$exportFileData .= $firstRow . "\r\n";
151
152			foreach ($this->data['rows'] as $cols) {
153			$exportFileData .= $this->arrayToCsvString($cols, $separator) . "\r\n";
154			}
155			break;
156			}
157			$this->saveExportFile($exportFileData);
158			}
159
160			/**
161			* @param $content
162			*/
163			public function saveExportFile($content)
164			{
165			switch ($this->format) {
166			case 'csv':
167			$this->saveCsv($content);
168			break;
169			}
170			}
171
172			/**
173			* @param $content
174			*/
175			public function saveCsv($content)
176			{
177			if (!$this->filepath) {
178			$this->filepath = XOOPS_UPLOAD_PATH . '/';
179			}
180			if (!$this->filename) {
181			$this->filename .= time();
182			$this->filename .= '.csv';
183			}
184
185			$fullFileName = $this->filepath . $this->filename;
186
187			if (!$handle = fopen($fullFileName, 'a+')) {
188			trigger_error('Unable to open ' . $fullFileName, E_USER_WARNING);
189			} elseif (false === fwrite($handle, $content)) {
190			trigger_error('Unable to write in ' . $fullFileName, E_USER_WARNING);
191			} else {
192			$mimeType = 'text/csv';
193			$file = strrev($this->filename);
194			$temp_name = strtolower(strrev(substr($file, 0, strpos($file, '--'))));
195			if ('' === $temp_name) {
196			$file_name = $this->filename;
197			} else {
198			$file_name = $temp_name;
199			}
200			$fullFileName = $this->filepath . stripslashes(trim($this->filename));
201
202			if (ini_get('zlib.output_compression')) {
203			ini_set('zlib.output_compression', 'Off');
204			}
205
206			header('Pragma: public');
207			header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
208			header('Cache-Control: private', false);
209			header('Content-Transfer-Encoding: binary');
210			if (isset($mimeType)) {
211			header('Content-Type: ' . $mimeType);
212			}
213
214			header('Content-Disposition: attachment; filename=' . $file_name);
215
216			if (isset($mimeType) && false !== strpos($mimeType, 'text/')) {
217			$fp = fopen($fullFileName, 'r');
218			} else {
219			$fp = fopen($fullFileName, 'rb');
220			}
221			fpassthru($fp);
222			exit();
223			}
224			fclose($handle);
225			}
226			}
227

mambax7 / smartobject

Push — master ( bf34f3...88111b )

SmartExportRenderer::saveCsv() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like