First version

Author: Alkarex

.editorconfig

@@ -0,0 +1,14 @@
+# http://EditorConfig.org
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+indent_size = 4
+indent_style = tab
+
+[*.php]
+indent_style = tab

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.gitignore

@@ -0,0 +1 @@
+vendor/

.markdownlint.json

@@ -0,0 +1,18 @@
+{
+	"default": true,
+	"blanks-around-fences": false,
+	"blanks-around-lists": false,
+	"first-line-heading": false,
+	"line-length": false,
+	"no-hard-tabs": false,
+	"no-inline-html": {
+		"allowed_elements": ["br", "img", "kbd"]
+	},
+	"no-multiple-blanks": {
+		"maximum": 2
+	},
+	"ul-indent": false,
+	"ul-style": {
+		"style": "consistent"
+	}
+}

.markdownlintignore

@@ -0,0 +1,2 @@
+.git/
+vendor/

Makefile

@@ -0,0 +1,14 @@
+vendor/bin/phpstan:
+	composer install --prefer-dist --no-progress
+
+composer-test: vendor/bin/phpstan
+	composer run-script test
+
+composer-fix:
+	composer run-script fix
+
+.PHONY: test
+test: composer-test
+
+.PHONY: fix
+fix: composer-fix

README.md

@@ -1,2 +1,58 @@
-# php-xslx-fast-editor
-PHP library to make basic and fast read-write operations on existing Excel workbooks
+# php-xlsx-fast-editor
+
+PHP library to make basic and fast read-write operations on existing Excel workbooks.
+
+It handles XLSX/XLSM documents (Microsoft Excel 2007+, Office Open XML Workbook) using fast and simple low-level ZIP & XML manipulations,
+without requiring any library dependency.
+
+## Rationale
+
+If you need advanced manipulation of Excel documents such as working with formulas and styles,
+check the [PhpSpreadsheet](https://github.com/PHPOffice/PhpSpreadsheet) library
+(previously [PHPExcel](https://github.com/PHPOffice/PHPExcel/)),
+but for simply reading & writing basic values from existing Excel workbooks, `PhpSpreadsheet` is over an order of magnitude too slow.
+
+There are also libraries to create new Excel documents from scratch, or for just reading some values, but not any obvious one for editing.
+
+`php-xlsx-fast-editor` addresses the need of quickly reading and writing & editing existing Excel documents.
+
+## Examples
+
+```php
+// Use composer or load manually:
+require 'vendor/alexandrainst/XlsxFastEditor/autoload.php';
+use alexandrainst\XlsxFastEditor\XlsxFastEditor;
+
+$xlsxFastEditor = new XlsxFastEditor('test.xlsx');
+
+$worksheetId1 = $xlsxFastEditor->getWorksheetNumber('Sheet1');
+$worksheetId2 = $xlsxFastEditor->getWorksheetNumber('Sheet2');
+
+echo $xlsxFastEditor->readFloat($worksheetId1, 'B2'), "\n";
+echo $xlsxFastEditor->readInt($worksheetId1, 'C3'), "\n";
+echo $xlsxFastEditor->readString($worksheetId2, 'D4'), "\n";
+
+// If you want to force Excel to recalculate formulas on next load:
+$xlsxFastEditor->setFullCalcOnLoad($worksheetId2, true);
+
+$xlsxFastEditor->writeFloat($worksheetId1, 'B2', 3.14);
+$xlsxFastEditor->writeInt($worksheetId1, 'C3', 13);
+$xlsxFastEditor->writeString($worksheetId2, 'D4', 'Hello');
+
+// Regex search & replace operating globally on all the worksheets:
+$xlsxFastEditor->textReplace('/Hello/i', 'World');
+
+$xlsxFastEditor->save();
+// If you do not want to save, call `close()` instead:
+// $xlsxFastEditor->close();
+```
+
+## Requirements
+
+PHP 7.4+ with ZIP and XML extensions.
+Check [`composer.json`](./composer.json) for details.
+
+## Credits
+
+Originally written by [Alexandre Alapetite](https://github.com/Alkarex) for the [Alexandra Institute](https://alexandra.dk/), 2023.
+License [GNU AGPL](https://gnu.org/licenses/agpl.html).

autoload.php

@@ -0,0 +1,28 @@
+<?php
+
+/**
+ * Modified from https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader-examples.md
+ */
+
+spl_autoload_register(function (string $class): void {
+
+	// project-specific namespace prefix
+	$prefix = 'alexandrainst\\XlsxFastEditor\\';
+
+	// base directory for the namespace prefix
+	$base_dir = __DIR__ . '/src/';
+
+	// does the class use the namespace prefix?
+	$len = strlen($prefix);
+	if (strncmp($prefix, $class, $len) !== 0) {
+		// no, move to the next registered autoloader
+		return;
+	}
+
+	$relative_class = substr($class, $len);
+	$file = $base_dir . str_replace('\\', DIRECTORY_SEPARATOR, $relative_class) . '.php';
+
+	if (file_exists($file)) {
+		require $file;
+	}
+});

composer.json

@@ -0,0 +1,67 @@
+{
+	"name": "alexandrainst/php-xlsx-fast-editor",
+	"version": "1.0.0",
+	"description": "PHP library to make basic and fast read-write operations on existing Excel workbooks",
+	"keywords": [
+		"PHP",
+		"OpenXML",
+		"Excel",
+		"xlsx",
+		"xlsm",
+		"spreadsheet",
+		"workbook",
+		"editor"
+	],
+	"homepage": "https://github.com/alexandrainst/php-xlsx-fast-editor",
+	"type": "library",
+	"license": "AGPL",
+	"authors": [
+		{
+			"name": "Alexandre Alapetite",
+			"homepage": "https://github.com/Alkarex",
+			"role": "Developer"
+		}
+	],
+	"require": {
+		"php": ">=7.4",
+		"ext-ctype": "*",
+		"ext-dom": "*",
+		"ext-xml": "*",
+		"ext-zip": "*"
+	},
+	"require-dev": {
+		"php": ">=8",
+		"ext-simplexml": "*",
+		"ext-tokenizer": "*",
+		"ext-xmlwriter": "*",
+		"phpstan/phpstan": "^1.10",
+		"phpstan/phpstan-strict-rules": "^1.5",
+		"squizlabs/php_codesniffer": "^3.7"
+	},
+	"scripts": {
+		"php-lint": "find . -type d -name 'vendor' -prune -o -name '*.php' -print0 | xargs -0 -n1 -P4 php -l 1>/dev/null",
+		"phpcs": "phpcs . -s",
+		"phpcbf": "phpcbf . -p -s",
+		"phpstan": "phpstan analyse --memory-limit 512M .",
+		"asserts": "php -d zend.assertions tests/test.php",
+		"test": [
+			"@php-lint",
+			"@phpcs",
+			"@phpstan",
+			"@asserts"
+		],
+		"fix": [
+			"@phpcbf"
+		]
+	},
+	"autoload": {
+		"psr-4": {
+			"alexandrainst\\XlsxFastEditor\\": "src/PhpSpreadsheet"
+		}
+	},
+	"config": {
+		"allow-plugins": {
+			"phpstan/extension-installer": false
+		}
+	}
+}