ILIAS  Release_4_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Private Attributes
PHPExcel_Worksheet_Protection Class Reference
+ Collaboration diagram for PHPExcel_Worksheet_Protection:

Public Member Functions

 __construct ()
 Create a new PHPExcel_Worksheet_Protection.
 isProtectionEnabled ()
 Is some sort of protection enabled?
 getSheet ()
 Get Sheet.
 setSheet ($pValue=false)
 Set Sheet.
 getObjects ()
 Get Objects.
 setObjects ($pValue=false)
 Set Objects.
 getScenarios ()
 Get Scenarios.
 setScenarios ($pValue=false)
 Set Scenarios.
 getFormatCells ()
 Get FormatCells.
 setFormatCells ($pValue=false)
 Set FormatCells.
 getFormatColumns ()
 Get FormatColumns.
 setFormatColumns ($pValue=false)
 Set FormatColumns.
 getFormatRows ()
 Get FormatRows.
 setFormatRows ($pValue=false)
 Set FormatRows.
 getInsertColumns ()
 Get InsertColumns.
 setInsertColumns ($pValue=false)
 Set InsertColumns.
 getInsertRows ()
 Get InsertRows.
 setInsertRows ($pValue=false)
 Set InsertRows.
 getInsertHyperlinks ()
 Get InsertHyperlinks.
 setInsertHyperlinks ($pValue=false)
 Set InsertHyperlinks.
 getDeleteColumns ()
 Get DeleteColumns.
 setDeleteColumns ($pValue=false)
 Set DeleteColumns.
 getDeleteRows ()
 Get DeleteRows.
 setDeleteRows ($pValue=false)
 Set DeleteRows.
 getSelectLockedCells ()
 Get SelectLockedCells.
 setSelectLockedCells ($pValue=false)
 Set SelectLockedCells.
 getSort ()
 Get Sort.
 setSort ($pValue=false)
 Set Sort.
 getAutoFilter ()
 Get AutoFilter.
 setAutoFilter ($pValue=false)
 Set AutoFilter.
 getPivotTables ()
 Get PivotTables.
 setPivotTables ($pValue=false)
 Set PivotTables.
 getSelectUnlockedCells ()
 Get SelectUnlockedCells.
 setSelectUnlockedCells ($pValue=false)
 Set SelectUnlockedCells.
 getPassword ()
 Get Password (hashed)
 setPassword ($pValue= '', $pAlreadyHashed=false)
 Set Password.
 __clone ()
 Implement PHP __clone to create a deep clone, not just a shallow copy.

Private Attributes

 $_sheet
 $_objects
 $_scenarios
 $_formatCells
 $_formatColumns
 $_formatRows
 $_insertColumns
 $_insertRows
 $_insertHyperlinks
 $_deleteColumns
 $_deleteRows
 $_selectLockedCells
 $_sort
 $_autoFilter
 $_pivotTables
 $_selectUnlockedCells
 $_password

Detailed Description

Definition at line 48 of file Protection.php.

Constructor & Destructor Documentation

PHPExcel_Worksheet_Protection::__construct ( )

Create a new PHPExcel_Worksheet_Protection.

Definition at line 172 of file Protection.php.

{
// Initialise values
$this->_sheet = false;
$this->_objects = false;
$this->_scenarios = false;
$this->_formatCells = false;
$this->_formatColumns = false;
$this->_formatRows = false;
$this->_insertColumns = false;
$this->_insertRows = false;
$this->_insertHyperlinks = false;
$this->_deleteColumns = false;
$this->_deleteRows = false;
$this->_selectLockedCells = false;
$this->_sort = false;
$this->_autoFilter = false;
$this->_pivotTables = false;
$this->_selectUnlockedCells = false;
$this->_password = '';
}

Member Function Documentation

PHPExcel_Worksheet_Protection::__clone ( )

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

Definition at line 565 of file Protection.php.

References $key.

{
$vars = get_object_vars($this);
foreach ($vars as $key => $value) {
if (is_object($value)) {
$this->$key = clone $value;
} else {
$this->$key = $value;
}
}
}
PHPExcel_Worksheet_Protection::getAutoFilter ( )

