DocumentWrapper::expandPath() - Code Metrics - Inspection of "modify namespace, fix some deprecations, fix some..." - erelke/TwigSpreadsheetBundle - Measure and Improve Code Quality continuously with Scrutinizer

Test Setup Failed

Retried Inspection

Push — master ( 78f8b7...0f754d )

by Elemér

created 2019-07-02 14:10 UTC

DocumentWrapper::expandPath() B

↳ Parent: DocumentWrapper

Complexity

Conditions	7
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	22
rs	8.6346
c	0
b	0
f	0
cc	7
nc	3
nop	1

<?php

namespace Erelke\TwigSpreadsheetBundle\Wrapper;

use Erelke\TwigSpreadsheetBundle\Helper\Filesystem;
use InvalidArgumentException;
use function is_string;
use LogicException;
use PhpOffice\PhpSpreadsheet\Exception;
use \PhpOffice\PhpSpreadsheet\Reader\Exception as Reader_Exception;
use \PhpOffice\PhpSpreadsheet\Writer\Exception as Writer_Exception;
use PhpOffice\PhpSpreadsheet\IOFactory;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
use PhpOffice\PhpSpreadsheet\Writer\BaseWriter;
use PhpOffice\PhpSpreadsheet\Writer\Csv;
use PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf;
use RuntimeException;
use Symfony\Bridge\Twig\AppVariable;
use Symfony\Component\Filesystem\Exception\IOException;
use Twig\Environment as Twig_Environment;
use Twig\Loader\FilesystemLoader as Twig_Loader_Filesystem;

/**
 * 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 Reader_Exception
     * @throws 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 LogicException
     * @throws RuntimeException
     * @throws InvalidArgumentException
     * @throws Exception
     * @throws Writer_Exception
     * @throws IOException
     */
    public function end()
    {
        if ($this->object === null) {
            throw new LogicException();
        }

        $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';
        } else {
            $format = strtolower($format);
        }

        // set up mPDF
        if ($format === 'pdf') {
            if (!class_exists('\Mpdf\Mpdf')) {
                throw new RuntimeException('Error loading mPDF. Is mPDF correctly installed?');
            }
            IOFactory::registerWriter('Pdf', Mpdf::class);
        }

        /**
         * @var BaseWriter $writer
         */
        $writer = IOFactory::createWriter($this->object, ucfirst($format));
        $writer->setPreCalculateFormulas($this->attributes['pre_calculate_formulas'] ?? true);

        // set up XML cache
        if ($this->attributes['cache']['xml'] !== false) {
            Filesystem::mkdir($this->attributes['cache']['xml']);
            $writer->setUseDiskCaching(true, $this->attributes['cache']['xml']);
        }

        // set special CSV writer attributes
        if ($writer instanceof Csv) {
            /**
             * @var Csv $writer
             */
            $writer->setDelimiter($this->attributes['csv_writer']['delimiter']);
            $writer->setEnclosure($this->attributes['csv_writer']['enclosure']);
            $writer->setExcelCompatibility($this->attributes['csv_writer']['excel_compatibility']);
            $writer->setIncludeSeparatorLine($this->attributes['csv_writer']['include_separator_line']);
            $writer->setLineEnding($this->attributes['csv_writer']['line_ending']);
            $writer->setSheetIndex($this->attributes['csv_writer']['sheet_index']);
            $writer->setUseBOM($this->attributes['csv_writer']['use_bom']);
        }

        $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;
    }

	/**
	 * {@inheritdoc}
	 *
	 * @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 (Filesystem::exists($expandedPathAttribute)) {
                            return $expandedPathAttribute;
                        }
                    }
                }
            }
        }

        return $path;
    }
}


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

erelke / TwigSpreadsheetBundle

GitHub Access Token became invalid

Push — master ( 78f8b7...0f754d )

DocumentWrapper::expandPath() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like