DocumentWrapper::__construct() - Code Metrics - Inspection of "Removed duplicate code" - MewesK/TwigSpreadsheetBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f8e5a3...1b3ca1 )

by Mewes

created 2017-06-05 15:58 UTC

DocumentWrapper::__construct() A

↳ Parent: DocumentWrapper

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	2

<?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;

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

        $this->object = null;
    }

    /**
     * @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->attributes['properties'] = $properties;

        $this->setProperties($properties, $this->mappings);
    }

    /**
     * @param bool        $preCalculateFormulas
     * @param null|string $diskCachingDirectory
     *
     * @throws \InvalidArgumentException
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
     */
    public function end(bool $preCalculateFormulas = true, string $diskCachingDirectory = null)
    {
        $format = null;

        // try document property
        if (isset($this->attributes['format'])) {
            $format = $this->attributes['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) {
            /**
             * @var BaseWriter $writer
             */
            $writer = IOFactory::createWriter($this->object, $writerType);
            $writer->setPreCalculateFormulas($preCalculateFormulas);
            $writer->setUseDiskCaching($diskCachingDirectory !== null, $diskCachingDirectory);
            $writer->save('php://output');
        }

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

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

MewesK / TwigSpreadsheetBundle

GitHub Access Token became invalid

Push — master ( f8e5a3...1b3ca1 )

DocumentWrapper::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like