Get AutoFilter.

Returns
boolean

Definition at line 483 of file Protection.php.

References $_autoFilter.

{
return $this->_autoFilter;
}
PHPExcel_Worksheet_Protection::getDeleteColumns ( )

Get DeleteColumns.

Returns
boolean

Definition at line 403 of file Protection.php.

References $_deleteColumns.

{
return $this->_deleteColumns;
}
PHPExcel_Worksheet_Protection::getDeleteRows ( )

Get DeleteRows.

Returns
boolean

Definition at line 423 of file Protection.php.

References $_deleteRows.

{
return $this->_deleteRows;
}
PHPExcel_Worksheet_Protection::getFormatCells ( )

Get FormatCells.

Returns
boolean

Definition at line 283 of file Protection.php.

References $_formatCells.

{
return $this->_formatCells;
}
PHPExcel_Worksheet_Protection::getFormatColumns ( )

Get FormatColumns.

Returns
boolean

Definition at line 303 of file Protection.php.

References $_formatColumns.

{
return $this->_formatColumns;
}
PHPExcel_Worksheet_Protection::getFormatRows ( )

Get FormatRows.

Returns
boolean

Definition at line 323 of file Protection.php.

References $_formatRows.

{
return $this->_formatRows;
}
PHPExcel_Worksheet_Protection::getInsertColumns ( )

Get InsertColumns.

Returns
boolean

Definition at line 343 of file Protection.php.

References $_insertColumns.

{
return $this->_insertColumns;
}
PHPExcel_Worksheet_Protection::getInsertHyperlinks ( )

Get InsertHyperlinks.

Returns
boolean

Definition at line 383 of file Protection.php.

References $_insertHyperlinks.

{
return $this->_insertHyperlinks;
}
PHPExcel_Worksheet_Protection::getInsertRows ( )

Get InsertRows.

Returns
boolean

Definition at line 363 of file Protection.php.

References $_insertRows.

{
return $this->_insertRows;
}
PHPExcel_Worksheet_Protection::getObjects ( )

Get Objects.

Returns
boolean

Definition at line 243 of file Protection.php.

References $_objects.

{
return $this->_objects;
}
PHPExcel_Worksheet_Protection::getPassword ( )

Get Password (hashed)

Returns
string

Definition at line 543 of file Protection.php.

References $_password.

{
return $this->_password;
}
PHPExcel_Worksheet_Protection::getPivotTables ( )

Get PivotTables.

Returns
boolean

Definition at line 503 of file Protection.php.

References $_pivotTables.

{
return $this->_pivotTables;
}
PHPExcel_Worksheet_Protection::getScenarios ( )

Get Scenarios.

Returns
boolean

Definition at line 263 of file Protection.php.

References $_scenarios.

{
return $this->_scenarios;
}
PHPExcel_Worksheet_Protection::getSelectLockedCells ( )

Get SelectLockedCells.

Returns
boolean

Definition at line 443 of file Protection.php.

References $_selectLockedCells.

{
return $this->_selectLockedCells;
}
PHPExcel_Worksheet_Protection::getSelectUnlockedCells ( )

Get SelectUnlockedCells.

Returns
boolean

Definition at line 523 of file Protection.php.

References $_selectUnlockedCells.

{
return $this->_selectUnlockedCells;
}
PHPExcel_Worksheet_Protection::getSheet ( )

Get Sheet.

Returns
boolean

Definition at line 223 of file Protection.php.

References $_sheet.

{
return $this->_sheet;
}
PHPExcel_Worksheet_Protection::getSort ( )

Get Sort.

Returns
boolean

Definition at line 463 of file Protection.php.

References $_sort.

{
return $this->_sort;
}
PHPExcel_Worksheet_Protection::isProtectionEnabled ( )

Is some sort of protection enabled?

Returns
boolean

Definition at line 199 of file Protection.php.

References $_selectUnlockedCells.

