Docs For Class PHPExcel_Style_Protection

PHPExcel_Style

# Class: PHPExcel_Style_Protection

Source Location: /PHPExcel/Style/Protection.php

### Class Overview

PHPExcel_Style_Protection

#### Author(s):

#### Copyright:

- Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel)

Implements interfaces:

- PHPExcel_IComparable

### Constants

- PROTECTION_INHERIT
- PROTECTION_PROTECTED
- PROTECTION_UNPROTECTED

### Methods

- __construct
- applyFromArray
- bindParent
- getActiveCell
- getActiveSheet
- getHashCode
- getHidden
- getIsSupervisor
- getLocked
- getSelectedCells
- getSharedComponent
- getStyleArray
- setHidden
- setLocked
- __clone

### Class Details

[line 36]
PHPExcel_Style_Protection

#### Tags:

copyright: | Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel)

[ Top ]

### Class Methods

### constructor __construct [line 81]

`PHPExcel_Style_Protection __construct( [ $isSupervisor = false])`

Create a new PHPExcel_Style_Protection

#### Tags:

access: | public

#### Parameters:

| $isSupervisor |

[ Top ]

### method applyFromArray [line 178]

`PHPExcel_Style_Protection applyFromArray( [array $pStyles = null])`

Apply styles from array

1. $objPHPExcel-> getActiveSheet()->getStyle('B2')-> getLocked()-> applyFromArray( array('locked' => true, 'hidden' => false) );

#### Tags:

throws: | Exception
access: | public

#### Parameters:

array | $pStyles | Array containing style information

[ Top ]

### method bindParent [line 97]

`PHPExcel_Style_Protection bindParent( PHPExcel_Style $parent)`

Bind parent. Only used for supervisor

#### Tags:

access: | public

#### Parameters:

PHPExcel_Style | $parent |

[ Top ]

### method getActiveCell [line 151]

`string getActiveCell( )`

Get the currently active cell coordinate in currently active sheet.

Only used for supervisor

#### Tags:

return: | E.g. 'A1'
access: | public

[ Top ]

### method getActiveSheet [line 129]

`PHPExcel_Worksheet getActiveSheet( )`

Get the currently active sheet. Only used for supervisor

#### Tags:

access: | public

[ Top ]

### method getHashCode [line 257]

`string getHashCode( )`

Get hash code

#### Tags:

return: | Hash code
access: | public

[ Top ]

### method getHidden [line 229]

`string getHidden( )`

Get hidden

#### Tags:

access: | public

[ Top ]

### method getIsSupervisor [line 108]

`boolean getIsSupervisor( )`

Is this a supervisor or a real style component?

#### Tags:

access: | public

[ Top ]

### method getLocked [line 201]

`string getLocked( )`

Get locked

#### Tags:

access: | public

[ Top ]

### method getSelectedCells [line 140]

`string getSelectedCells( )`

Get the currently active cell coordinate in currently active sheet.

Only used for supervisor

#### Tags:

return: | E.g. 'A1'
access: | public

[ Top ]

### method getSharedComponent [line 119]

`PHPExcel_Style_Protection getSharedComponent( )`

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

Only used for style supervisor

#### Tags:

access: | public

[ Top ]

### method getStyleArray [line 162]

`array getStyleArray( array $array)`

Build style array from subcomponents

#### Tags:

access: | public

#### Parameters:

array | $array |

[ Top ]

### method setHidden [line 242]

`PHPExcel_Style_Protection setHidden( [string $pValue = self::PROTECTION_INHERIT])`

Set hidden

#### Tags:

access: | public

#### Parameters:

string | $pValue |

[ Top ]

### method setLocked [line 214]

`PHPExcel_Style_Protection setLocked( [string $pValue = self::PROTECTION_INHERIT])`

Set locked

#### Tags:

access: | public

#### Parameters:

string | $pValue |

[ Top ]

### method __clone [line 271]

`void __clone( )`

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

#### Tags:

access: | public

[ Top ]

### Class Constants

#### PROTECTION_INHERIT = 'inherit'

[line 39]

Protection styles
[ Top ]

#### PROTECTION_PROTECTED = 'protected'

[line 40]

[ Top ]

#### PROTECTION_UNPROTECTED = 'unprotected'

[line 41]

[ Top ]

Documentation generated on Sun, 27 Feb 2011 16:33:30 -0800 by phpDocumentor 1.4.3