IOExcel::checkInputFeatures() - Code Metrics - Inspection of "few tweaks and 1 method split" - danielgp/io-excel - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed
Push — master ( c31487...4cc4d5 )

by Daniel
created 2018-09-04 20:55 UTC
IOExcel::checkInputFeatures() B

↳ Parent: IOExcel
Complexity

Conditions	8
Paths	30
Size

Total Lines	23
Code Lines	17
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	8
eloc	17
nc	30
nop	1
dl	0
loc	23
rs	8.4444
c	0
b	0
f	0
<?php

/**
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2015 - 2018 Daniel Popiniuc
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 */

namespace danielgp\IOExcel;

/**
 * Description of IOExcel
 *
 * @author Daniel Popiniuc
 */
trait IOExcel
{

    private $objPHPExcel;

    /**
     * manages further inputs checks
     *
     * @param array $inFeatures Predefined array of attributes
     * @return arrray
filter:
    dependency_paths: ["lib/*"]
     */
    private function checkInputFeatureContent($inFeaturesWorksheets)
    {
        $aReturn = [];
        foreach ($inFeaturesWorksheets as $key => $value) {
            if (!array_key_exists('Name', $value)) {
                $aReturn[] = sprintf($check['4'], $key);

            } elseif (!is_string($value['Name'])) {
                $aReturn[] = sprintf($check['4.1'], $key);
            }
            if (!array_key_exists('Content', $value)) {
                $aReturn[] = sprintf($check['5'], $key);
            } elseif (!is_array($value['Content'])) {
                $aReturn[] = sprintf($check['5.1'], $key);
            }
        }
        return $aReturn;

    }

    /**
     * manages the inputs checks
     *
     * @param array $inFeatures Predefined array of attributes
     * @return arrray
     */
    private function checkInputFeatures(array $inFeatures)
    {
        $aReturn = [];
        $check   = $this->internalCheckingErrorMessages();
        if ($inFeatures === []) {
            $aReturn[] = $check['1'];
        }
        if (!array_key_exists('Filename', $inFeatures)) {
            $aReturn[] = $check['2'];
        } elseif (!is_string($inFeatures['Filename'])) {
            $aReturn[] = $check['2.1'];
        }
        if (!array_key_exists('Worksheets', $inFeatures)) {
            $aReturn[] = $check['3'];
        } elseif (!is_array($inFeatures['Worksheets'])) {
            $aReturn[] = $check['3.1'];
        } elseif (array_key_exists('Worksheets', $inFeatures)) {
            $bReturn = $this->checkInputFeatureContent($inFeatures['Worksheets']);
            if ($bReturn !== []) {

                $aReturn = array_merge($aReturn, $bReturn);
                $aReturn = array_merge($aReturn, /** @scrutinizer ignore-type */ $bReturn);
            }
        }
        return $aReturn;

    }

    public function internalCheckingErrorMessages()
    {
        return [
            '1'   => 'Check 1: Missing parameters!',
            '2'   => 'Check 2: No filename provided!',
            '2.1' => 'Check 2.1: Provided filename is not a string!',
            '3'   => 'Check 3: No worksheets provided!',
            '3.1' => 'Check 3.1: Provided worksheets is not an array!',
            '4'   => 'Check 4: No Name was provided for the worksheet #%s !',
            '4.1' => 'Check 4.1: The Name provided for the worksheet #%s is not a string!',
            '5'   => 'Check 5: No Content was provided for the worksheet #%s !',
            '5.1' => 'Check 5.1: The Content provided for the worksheet #%s is not an array!',
        ];
    }