{
return $this->_sheet ||
$this->_objects ||
$this->_scenarios ||
$this->_formatCells ||
$this->_formatColumns ||
$this->_formatRows ||
$this->_insertColumns ||
$this->_insertRows ||
$this->_insertHyperlinks ||
$this->_deleteColumns ||
$this->_deleteRows ||
$this->_selectLockedCells ||
$this->_sort ||
$this->_autoFilter ||
$this->_pivotTables ||
$this->_selectUnlockedCells;
}
PHPExcel_Worksheet_Protection::setAutoFilter (   $pValue = false)

Set AutoFilter.

Parameters
boolean$pValue
Returns
PHPExcel_Worksheet_Protection

Definition at line 493 of file Protection.php.

{
$this->_autoFilter = $pValue;
return $this;
}
PHPExcel_Worksheet_Protection::setDeleteColumns (   $pValue = false)

Set DeleteColumns.

Parameters
boolean$pValue
Returns
PHPExcel_Worksheet_Protection

Definition at line 413 of file Protection.php.

{
$this->_deleteColumns = $pValue;
return $this;
}
PHPExcel_Worksheet_Protection::setDeleteRows (   $pValue = false)

Set DeleteRows.

Parameters
boolean$pValue
Returns
PHPExcel_Worksheet_Protection

Definition at line 433 of file Protection.php.

{
$this->_deleteRows = $pValue;
return $this;
}
PHPExcel_Worksheet_Protection::setFormatCells (   $pValue = false)

Set FormatCells.

Parameters
boolean$pValue
Returns
PHPExcel_Worksheet_Protection

Definition at line 293 of file Protection.php.

{
$this->_formatCells = $pValue;
return $this;
}
PHPExcel_Worksheet_Protection::setFormatColumns (   $pValue = false)

Set FormatColumns.

Parameters
boolean$pValue
Returns
PHPExcel_Worksheet_Protection

Definition at line 313 of file Protection.php.

{
$this->_formatColumns = $pValue;
return $this;
}
PHPExcel_Worksheet_Protection::setFormatRows (   $pValue = false)

Set FormatRows.

Parameters
boolean$pValue
Returns
PHPExcel_Worksheet_Protection

Definition at line 333 of file Protection.php.

{
$this->_formatRows = $pValue;
return $this;
}
PHPExcel_Worksheet_Protection::setInsertColumns (   $pValue = false)

Set InsertColumns.

Parameters
boolean$pValue
Returns
PHPExcel_Worksheet_Protection

Definition at line 353 of file Protection.php.

{
$this->_insertColumns = $pValue;
return $this;
}
PHPExcel_Worksheet_Protection::setInsertHyperlinks (   $pValue = false)

Set InsertHyperlinks.

Parameters
boolean$pValue
Returns
PHPExcel_Worksheet_Protection

Definition at line 393 of file Protection.php.

{
$this->_insertHyperlinks = $pValue;
return $this;
}
PHPExcel_Worksheet_Protection::setInsertRows (   $pValue = false)

Set InsertRows.

Parameters
boolean$pValue
Returns
PHPExcel_Worksheet_Protection

Definition at line 373 of file Protection.php.

{
$this->_insertRows = $pValue;
return $this;
}
PHPExcel_Worksheet_Protection::setObjects (   $pValue = false)

Set Objects.

Parameters
boolean$pValue
Returns
PHPExcel_Worksheet_Protection

Definition at line 253 of file Protection.php.

{
$this->_objects = $pValue;
return $this;
}
PHPExcel_Worksheet_Protection::setPassword (   $pValue = '',
  $pAlreadyHashed = false 
)

Set Password.

Parameters
string$pValue
boolean$pAlreadyHashedIf the password has already been hashed, set this to true
Returns
PHPExcel_Worksheet_Protection

Definition at line 554 of file Protection.php.

References PHPExcel_Shared_PasswordHasher\hashPassword().

{
if (!$pAlreadyHashed) {
$pValue = PHPExcel_Shared_PasswordHasher::hashPassword($pValue);
}
$this->_password = $pValue;
return $this;
}

+ Here is the call graph for this function:

PHPExcel_Worksheet_Protection::setPivotTables (   $pValue = false)

Set PivotTables.

Parameters
boolean$pValue
Returns
PHPExcel_Worksheet_Protection

