Settings::getCacheStorageClass() - Code Metrics - Inspection of "Settings: deleted libxml_disable_entity_loader() c..." - PHPOffice/PhpSpreadsheet - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( de57bf...976711 )

by Adrien

created 2017-03-12 13:00 UTC

Settings::getCacheStorageClass() A

↳ Parent: Settings

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0
ccs	0
cts	2
cp	0
crap	2

<?php

namespace PhpOffice\PhpSpreadsheet;

/**
 * Copyright (c) 2006 - 2016 PhpSpreadsheet.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * @category   PhpSpreadsheet
 *
 * @copyright  Copyright (c) 2006 - 2016 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet)
 * @license    http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt    LGPL
 */
class Settings
{
    /**    Optional Chart Rendering libraries */
    const CHART_RENDERER_JPGRAPH = 'JpGraph';

    /**    Optional PDF Rendering libraries */
    const PDF_RENDERER_TCPDF = 'TcPDF';
    const PDF_RENDERER_DOMPDF = 'DomPDF';
    const PDF_RENDERER_MPDF = 'MPDF';

    private static $chartRenderers = [
        self::CHART_RENDERER_JPGRAPH,
    ];

    private static $pdfRenderers = [
        self::PDF_RENDERER_TCPDF,
        self::PDF_RENDERER_DOMPDF,
        self::PDF_RENDERER_MPDF,
    ];

    /**
     * Name of the external Library used for rendering charts
     * e.g.
     *        jpgraph.
     *
     * @var string
     */
    private static $chartRendererName;

    /**
     * Directory Path to the external Library used for rendering charts.
     *
     * @var string
     */
    private static $chartRendererPath;

    /**
     * Name of the external Library used for rendering PDF files
     * e.g.
     *         mPDF.
     *
     * @var string
     */
    private static $pdfRendererName;

    /**
     * Default options for libxml loader.
     *
     * @var int
     */
    private static $libXmlLoaderOptions = null;

    /**
     * Return the name of the method that is currently configured for cell cacheing.
     *
     * @return string Name of the cacheing method
     */
    public static function getCacheStorageMethod()
    {
        return CachedObjectStorageFactory::getCacheStorageMethod();
    }

    /**
     * Return the name of the class that is currently being used for cell cacheing.
     *
     * @return string Name of the class currently being used for cacheing
     */
    public static function getCacheStorageClass()
    {
        return CachedObjectStorageFactory::getCacheStorageClass();
    }

    /**
     * Set the method that should be used for cell caching.
     *
     * @param string $method Name of the caching method
     * @param array $arguments Optional configuration arguments for the caching method
     *
     * @return bool Success or failure
     */
    public static function setCacheStorageMethod($method = CachedObjectStorageFactory::CACHE_IN_MEMORY, $arguments = [])
    {
        return CachedObjectStorageFactory::initialize($method, $arguments);
    }

    /**
     * Set the locale code to use for formula translations and any special formatting.
     *
     * @param string $locale The locale code to use (e.g. "fr" or "pt_br" or "en_uk")
     *
     * @return bool Success or failure
     */
    public static function setLocale($locale = 'en_us')
    {
        return Calculation::getInstance()->setLocale($locale);
    }

    /**
     * Set details of the external library that PhpSpreadsheet should use for rendering charts.
     *
     * @param string $libraryName Internal reference name of the library
     *    e.g. \PhpOffice\PhpSpreadsheet\Settings::CHART_RENDERER_JPGRAPH
     * @param string $libraryBaseDir Directory path to the library's base folder
     *
     * @return bool Success or failure
     */
    public static function setChartRenderer($libraryName, $libraryBaseDir)
    {
        if (!self::setChartRendererName($libraryName)) {
            return false;
        }

        return self::setChartRendererPath($libraryBaseDir);
    }

    /**
     * Identify to PhpSpreadsheet the external library to use for rendering charts.
     *
     * @param string $libraryName Internal reference name of the library
     *    e.g. \PhpOffice\PhpSpreadsheet\Settings::CHART_RENDERER_JPGRAPH
     *
     * @return bool Success or failure
     */
    public static function setChartRendererName($libraryName)
    {
        if (!in_array($libraryName, self::$chartRenderers)) {
            return false;
        }
        self::$chartRendererName = $libraryName;

        return true;
    }

