mirror of
https://github.com/PHPOffice/PhpSpreadsheet.git
synced 2026-08-18 13:40:41 +00:00
oleibman
891180e13d
Fix #3951. When an Excel sheet is protected, even when sorting is explicitly allowed without a password, sorts are permitted only on "protected ranges" within the sheet. PhpSpreadsheet already supports protected ranges, and only minor tinkering is necessary for that (e.g. the protected range can have, but does not require, a password). The more important part of this change is documenting the far-from-intuitive way that Excel handles this. To that end, documentation is updated, and a new sample is added. A new class, `Worksheet\ProtectedRange` is added in place of the string array which had been used. `Worksheet::getProtectedCells` is deprecated in favor of the new `Worksheet::getProtectedCellRanges`.
92 lines
3.5 KiB
PHP
92 lines
3.5 KiB
PHP
<?php
|
|
|
|
require __DIR__ . '/../Header.php';
|
|
|
|
use PhpOffice\PhpSpreadsheet\RichText\RichText;
|
|
use PhpOffice\PhpSpreadsheet\RichText\TextElement;
|
|
use PhpOffice\PhpSpreadsheet\Spreadsheet;
|
|
|
|
$spreadsheet = new Spreadsheet();
|
|
|
|
$helper->log('First sheet - protected, sorts not allowed');
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
$sheet->setTitle('sorttrue');
|
|
$sheet->getCell('A1')->setValue(10);
|
|
$sheet->getCell('A2')->setValue(5);
|
|
$sheet->getCell('B1')->setValue(15);
|
|
$protection = $sheet->getProtection();
|
|
$protection->setPassword('testpassword');
|
|
$protection->setSheet(true);
|
|
$protection->setInsertRows(true);
|
|
$protection->setFormatCells(true);
|
|
$protection->setObjects(true);
|
|
$protection->setAutoFilter(false);
|
|
$protection->setSort(true);
|
|
$comment = $sheet->getComment('A1');
|
|
$text = new RichText();
|
|
$text->addText(new TextElement('Sort options should be grayed out. Sheet password to remove protections is testpassword for all sheets.'));
|
|
$comment->setText($text)->setHeight('120pt')->setWidth('120pt');
|
|
|
|
$helper->log('Second sheet - protected, sorts allowed, but no permitted range defined');
|
|
$sheet = $spreadsheet->createSheet();
|
|
$sheet->setTitle('sortfalse');
|
|
$sheet->getCell('A1')->setValue(10);
|
|
$sheet->getCell('A2')->setValue(5);
|
|
$sheet->getCell('B1')->setValue(15);
|
|
$protection = $sheet->getProtection();
|
|
$protection->setPassword('testpassword');
|
|
$protection->setSheet(true);
|
|
$protection->setInsertRows(true);
|
|
$protection->setFormatCells(true);
|
|
$protection->setObjects(true);
|
|
$protection->setAutoFilter(false);
|
|
$protection->setSort(false);
|
|
$comment = $sheet->getComment('A1');
|
|
$text = new RichText();
|
|
$text->addText(new TextElement('Sort options not grayed out, but no permissible sort range.'));
|
|
$comment->setText($text)->setHeight('120pt')->setWidth('120pt');
|
|
|
|
$helper->log('Third sheet - protected, sorts allowed, but only on permitted range A:A, no range password needed');
|
|
$sheet = $spreadsheet->createSheet();
|
|
$sheet->setTitle('sortfalsenocolpw');
|
|
$sheet->getCell('A1')->setValue(10);
|
|
$sheet->getCell('A2')->setValue(5);
|
|
$sheet->getCell('C1')->setValue(15);
|
|
$protection = $sheet->getProtection();
|
|
$protection->setPassword('testpassword');
|
|
$protection->setSheet(true);
|
|
$protection->setInsertRows(true);
|
|
$protection->setFormatCells(true);
|
|
$protection->setObjects(true);
|
|
$protection->setAutoFilter(false);
|
|
$protection->setSort(false);
|
|
$sheet->protectCells('A:A');
|
|
$comment = $sheet->getComment('A1');
|
|
$text = new RichText();
|
|
$text->addText(new TextElement('Column A may be sorted without a password. No sort for any other column.'));
|
|
$comment->setText($text)->setHeight('120pt')->setWidth('120pt');
|
|
|
|
$helper->log('Fourth sheet - protected, sorts allowed, but only on permitted range A:A, and range password needed');
|
|
$sheet = $spreadsheet->createSheet();
|
|
$sheet->setTitle('sortfalsecolpw');
|
|
$sheet->getCell('A1')->setValue(10);
|
|
$sheet->getCell('A2')->setValue(5);
|
|
$sheet->getCell('C1')->setValue(15);
|
|
$protection = $sheet->getProtection();
|
|
$protection->setPassword('testpassword');
|
|
$protection->setSheet(true);
|
|
$protection->setInsertRows(true);
|
|
$protection->setFormatCells(true);
|
|
$protection->setObjects(true);
|
|
$protection->setAutoFilter(false);
|
|
$protection->setSort(false);
|
|
$sheet->protectCells('A:A', 'sortpw', false, 'sortrange');
|
|
$comment = $sheet->getComment('A1');
|
|
$text = new RichText();
|
|
$text->addText(new TextElement('Column A may be sorted with password sortpw. No sort for any other column.'));
|
|
$comment->setText($text)->setHeight('120pt')->setWidth('120pt');
|
|
|
|
// Save
|
|
$helper->write($spreadsheet, __FILE__, ['Xls', 'Xlsx']);
|
|
$spreadsheet->disconnectWorksheets();
|