Definition at line 513 of file Protection.php.

{
$this->_pivotTables = $pValue;
return $this;
}
PHPExcel_Worksheet_Protection::setScenarios (   $pValue = false)

Set Scenarios.

Parameters
boolean$pValue
Returns
PHPExcel_Worksheet_Protection

Definition at line 273 of file Protection.php.

{
$this->_scenarios = $pValue;
return $this;
}
PHPExcel_Worksheet_Protection::setSelectLockedCells (   $pValue = false)

Set SelectLockedCells.

Parameters
boolean$pValue
Returns
PHPExcel_Worksheet_Protection

Definition at line 453 of file Protection.php.

{
$this->_selectLockedCells = $pValue;
return $this;
}
PHPExcel_Worksheet_Protection::setSelectUnlockedCells (   $pValue = false)

Set SelectUnlockedCells.

Parameters
boolean$pValue
Returns
PHPExcel_Worksheet_Protection

Definition at line 533 of file Protection.php.

{
$this->_selectUnlockedCells = $pValue;
return $this;
}
PHPExcel_Worksheet_Protection::setSheet (   $pValue = false)

Set Sheet.

Parameters
boolean$pValue
Returns
PHPExcel_Worksheet_Protection

Definition at line 233 of file Protection.php.

{
$this->_sheet = $pValue;
return $this;
}
PHPExcel_Worksheet_Protection::setSort (   $pValue = false)

Set Sort.

Parameters
boolean$pValue
Returns
PHPExcel_Worksheet_Protection

Definition at line 473 of file Protection.php.

{
$this->_sort = $pValue;
return $this;
}

Field Documentation

PHPExcel_Worksheet_Protection::$_autoFilter
private

Definition at line 146 of file Protection.php.

Referenced by getAutoFilter().

PHPExcel_Worksheet_Protection::$_deleteColumns
private

Definition at line 118 of file Protection.php.

Referenced by getDeleteColumns().

PHPExcel_Worksheet_Protection::$_deleteRows
private

Definition at line 125 of file Protection.php.

Referenced by getDeleteRows().

PHPExcel_Worksheet_Protection::$_formatCells
private

Definition at line 76 of file Protection.php.

Referenced by getFormatCells().

PHPExcel_Worksheet_Protection::$_formatColumns
private

Definition at line 83 of file Protection.php.

Referenced by getFormatColumns().

PHPExcel_Worksheet_Protection::$_formatRows
private

Definition at line 90 of file Protection.php.

Referenced by getFormatRows().

PHPExcel_Worksheet_Protection::$_insertColumns
private

Definition at line 97 of file Protection.php.

Referenced by getInsertColumns().

PHPExcel_Worksheet_Protection::$_insertHyperlinks
private

Definition at line 111 of file Protection.php.

Referenced by getInsertHyperlinks().

PHPExcel_Worksheet_Protection::$_insertRows
private

Definition at line 104 of file Protection.php.

Referenced by getInsertRows().

PHPExcel_Worksheet_Protection::$_objects
private

Definition at line 62 of file Protection.php.

Referenced by getObjects().

PHPExcel_Worksheet_Protection::$_password
private

Definition at line 167 of file Protection.php.

Referenced by getPassword().

PHPExcel_Worksheet_Protection::$_pivotTables
private

Definition at line 153 of file Protection.php.

Referenced by getPivotTables().

PHPExcel_Worksheet_Protection::$_scenarios
private

Definition at line 69 of file Protection.php.

Referenced by getScenarios().

PHPExcel_Worksheet_Protection::$_selectLockedCells
private

Definition at line 132 of file Protection.php.

Referenced by getSelectLockedCells().

PHPExcel_Worksheet_Protection::$_selectUnlockedCells
private

Definition at line 160 of file Protection.php.

Referenced by getSelectUnlockedCells(), and isProtectionEnabled().

PHPExcel_Worksheet_Protection::$_sheet
private

Definition at line 55 of file Protection.php.

Referenced by getSheet().

PHPExcel_Worksheet_Protection::$_sort
private

Definition at line 139 of file Protection.php.

Referenced by getSort().

The documentation for this class was generated from the following file: