DocumentWrapper::expandPath() - Code Metrics - Inspection of "Improved disk caching code" - MewesK/TwigSpreadsheetBundle - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( 6df24a...0dcb27 )

by Mewes

created 2017-06-15 14:45 UTC

DocumentWrapper::expandPath() C

↳ Parent: DocumentWrapper

Complexity

Conditions	7
Paths	3

Size

Total Lines	22
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	7

Importance

Changes

Metric	Value
dl	0
loc	22
ccs	1
cts	1
cp	1
rs	6.9811
c	0
b	0
f	0
cc	7
eloc	10
nc	3
nop	1
crap	7

<?php

namespace MewesK\TwigSpreadsheetBundle\Wrapper;

use PhpOffice\PhpSpreadsheet\Exception;
use PhpOffice\PhpSpreadsheet\IOFactory;
use PhpOffice\PhpSpreadsheet\Settings;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
use PhpOffice\PhpSpreadsheet\Writer\BaseWriter;
use Symfony\Bridge\Twig\AppVariable;

/**
 * Class DocumentWrapper.
 */
class DocumentWrapper extends BaseWrapper
{
    /**
     * @var Spreadsheet|null
     */
    protected $object;
    /**
     * @var array
     */
    protected $attributes;

    /**
     * DocumentWrapper constructor.
     *
     * @param array             $context
     * @param \Twig_Environment $environment
     * @param array             $attributes
     */
    public function __construct(array $context, \Twig_Environment $environment, array $attributes = [])
    {
        parent::__construct($context, $environment);

        $this->object = null;
        $this->attributes = $attributes;
    }

    /**
     * @param array $properties
     *
     * @throws \RuntimeException
     * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     */
    public function start(array $properties = [])
    {
        // load template
        if (isset($properties['template'])) {
            $templatePath = $this->expandPath($properties['template']);
            $reader = IOFactory::createReaderForFile($templatePath);
            $this->object = $reader->load($templatePath);
        }

        // create new
        else {
            $this->object = new Spreadsheet();
            $this->object->removeSheetByIndex(0);
        }

        $this->parameters['properties'] = $properties;

        $this->setProperties($properties);
    }

    /**
     * @throws \InvalidArgumentException
     * @throws \RuntimeException
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
     */
    public function end()
    {
        $format = null;

        // try document property
        if (isset($this->parameters['format'])) {
            $format = $this->parameters['format'];
        }

         // try Symfony request
        elseif (isset($this->context['app'])) {
            /**
             * @var AppVariable
             */
            $appVariable = $this->context['app'];
            if ($appVariable instanceof AppVariable && $appVariable->getRequest() !== null) {
                $format = $appVariable->getRequest()->getRequestFormat();
            }
        }

        // set default
        if ($format === null || !is_string($format)) {
            $format = 'xlsx';
        }

        switch (strtolower($format)) {
            case 'csv':
                $writerType = 'Csv';
                break;
            case 'ods':
                $writerType = 'Ods';
                break;
            case 'pdf':
                $writerType = 'Pdf';
                if (!class_exists('mPDF')) {
                    throw new Exception('Error loading mPDF. Is mPDF correctly installed?');
                }
                Settings::setPdfRendererName(Settings::PDF_RENDERER_MPDF);
                break;
            case 'xls':
                $writerType = 'Xls';
                break;
            case 'xlsx':
                $writerType = 'Xlsx';
                break;
            default:
                throw new \InvalidArgumentException(sprintf('Unknown format "%s"', $format));
        }

        if ($this->object !== null) {
            if (
                $this->attributes['diskCachingDirectory'] !== null &&
                !file_exists($this->attributes['diskCachingDirectory'])
            ) {
                if (!@mkdir($this->attributes['diskCachingDirectory']) && !is_dir($this->attributes['diskCachingDirectory'])){
                    throw new \RuntimeException('Error creating the PhpSpreadsheet cache directory');
                }
            }

            /**
             * @var BaseWriter $writer
             */
            $writer = IOFactory::createWriter($this->object, $writerType);
            $writer->setPreCalculateFormulas($this->attributes['preCalculateFormulas'] ?? true);
            $writer->setUseDiskCaching(
                $this->attributes['diskCachingDirectory'] !== null,
                $this->attributes['diskCachingDirectory'] ?? null
            );
            $writer->save('php://output');
        }

        $this->object = null;
        $this->parameters = [];
    }

    /**
     * @return Spreadsheet|null
     */
    public function getObject()
    {
        return $this->object;
    }

    /**
     * @param Spreadsheet|null $object
     */
    public function setObject(Spreadsheet $object = null)
    {
        $this->object = $object;
    }

