\PHPExcel_Style_Protection

PHPExcel_Style_Protection

Copyright (c) 2006 - 2015 PHPExcel

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

Summary

Methods
Properties
Constants
__construct()
bindParent()
getIsSupervisor()
getActiveSheet()
getSelectedCells()
getActiveCell()
__clone()
getSharedComponent()
getStyleArray()
applyFromArray()
getLocked()
setLocked()
getHidden()
setHidden()
getHashCode()
No public properties found
PROTECTION_INHERIT
PROTECTION_PROTECTED
PROTECTION_UNPROTECTED
No protected methods found
$isSupervisor
$parent
$locked
$hidden
N/A
No private methods found
No private properties found
N/A

Constants

PROTECTION_INHERIT

PROTECTION_INHERIT = 'inherit'

Protection styles

PROTECTION_PROTECTED

PROTECTION_PROTECTED = 'protected'

PROTECTION_UNPROTECTED

PROTECTION_UNPROTECTED = 'unprotected'

Properties

$isSupervisor

$isSupervisor : boolean

Supervisor?

Type

boolean

$parent

$parent : \PHPExcel_Style

Parent. Only used for supervisor

Type

\PHPExcel_Style

$locked

$locked : string

Locked

Type

string

$hidden

$hidden : string

Hidden

Type

string

Methods

__construct()

__construct(boolean  $isSupervisor = false, boolean  $isConditional = false) 

Create a new PHPExcel_Style_Protection

Parameters

boolean $isSupervisor

Flag indicating if this is a supervisor or not Leave this value at default unless you understand exactly what its ramifications are

boolean $isConditional

Flag indicating if this is a conditional style or not Leave this value at default unless you understand exactly what its ramifications are

bindParent()

bindParent(\PHPExcel  $parent,   $parentPropertyName = null) : \PHPExcel_Style_Supervisor

Bind parent. Only used for supervisor

Parameters

\PHPExcel $parent
$parentPropertyName

Returns

\PHPExcel_Style_Supervisor

getIsSupervisor()

getIsSupervisor() : boolean

Is this a supervisor or a cell style component?

Returns

boolean

getActiveSheet()

getActiveSheet() : \PHPExcel_Worksheet

Get the currently active sheet. Only used for supervisor

Returns

\PHPExcel_Worksheet

getSelectedCells()

getSelectedCells() : string

Get the currently active cell coordinate in currently active sheet.

Only used for supervisor

Returns

string —

E.g. 'A1'

getActiveCell()

getActiveCell() : string

Get the currently active cell coordinate in currently active sheet.

Only used for supervisor

Returns

string —

E.g. 'A1'

__clone()

__clone() 

Implement PHP __clone to create a deep clone, not just a shallow copy.

getSharedComponent()

getSharedComponent() : \PHPExcel_Style_Protection

Get the shared style component for the currently active cell in currently active sheet.

Only used for style supervisor

Returns

\PHPExcel_Style_Protection

getStyleArray()

getStyleArray(array  $array) : array

Build style array from subcomponents

Parameters

array $array

Returns

array

applyFromArray()

applyFromArray(array  $pStyles = null) : \PHPExcel_Style_Protection

Apply styles from array

$objPHPExcel->getActiveSheet()->getStyle('B2')->getLocked()->applyFromArray( array( 'locked' => TRUE, 'hidden' => FALSE ) );

Parameters

array $pStyles

Array containing style information

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Style_Protection

getLocked()

getLocked() : string

Get locked

Returns

string

setLocked()

setLocked(string  $pValue = self::PROTECTION_INHERIT) : \PHPExcel_Style_Protection

Set locked

Parameters

string $pValue

Returns

\PHPExcel_Style_Protection

getHidden()

getHidden() : string

Get hidden

Returns

string

setHidden()

setHidden(string  $pValue = self::PROTECTION_INHERIT) : \PHPExcel_Style_Protection

Set hidden

Parameters

string $pValue

Returns

\PHPExcel_Style_Protection

getHashCode()

getHashCode() : string

Get hash code

Returns

string —

Hash code