Protection::getStyleArray() - Code Metrics - Inspection of "Reformat column width section" - PHPOffice/PhpSpreadsheet - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( f99eb8...c5339b )

by Adrien

created 2017-03-10 10:58 UTC

Protection::getStyleArray() A

↳ Parent: Protection

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

namespace PhpOffice\PhpSpreadsheet\Style;

/**
 * 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 Protection extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable
{
    /** Protection styles */
    const PROTECTION_INHERIT = 'inherit';
    const PROTECTION_PROTECTED = 'protected';
    const PROTECTION_UNPROTECTED = 'unprotected';

    /**
     * Locked.
     *
     * @var string
     */
    protected $locked;

    /**
     * Hidden.
     *
     * @var string
     */
    protected $hidden;

    /**
     * Create a new Protection.
     *
     * @param bool $isSupervisor Flag indicating if this is a supervisor or not
     *                                    Leave this value at default unless you understand exactly what
     *                                        its ramifications are
     * @param bool $isConditional Flag indicating if this is a conditional style or not
     *                                    Leave this value at default unless you understand exactly what
     *                                        its ramifications are
     */
    public function __construct($isSupervisor = false, $isConditional = false)
    {
        // Supervisor?
        parent::__construct($isSupervisor);

        // Initialise values
        if (!$isConditional) {
            $this->locked = self::PROTECTION_INHERIT;
            $this->hidden = self::PROTECTION_INHERIT;
        }
    }

    /**
     * Get the shared style component for the currently active cell in currently active sheet.
     * Only used for style supervisor.
     *
     * @return Protection
     */
    public function getSharedComponent()
    {
        return $this->parent->getSharedComponent()->getProtection();
    }

    /**
     * Build style array from subcomponents.
     *
     * @param array $array
     *
     * @return array
     */
    public function getStyleArray($array)
    {
        return ['protection' => $array];
    }

    /**
     * Apply styles from array.
     *
     * <code>
     * $spreadsheet->getActiveSheet()->getStyle('B2')->getLocked()->applyFromArray(
     *        array(
     *            'locked' => TRUE,
     *            'hidden' => FALSE
     *        )
     * );
     * </code>
     *
     * @param array $pStyles Array containing style information
     *
     * @throws \PhpOffice\PhpSpreadsheet\Exception
     *
     * @return Protection
     */
    public function applyFromArray($pStyles = null)

    {
        if (is_array($pStyles)) {
            if ($this->isSupervisor) {
                $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($this->getStyleArray($pStyles));
            } else {
                if (isset($pStyles['locked'])) {
                    $this->setLocked($pStyles['locked']);
                }
                if (isset($pStyles['hidden'])) {
                    $this->setHidden($pStyles['hidden']);
                }
            }
        } else {
            throw new \PhpOffice\PhpSpreadsheet\Exception('Invalid style array passed.');
        }

        return $this;
    }

    /**
     * Get locked.
     *
     * @return string
     */
    public function getLocked()
    {
        if ($this->isSupervisor) {
            return $this->getSharedComponent()->getLocked();
        }

        return $this->locked;
    }

    /**
     * Set locked.
     *
     * @param string $pValue
     *
     * @return Protection
     */
    public function setLocked($pValue = self::PROTECTION_INHERIT)

    {
        if ($this->isSupervisor) {
            $styleArray = $this->getStyleArray(['locked' => $pValue]);
            $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
        } else {
            $this->locked = $pValue;
        }

        return $this;
    }

    /**
     * Get hidden.
     *
     * @return string
     */
    public function getHidden()
    {
        if ($this->isSupervisor) {
            return $this->getSharedComponent()->getHidden();
        }

        return $this->hidden;
    }

    /**
     * Set hidden.
     *
     * @param string $pValue
     *
     * @return Protection
     */
    public function setHidden($pValue = self::PROTECTION_INHERIT)

    {
        if ($this->isSupervisor) {
            $styleArray = $this->getStyleArray(['hidden' => $pValue]);
            $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
        } else {
            $this->hidden = $pValue;
        }

        return $this;
    }

    /**
     * Get hash code.
     *
     * @return string Hash code
     */
    public function getHashCode()
    {
        if ($this->isSupervisor) {
            return $this->getSharedComponent()->getHashCode();
        }

        return md5(
            $this->locked .
            $this->hidden .
            __CLASS__
        );
    }
}