    /**
     * Tell PhpSpreadsheet where to find the external library to use for rendering charts.
     *
     * @param string $libraryBaseDir Directory path to the library's base folder
     *
     * @return bool Success or failure
     */
    public static function setChartRendererPath($libraryBaseDir)
    {
        if ((file_exists($libraryBaseDir) === false) || (is_readable($libraryBaseDir) === false)) {
            return false;
        }
        self::$chartRendererPath = $libraryBaseDir;

        return true;
    }

    /**
     * Return the Chart Rendering Library that PhpSpreadsheet is currently configured to use (e.g. jpgraph).
     *
     * @return string|null Internal reference name of the Chart Rendering Library that PhpSpreadsheet is
     *    currently configured to use
     *    e.g. \PhpOffice\PhpSpreadsheet\Settings::CHART_RENDERER_JPGRAPH
     */
    public static function getChartRendererName()
    {
        return self::$chartRendererName;
    }

    /**
     * Return the directory path to the Chart Rendering Library that PhpSpreadsheet is currently configured to use.
     *
     * @return string|null Directory Path to the Chart Rendering Library that PhpSpreadsheet is
     *     currently configured to use
     */
    public static function getChartRendererPath()
    {
        return self::$chartRendererPath;
    }

    /**
     * Identify to PhpSpreadsheet the external library to use for rendering PDF files.
     *
     * @param string $libraryName Internal reference name of the library
     *     e.g. \PhpOffice\PhpSpreadsheet\Settings::PDF_RENDERER_TCPDF,
     *          \PhpOffice\PhpSpreadsheet\Settings::PDF_RENDERER_DOMPDF
     *       or \PhpOffice\PhpSpreadsheet\Settings::PDF_RENDERER_MPDF
     */
    public static function setPdfRendererName($libraryName)
    {
        if (!in_array($libraryName, self::$pdfRenderers)) {
            throw new Exception('"' . $libraryName . '" is not a valid PDF library name');
        }
        self::$pdfRendererName = $libraryName;
    }

    /**
     * Return the PDF Rendering Library that PhpSpreadsheet is currently configured to use (e.g. dompdf).
     *
     * @return string|null Internal reference name of the PDF Rendering Library that PhpSpreadsheet is
     *     currently configured to use
     * e.g. \PhpOffice\PhpSpreadsheet\Settings::PDF_RENDERER_TCPDF,
     *       \PhpOffice\PhpSpreadsheet\Settings::PDF_RENDERER_DOMPDF
     *    or \PhpOffice\PhpSpreadsheet\Settings::PDF_RENDERER_MPDF
     */
    public static function getPdfRendererName()
    {
        return self::$pdfRendererName;
    }

    /**
     * Set default options for libxml loader.
     *
     * @param int $options Default options for libxml loader
     */
    public static function setLibXmlLoaderOptions($options = null)
    {
        if (is_null($options) && defined('LIBXML_DTDLOAD')) {
            $options = LIBXML_DTDLOAD | LIBXML_DTDATTR;
        }
        self::$libXmlLoaderOptions = $options;
    }

    /**
     * Get default options for libxml loader.
     * Defaults to LIBXML_DTDLOAD | LIBXML_DTDATTR when not set explicitly.
     *
     * @return int Default options for libxml loader
     */
    public static function getLibXmlLoaderOptions()
    {
        if (is_null(self::$libXmlLoaderOptions) && defined('LIBXML_DTDLOAD')) {
            self::setLibXmlLoaderOptions(LIBXML_DTDLOAD | LIBXML_DTDATTR);
        } elseif (is_null(self::$libXmlLoaderOptions)) {
            self::$libXmlLoaderOptions = true;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        }

        return self::$libXmlLoaderOptions;
    }
}