    /**
     * @return array
     */
    protected function configureMappings(): array
    {
        return [
            'category' => function ($value) { $this->object->getProperties()->setCategory($value); },
            'company' => function ($value) { $this->object->getProperties()->setCompany($value); },
            'created' => function ($value) { $this->object->getProperties()->setCreated($value); },
            'creator' => function ($value) { $this->object->getProperties()->setCreator($value); },
            'defaultStyle' => function ($value) { $this->object->getDefaultStyle()->applyFromArray($value); },
            'description' => function ($value) { $this->object->getProperties()->setDescription($value); },
            'format' => function ($value) { $this->parameters['format'] = $value; },
            'keywords' => function ($value) { $this->object->getProperties()->setKeywords($value); },
            'lastModifiedBy' => function ($value) { $this->object->getProperties()->setLastModifiedBy($value); },
            'manager' => function ($value) { $this->object->getProperties()->setManager($value); },
            'modified' => function ($value) { $this->object->getProperties()->setModified($value); },
            'security' => [
                'lockRevision' => function ($value) { $this->object->getSecurity()->setLockRevision($value); },
                'lockStructure' => function ($value) { $this->object->getSecurity()->setLockStructure($value); },
                'lockWindows' => function ($value) { $this->object->getSecurity()->setLockWindows($value); },
                'revisionsPassword' => function ($value) { $this->object->getSecurity()->setRevisionsPassword($value); },
                'workbookPassword' => function ($value) { $this->object->getSecurity()->setWorkbookPassword($value); },
            ],
            'subject' => function ($value) { $this->object->getProperties()->setSubject($value); },
            'template' => function ($value) { $this->parameters['template'] = $value; },
            'title' => function ($value) { $this->object->getProperties()->setTitle($value); },
        ];
    }

    /**
     * Resolves paths using Twig namespaces.
     * The path must start with the namespace.
     * Namespaces are case sensitive.
     *
     * @param string $path
     *
     * @return string
     */
    private function expandPath(string $path): string
    {
        $loader = $this->environment->getLoader();

        if ($loader instanceof \Twig_Loader_Filesystem && mb_strpos($path, '@') === 0) {
            /*
             * @var \Twig_Loader_Filesystem
             */
            foreach ($loader->getNamespaces() as $namespace) {
                if (mb_strpos($path, $namespace) === 1) {
                    foreach ($loader->getPaths($namespace) as $namespacePath) {
                        $expandedPathAttribute = str_replace('@'.$namespace, $namespacePath, $path);
                        if (file_exists($expandedPathAttribute)) {
                            return $expandedPathAttribute;
                        }
                    }
                }
            }
        }

        return $path;
    }
}