    /**
     * Generate an Excel file from a given array
     *
     * @param array $inFeatures Predefined array of attributes
     */
    public function setArrayToExcel(array $inFeatures)
    {
        $checkInputs = $this->checkInputFeatures($inFeatures);
        if ($checkInputs != []) {

            throw new \PhpOffice\PhpSpreadsheet\Exception(implode(', ', array_values($checkInputs)));
            throw new \PhpOffice\PhpSpreadsheet\Exception(implode(', ', array_values(/** @scrutinizer ignore-type */ $checkInputs)));
        }
        $this->objPHPExcel = new \PhpOffice\PhpSpreadsheet\Spreadsheet();
        if (isset($inFeatures['Properties'])) {
            $this->setExcelProperties($inFeatures['Properties']);
        }
        foreach ($inFeatures['Worksheets'] as $key => $wkValue) {
            if ($key > 0) {
                $this->objPHPExcel->createSheet();
            }
            $this->objPHPExcel->setActiveSheetIndex($key);
            $this->objPHPExcel->getActiveSheet()->setTitle($wkValue['Name']);
            foreach ($wkValue['Content'] as $cntValue) {
                $rowIndex = $cntValue['StartingRowIndex'];
                foreach ($cntValue['ContentArray'] as $key2 => $value) {
                    if ($key2 == 0) {
                        $this->setExcelHeaderCellContent([
                            'StartingColumnIndex' => $cntValue['StartingColumnIndex'],
                            'StartingRowIndex'    => $rowIndex,
                            'RowValues'           => array_keys($value),
                        ]);
                    }
                    $this->setExcelRowCellContent([
                        'StartingColumnIndex' => $cntValue['StartingColumnIndex'],
                        'CurrentRowIndex'     => ($rowIndex + 1),
                        'RowValues'           => $value,
                    ]);
                    $rowIndex++;
                }
            }
            $this->setExcelWorksheetPagination();
            $this->setExcelWorksheetUsability([
                'StartingColumnIndex' => $cntValue['StartingColumnIndex'],

                'HeaderRowIndex'      => $cntValue['StartingRowIndex'],
            ]);
        }
        $this->objPHPExcel->setActiveSheetIndex(0);
        $inFeatures['Filename'] = filter_var($inFeatures['Filename'], FILTER_SANITIZE_STRING);
        if (!in_array(PHP_SAPI, ['cli', 'cli-server'])) { // output created content to browser OR skip-it otherwise
            $this->setForcedHeadersWhenNotCli($inFeatures['Filename']);
        }
        $objWriter = new \PhpOffice\PhpSpreadsheet\Writer\Xlsx($this->objPHPExcel);
        if (in_array(PHP_SAPI, ['cli', 'cli-server'])) {
            $objWriter->save($inFeatures['Filename']);
        } else {
            $objWriter->save('php://output');
        }
        unset($this->objPHPExcel);
    }

    /**
     * Outputs the header cells
     *
     * @param array $inputs
     */
    private function setExcelHeaderCellContent(array $inputs)
    {
        $columnCounter = $inputs['StartingColumnIndex'];
        foreach ($inputs['RowValues'] as $value2) {
            $crtCol = \PhpOffice\PhpSpreadsheet\Cell\Coordinate::stringFromColumnIndex($columnCounter);
            $this->objPHPExcel
                ->getActiveSheet()
                ->getColumnDimension($crtCol)
                ->setAutoSize(true);
            $this->objPHPExcel
                ->getActiveSheet()
                ->setCellValue($crtCol . $inputs['StartingRowIndex'], $value2);
            $this->objPHPExcel
                ->getActiveSheet()
                ->getStyle($crtCol . $inputs['StartingRowIndex'])
                ->getFill()
                ->applyFromArray([
                    'type'       => 'solid',
                    'startcolor' => ['rgb' => 'CCCCCC'],
                    'endcolor'   => ['rgb' => 'CCCCCC'],
            ]);
            $this->objPHPExcel
                ->getActiveSheet()
                ->getStyle($crtCol . $inputs['StartingRowIndex'])
                ->applyFromArray([
                    'font' => [
                        'bold'  => true,
                        'color' => ['rgb' => '000000'],
                    ]
                    ]
            );
            $columnCounter++;
        }
        $this->objPHPExcel
            ->getActiveSheet()
            ->calculateColumnWidths();
    }

    /**
     * sets the Properties for the Excel file
     *
     * @param array $inProperties
     */
    private function setExcelProperties(array $inProperties)
    {
        if (array_key_exists('Creator', $inProperties)) {
            $this->objPHPExcel->getProperties()->setCreator($inProperties['Creator']);
        }
        if (array_key_exists('LastModifiedBy', $inProperties)) {
            $this->objPHPExcel->getProperties()->setLastModifiedBy($inProperties['LastModifiedBy']);
        }
        if (array_key_exists('description', $inProperties)) {
            $this->objPHPExcel->getProperties()->setDescription($inProperties['description']);
        }
        if (array_key_exists('subject', $inProperties)) {
            $this->objPHPExcel->getProperties()->setSubject($inProperties['subject']);
        }
        if (array_key_exists('title', $inProperties)) {
            $this->objPHPExcel->getProperties()->setTitle($inProperties['title']);
        }
    }