1		<?php
2
3		namespace PhpOffice\PhpSpreadsheet;
4
5		/**
6		* Copyright (c) 2006 - 2016 PhpSpreadsheet.
7		*
8		* This library is free software; you can redistribute it and/or
9		* modify it under the terms of the GNU Lesser General Public
10		* License as published by the Free Software Foundation; either
11		* version 2.1 of the License, or (at your option) any later version.
12		*
13		* This library is distributed in the hope that it will be useful,
14		* but WITHOUT ANY WARRANTY; without even the implied warranty of
15		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16		* Lesser General Public License for more details.
17		*
18		* You should have received a copy of the GNU Lesser General Public
19		* License along with this library; if not, write to the Free Software
20		* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21		*
22		* @category PhpSpreadsheet
23		*
24		* @copyright Copyright (c) 2006 - 2016 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet)
25		* @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL
26		*/
27		class Settings
28		{
29		/** Optional Chart Rendering libraries */
30		const CHART_RENDERER_JPGRAPH = 'JpGraph';
31
32		/** Optional PDF Rendering libraries */
33		const PDF_RENDERER_TCPDF = 'TcPDF';
34		const PDF_RENDERER_DOMPDF = 'DomPDF';
35		const PDF_RENDERER_MPDF = 'MPDF';
36
37		private static $chartRenderers = [
38		self::CHART_RENDERER_JPGRAPH,
39		];
40
41		private static $pdfRenderers = [
42		self::PDF_RENDERER_TCPDF,
43		self::PDF_RENDERER_DOMPDF,
44		self::PDF_RENDERER_MPDF,
45		];
46
47		/**
48		* Name of the external Library used for rendering charts
49		* e.g.
50		* jpgraph.
51		*
52		* @var string
53		*/
54		private static $chartRendererName;
55
56		/**
57		* Directory Path to the external Library used for rendering charts.
58		*
59		* @var string
60		*/
61		private static $chartRendererPath;
62
63		/**
64		* Name of the external Library used for rendering PDF files
65		* e.g.
66		* mPDF.
67		*
68		* @var string
69		*/
70		private static $pdfRendererName;
71
72		/**
73		* Default options for libxml loader.
74		*
75		* @var int
76		*/
77		private static $libXmlLoaderOptions = null;
78
79		/**
80		* Return the name of the method that is currently configured for cell cacheing.
81		*
82		* @return string Name of the cacheing method
83		*/
84		public static function getCacheStorageMethod()
85		{
86		return CachedObjectStorageFactory::getCacheStorageMethod();
87		}
88
89		/**
90		* Return the name of the class that is currently being used for cell cacheing.
91		*
92		* @return string Name of the class currently being used for cacheing
93		*/
94		public static function getCacheStorageClass()
95		{
96		return CachedObjectStorageFactory::getCacheStorageClass();
97		}
98
99		/**
100		* Set the method that should be used for cell caching.
101		*
102		* @param string $method Name of the caching method
103		* @param array $arguments Optional configuration arguments for the caching method
104		*
105		* @return bool Success or failure
106		*/
107		public static function setCacheStorageMethod($method = CachedObjectStorageFactory::CACHE_IN_MEMORY, $arguments = [])
108		{
109		return CachedObjectStorageFactory::initialize($method, $arguments);
110		}
111
112		/**
113		* Set the locale code to use for formula translations and any special formatting.
114		*
115		* @param string $locale The locale code to use (e.g. "fr" or "pt_br" or "en_uk")
116		*
117		* @return bool Success or failure
118		*/
119		public static function setLocale($locale = 'en_us')
120		{
121		return Calculation::getInstance()->setLocale($locale);
122		}
123
124		/**
125		* Set details of the external library that PhpSpreadsheet should use for rendering charts.
126		*
127		* @param string $libraryName Internal reference name of the library
128		* e.g. \PhpOffice\PhpSpreadsheet\Settings::CHART_RENDERER_JPGRAPH
129		* @param string $libraryBaseDir Directory path to the library's base folder
130		*
131		* @return bool Success or failure
132		*/
133	3	public static function setChartRenderer($libraryName, $libraryBaseDir)
134		{
135	3	if (!self::setChartRendererName($libraryName)) {
136		return false;
137		}
138
139	3	return self::setChartRendererPath($libraryBaseDir);
140		}
141
142		/**
143		* Identify to PhpSpreadsheet the external library to use for rendering charts.
144		*
145		* @param string $libraryName Internal reference name of the library
146		* e.g. \PhpOffice\PhpSpreadsheet\Settings::CHART_RENDERER_JPGRAPH
147		*
148		* @return bool Success or failure
149		*/
150	3	public static function setChartRendererName($libraryName)
151		{
152	3	if (!in_array($libraryName, self::$chartRenderers)) {
153		return false;
154		}
155	3	self::$chartRendererName = $libraryName;
156
157	3	return true;
158		}
159
160		/**
161		* Tell PhpSpreadsheet where to find the external library to use for rendering charts.
162		*
163		* @param string $libraryBaseDir Directory path to the library's base folder
164		*
165		* @return bool Success or failure
166		*/
167	3	public static function setChartRendererPath($libraryBaseDir)
168		{
169	3	if ((file_exists($libraryBaseDir) === false) \|\| (is_readable($libraryBaseDir) === false)) {
170	3	return false;
171		}
172		self::$chartRendererPath = $libraryBaseDir;
173
174		return true;
175		}
176
177		/**
178		* Return the Chart Rendering Library that PhpSpreadsheet is currently configured to use (e.g. jpgraph).
179		*
180		* @return string\|null Internal reference name of the Chart Rendering Library that PhpSpreadsheet is
181		* currently configured to use
182		* e.g. \PhpOffice\PhpSpreadsheet\Settings::CHART_RENDERER_JPGRAPH
183		*/
184		public static function getChartRendererName()
185		{
186		return self::$chartRendererName;
187		}
188
189		/**
190		* Return the directory path to the Chart Rendering Library that PhpSpreadsheet is currently configured to use.
191		*
192		* @return string\|null Directory Path to the Chart Rendering Library that PhpSpreadsheet is
193		* currently configured to use
194		*/
195		public static function getChartRendererPath()
196		{
197		return self::$chartRendererPath;
198		}
199
200		/**
201		* Identify to PhpSpreadsheet the external library to use for rendering PDF files.
202		*
203		* @param string $libraryName Internal reference name of the library
204		* e.g. \PhpOffice\PhpSpreadsheet\Settings::PDF_RENDERER_TCPDF,
205		* \PhpOffice\PhpSpreadsheet\Settings::PDF_RENDERER_DOMPDF
206		* or \PhpOffice\PhpSpreadsheet\Settings::PDF_RENDERER_MPDF
207		*/
208	5	public static function setPdfRendererName($libraryName)
209		{
210	5	if (!in_array($libraryName, self::$pdfRenderers)) {
211		throw new Exception('"' . $libraryName . '" is not a valid PDF library name');
212		}
213	5	self::$pdfRendererName = $libraryName;
214	5	}
215
216		/**
217		* Return the PDF Rendering Library that PhpSpreadsheet is currently configured to use (e.g. dompdf).
218		*
219		* @return string\|null Internal reference name of the PDF Rendering Library that PhpSpreadsheet is
220		* currently configured to use
221		* e.g. \PhpOffice\PhpSpreadsheet\Settings::PDF_RENDERER_TCPDF,
222		* \PhpOffice\PhpSpreadsheet\Settings::PDF_RENDERER_DOMPDF
223		* or \PhpOffice\PhpSpreadsheet\Settings::PDF_RENDERER_MPDF
224		*/
225	4	public static function getPdfRendererName()
226		{
227	4	return self::$pdfRendererName;
228		}
229
230		/**
231		* Set default options for libxml loader.
232		*
233		* @param int $options Default options for libxml loader
234		*/
235	14	public static function setLibXmlLoaderOptions($options = null)
236		{
237	14	if (is_null($options) && defined('LIBXML_DTDLOAD')) {
238		$options = LIBXML_DTDLOAD \| LIBXML_DTDATTR;
239		}
240	14	self::$libXmlLoaderOptions = $options;
241	14	}
242
243		/**
244		* Get default options for libxml loader.
245		* Defaults to LIBXML_DTDLOAD \| LIBXML_DTDATTR when not set explicitly.
246		*
247		* @return int Default options for libxml loader
248		*/
249	22	public static function getLibXmlLoaderOptions()
250		{
251	22	if (is_null(self::$libXmlLoaderOptions) && defined('LIBXML_DTDLOAD')) {
252	13	self::setLibXmlLoaderOptions(LIBXML_DTDLOAD \| LIBXML_DTDATTR);
253	19	} elseif (is_null(self::$libXmlLoaderOptions)) {
254		self::$libXmlLoaderOptions = true;
		0 ignored issues – show Documentation Bug introduced 2016-08-14 05:24 UTC by Report Bug Copy Issue Report The property `$libXmlLoaderOptions` was declared of type `integer`, but `true` is of type `boolean`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
255		}
256
257	22	return self::$libXmlLoaderOptions;
258		}
259		}
260

PHPOffice / PhpSpreadsheet

Push — develop ( de57bf...976711 )

Settings::getCacheStorageClass() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like