1			<?php
2
3			namespace PhpOffice\PhpSpreadsheet\Style;
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 Protection extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable
28			{
29			/** Protection styles */
30			const PROTECTION_INHERIT = 'inherit';
31			const PROTECTION_PROTECTED = 'protected';
32			const PROTECTION_UNPROTECTED = 'unprotected';
33
34			/**
35			* Locked.
36			*
37			* @var string
38			*/
39			protected $locked;
40
41			/**
42			* Hidden.
43			*
44			* @var string
45			*/
46			protected $hidden;
47
48			/**
49			* Create a new Protection.
50			*
51			* @param bool $isSupervisor Flag indicating if this is a supervisor or not
52			* Leave this value at default unless you understand exactly what
53			* its ramifications are
54			* @param bool $isConditional Flag indicating if this is a conditional style or not
55			* Leave this value at default unless you understand exactly what
56			* its ramifications are
57			*/
58	73		public function __construct($isSupervisor = false, $isConditional = false)
59			{
60			// Supervisor?
61	73		parent::__construct($isSupervisor);
62
63			// Initialise values
64	73		if (!$isConditional) {
65	73		$this->locked = self::PROTECTION_INHERIT;
66	73		$this->hidden = self::PROTECTION_INHERIT;
67			}
68	73		}
69
70			/**
71			* Get the shared style component for the currently active cell in currently active sheet.
72			* Only used for style supervisor.
73			*
74			* @return Protection
75			*/
76			public function getSharedComponent()
77			{
78			return $this->parent->getSharedComponent()->getProtection();
79			}
80
81			/**
82			* Build style array from subcomponents.
83			*
84			* @param array $array
85			*
86			* @return array
87			*/
88	13		public function getStyleArray($array)
89			{
90	13		return ['protection' => $array];
91			}
92
93			/**
94			* Apply styles from array.
95			*
96			* <code>
97			* $spreadsheet->getActiveSheet()->getStyle('B2')->getLocked()->applyFromArray(
98			* array(
99			* 'locked' => TRUE,
100			* 'hidden' => FALSE
101			* )
102			* );
103			* </code>
104			*
105			* @param array $pStyles Array containing style information
106			*
107			* @throws \PhpOffice\PhpSpreadsheet\Exception
108			*
109			* @return Protection
110			*/
111	13	View Code Duplication	public function applyFromArray($pStyles = null)
			0 ignored issues – show Duplication introduced 2016-08-14 05:24 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
112			{
113	13		if (is_array($pStyles)) {
114	13		if ($this->isSupervisor) {
115			$this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($this->getStyleArray($pStyles));
116			} else {
117	13		if (isset($pStyles['locked'])) {
118	13		$this->setLocked($pStyles['locked']);
119			}
120	13		if (isset($pStyles['hidden'])) {
121			$this->setHidden($pStyles['hidden']);
122			}
123			}
124			} else {
125			throw new \PhpOffice\PhpSpreadsheet\Exception('Invalid style array passed.');
126			}
127
128	13		return $this;
129			}
130
131			/**
132			* Get locked.
133			*
134			* @return string
135			*/
136	58		public function getLocked()
137			{
138	58		if ($this->isSupervisor) {
139			return $this->getSharedComponent()->getLocked();
140			}
141
142	58		return $this->locked;
143			}
144
145			/**
146			* Set locked.
147			*
148			* @param string $pValue
149			*
150			* @return Protection
151			*/
152	16	View Code Duplication	public function setLocked($pValue = self::PROTECTION_INHERIT)
			0 ignored issues – show Duplication introduced 2016-08-14 05:24 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
153			{
154	16		if ($this->isSupervisor) {
155	13		$styleArray = $this->getStyleArray(['locked' => $pValue]);
156	13		$this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
157			} else {
158	16		$this->locked = $pValue;
159			}
160
161	16		return $this;
162			}
163
164			/**
165			* Get hidden.
166			*
167			* @return string
168			*/
169	58		public function getHidden()
170			{
171	58		if ($this->isSupervisor) {
172			return $this->getSharedComponent()->getHidden();
173			}
174
175	58		return $this->hidden;
176			}
177
178			/**
179			* Set hidden.
180			*
181			* @param string $pValue
182			*
183			* @return Protection
184			*/
185	4	View Code Duplication	public function setHidden($pValue = self::PROTECTION_INHERIT)
			0 ignored issues – show Duplication introduced 2016-08-14 05:24 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
186			{
187	4		if ($this->isSupervisor) {
188			$styleArray = $this->getStyleArray(['hidden' => $pValue]);
189			$this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
190			} else {
191	4		$this->hidden = $pValue;
192			}
193
194	4		return $this;
195			}
196
197			/**
198			* Get hash code.
199			*
200			* @return string Hash code
201			*/
202	69		public function getHashCode()
203			{
204	69		if ($this->isSupervisor) {
205			return $this->getSharedComponent()->getHashCode();
206			}
207
208	69		return md5(
209	69		$this->locked .
210	69		$this->hidden .
211	69		__CLASS__
212			);
213			}
214			}
215

PHPOffice / PhpSpreadsheet

Push — develop ( f99eb8...c5339b )

Protection::getStyleArray() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like