    /**
     * Outputs the content cells
     *
     * @param array $inputs
     */
    private function setExcelRowCellContent(array $inputs)
    {
        $columnCounter = $inputs['StartingColumnIndex'];
        foreach ($inputs['RowValues'] as $value2) {
            $crCol          = \PhpOffice\PhpSpreadsheet\Cell\Coordinate::stringFromColumnIndex($columnCounter);
            $this->objPHPExcel
                ->getActiveSheet()
                ->getColumnDimension($crCol)
                ->setAutoSize(false);
            $crtCellAddress = $crCol . $inputs['CurrentRowIndex'];
            $cntLen         = strlen($value2);
            if (($value2 == '') || ($value2 == '00:00:00') || ($value2 == '0')) {
                $value2 = '';

            } elseif (in_array($cntLen, [7, 8, 9]) && (($cntLen - strlen(str_replace(':', '', $value2))) == 2)) {
                $this->objPHPExcel
                    ->getActiveSheet()
                    ->SetCellValue($crtCellAddress, ($this->setLocalTime2Seconds($value2) / 60 / 60 / 24));
                $this->objPHPExcel
                    ->getActiveSheet()
                    ->getStyle($crtCellAddress)
                    ->getNumberFormat()
                    ->setFormatCode(\PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_DATETIME);
            } else {
                $this->objPHPExcel
                    ->getActiveSheet()
                    ->SetCellValue($crtCellAddress, strip_tags($value2));
            }
            $columnCounter += 1;
        }
    }

    /**
     * sets the Pagination
     *
     */
    private function setExcelWorksheetPagination()
    {
        $this->objPHPExcel->getActiveSheet()->getPageSetup()->setOrientation('portrait');
        $this->objPHPExcel->getActiveSheet()->getPageSetup()->setPaperSize(9); //coresponding to A4
        $margin = 0.7 / 2.54; // margin is set in inches (0.7cm)
        $this->objPHPExcel->getActiveSheet()->getPageMargins()->setHeader($margin);
        $this->objPHPExcel->getActiveSheet()->getPageMargins()->setTop($margin * 2);
        $this->objPHPExcel->getActiveSheet()->getPageMargins()->setBottom($margin);
        $this->objPHPExcel->getActiveSheet()->getPageMargins()->setLeft($margin);
        $this->objPHPExcel->getActiveSheet()->getPageMargins()->setRight($margin);
        // add header content
        $this->objPHPExcel->getActiveSheet()->getHeaderFooter()->setOddHeader('&L&F&RPage &P / &N');
        $this->objPHPExcel->getActiveSheet()->setPrintGridlines(true); // activate printing of gridlines
    }

    /**
     * Sets a few usability features
     *
     * @param array $inputs
     */
    private function setExcelWorksheetUsability($inputs)
    {
        // repeat coloumn headings for every new page...
        $this->objPHPExcel
            ->getActiveSheet()
            ->getPageSetup()
            ->setRowsToRepeatAtTopByStartAndEnd(1, $inputs['HeaderRowIndex']);
        // activate AutoFilter
        $autoFilterArea = implode('', [
            \PhpOffice\PhpSpreadsheet\Cell\Coordinate::stringFromColumnIndex($inputs['StartingColumnIndex']),
            $inputs['HeaderRowIndex'],
            ':',
            $this->objPHPExcel->getActiveSheet()->getHighestDataColumn(),
            $this->objPHPExcel->getActiveSheet()->getHighestDataRow(),
        ]);
        $this->objPHPExcel
            ->getActiveSheet()
            ->setAutoFilter($autoFilterArea);
        // freeze 1st top row
        $this->objPHPExcel
            ->getActiveSheet()
            ->freezePane('A' . ($inputs['HeaderRowIndex'] + 1));
    }

    private function setForcedHeadersWhenNotCli($strFileName)
    {
        header('Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet');
        header('Pragma: private');
        header('Cache-control: private, must-revalidate');
        header('Content-Disposition: attachment;filename="' . $strFileName . '"');
        header('Cache-Control: max-age=0');
    }

    /**
     * Converts the time string given into native Excel format (number)
     *
     * @param string $RSQLtime
     * @return string
     */
    private function setLocalTime2Seconds($RSQLtime)
    {
        $sign = '';
        if (is_null($RSQLtime) || ($RSQLtime == '')) {
            $RSQLtime = '00:00:00';
        } elseif (substr($RSQLtime, 0, 1) == '-') {
            //extract negative sign and keep it separatly until ending
            $RSQLtime = substr($RSQLtime, 1, strlen($RSQLtime) - 1);
            $sign     = '-';
        }
        $resultParts = [
            'seconds' => substr($RSQLtime, -2),
            'minutes' => substr($RSQLtime, -5, 2) * 60,
            'hours'   => substr($RSQLtime, 0, strlen($RSQLtime) - 6) * 60 * 60,
        ];
        return $sign . implode('', array_values($resultParts));
    }
}

danielgp / io-excel

Push — master ( c31487...4cc4d5 )

IOExcel::checkInputFeatures() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