1		<?php
2
3		namespace MewesK\TwigSpreadsheetBundle\Wrapper;
4
5		use PhpOffice\PhpSpreadsheet\Exception;
6		use PhpOffice\PhpSpreadsheet\IOFactory;
7		use PhpOffice\PhpSpreadsheet\Settings;
8		use PhpOffice\PhpSpreadsheet\Spreadsheet;
9		use PhpOffice\PhpSpreadsheet\Writer\BaseWriter;
10		use Symfony\Bridge\Twig\AppVariable;
11
12		/**
13		* Class DocumentWrapper.
14		*/
15		class DocumentWrapper extends BaseWrapper
16		{
17		/**
18		* @var Spreadsheet\|null
19		*/
20		protected $object;
21		/**
22		* @var array
23		*/
24		protected $attributes;
25
26		/**
27		* DocumentWrapper constructor.
28	97	*
29		* @param array $context
30	97	* @param \Twig_Environment $environment
31		* @param array $attributes
32	97	*/
33	97	public function __construct(array $context, \Twig_Environment $environment, array $attributes = [])
34		{
35		parent::__construct($context, $environment);
36
37		$this->object = null;
38		$this->attributes = $attributes;
39		}
40
41		/**
42	97	* @param array $properties
43		*
44		* @throws \RuntimeException
45	97	* @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
46	11	* @throws \PhpOffice\PhpSpreadsheet\Exception
47	11	*/
48	11	public function start(array $properties = [])
49		{
50		// load template
51		if (isset($properties['template'])) {
52		$templatePath = $this->expandPath($properties['template']);
53	86	$reader = IOFactory::createReaderForFile($templatePath);
54	86	$this->object = $reader->load($templatePath);
55		}
56
57	97	// create new
58		else {
59	97	$this->object = new Spreadsheet();
60	97	$this->object->removeSheetByIndex(0);
61		}
62
63		$this->parameters['properties'] = $properties;
64
65		$this->setProperties($properties);
66		}
67
68		/**
69		* @throws \InvalidArgumentException
70	91	* @throws \RuntimeException
71		* @throws \PhpOffice\PhpSpreadsheet\Exception
72	91	* @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
73		*/
74		public function end()
75	91	{
76		$format = null;
77
78		// try document property
79		if (isset($this->parameters['format'])) {
80	91	$format = $this->parameters['format'];
81		}
82
83		// try Symfony request
84	91	elseif (isset($this->context['app'])) {
85	91	/**
86	91	* @var AppVariable
87		*/
88		$appVariable = $this->context['app'];
89		if ($appVariable instanceof AppVariable && $appVariable->getRequest() !== null) {
90		$format = $appVariable->getRequest()->getRequestFormat();
91	91	}
92		}
93
94		// set default
95	91	if ($format === null \|\| !is_string($format)) {
96	91	$format = 'xlsx';
97	2	}
98	2
99	89	switch (strtolower($format)) {
100	22	case 'csv':
101	22	$writerType = 'Csv';
102	67	break;
103		case 'ods':
104		$writerType = 'Ods';
105		break;
106		case 'pdf':
107		$writerType = 'Pdf';
108		if (!class_exists('mPDF')) {
109	67	throw new Exception('Error loading mPDF. Is mPDF correctly installed?');
110	29	}
111	29	Settings::setPdfRendererName(Settings::PDF_RENDERER_MPDF);
112	38	break;
113	38	case 'xls':
114	38	$writerType = 'Xls';
115		break;
116		case 'xlsx':
117		$writerType = 'Xlsx';
118		break;
119	91	default:
120		throw new \InvalidArgumentException(sprintf('Unknown format "%s"', $format));
121		}
122
123	91	if ($this->object !== null) {
124	91	if (
125	91	$this->attributes['diskCachingDirectory'] !== null &&
126	91	!file_exists($this->attributes['diskCachingDirectory'])
127		) {
128		if (!@mkdir($this->attributes['diskCachingDirectory']) && !is_dir($this->attributes['diskCachingDirectory'])){
129	91	throw new \RuntimeException('Error creating the PhpSpreadsheet cache directory');
130	91	}
131	91	}
132
133		/**
134		* @var BaseWriter $writer
135		*/
136	91	$writer = IOFactory::createWriter($this->object, $writerType);
137		$writer->setPreCalculateFormulas($this->attributes['preCalculateFormulas'] ?? true);
138	91	$writer->setUseDiskCaching(
139		$this->attributes['diskCachingDirectory'] !== null,
140		$this->attributes['diskCachingDirectory'] ?? null
141		);
142		$writer->save('php://output');
143		}
144
145		$this->object = null;
146		$this->parameters = [];
147		}
148
149		/**
150		* @return Spreadsheet\|null
151		*/
152		public function getObject()
153		{
154		return $this->object;
155		}
156
157		/**
158		* @param Spreadsheet\|null $object
159		*/
160		public function setObject(Spreadsheet $object = null)
161		{
162		$this->object = $object;
163		}
164
165		/**
166		* @return array
167		*/
168		protected function configureMappings(): array
169		{
170		return [
171		'category' => function ($value) { $this->object->getProperties()->setCategory($value); },
172		'company' => function ($value) { $this->object->getProperties()->setCompany($value); },
173		'created' => function ($value) { $this->object->getProperties()->setCreated($value); },
174		'creator' => function ($value) { $this->object->getProperties()->setCreator($value); },
175		'defaultStyle' => function ($value) { $this->object->getDefaultStyle()->applyFromArray($value); },
176		'description' => function ($value) { $this->object->getProperties()->setDescription($value); },
177		'format' => function ($value) { $this->parameters['format'] = $value; },
178		'keywords' => function ($value) { $this->object->getProperties()->setKeywords($value); },
179		'lastModifiedBy' => function ($value) { $this->object->getProperties()->setLastModifiedBy($value); },
180		'manager' => function ($value) { $this->object->getProperties()->setManager($value); },
181		'modified' => function ($value) { $this->object->getProperties()->setModified($value); },
182		'security' => [
183		'lockRevision' => function ($value) { $this->object->getSecurity()->setLockRevision($value); },
184		'lockStructure' => function ($value) { $this->object->getSecurity()->setLockStructure($value); },
185		'lockWindows' => function ($value) { $this->object->getSecurity()->setLockWindows($value); },
186		'revisionsPassword' => function ($value) { $this->object->getSecurity()->setRevisionsPassword($value); },
187		'workbookPassword' => function ($value) { $this->object->getSecurity()->setWorkbookPassword($value); },
188	11	],
189		'subject' => function ($value) { $this->object->getProperties()->setSubject($value); },
190	11	'template' => function ($value) { $this->parameters['template'] = $value; },
191		'title' => function ($value) { $this->object->getProperties()->setTitle($value); },
192	11	];
193		}
194
195		/**
196	8	* Resolves paths using Twig namespaces.
197	8	* The path must start with the namespace.
198	8	* Namespaces are case sensitive.
199	8	*
200	8	* @param string $path
201	8	*
202		* @return string
203		*/
204		private function expandPath(string $path): string
205		{
206		$loader = $this->environment->getLoader();
207
208	3	if ($loader instanceof \Twig_Loader_Filesystem && mb_strpos($path, '@') === 0) {
209		/*
210		* @var \Twig_Loader_Filesystem
211		*/
212		foreach ($loader->getNamespaces() as $namespace) {
213		if (mb_strpos($path, $namespace) === 1) {
214		foreach ($loader->getPaths($namespace) as $namespacePath) {
215		$expandedPathAttribute = str_replace('@'.$namespace, $namespacePath, $path);
216		if (file_exists($expandedPathAttribute)) {
217		return $expandedPathAttribute;
218		}
219		}
220		}
221		}
222		}
223
224		return $path;
225		}
226		}
227

MewesK / TwigSpreadsheetBundle

GitHub Access Token became invalid

Push — master ( 6df24a...0dcb27 )

DocumentWrapper::expandPath() C

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like