Add a couple of worksheet functions

Author: Alkarex

README.md

@@ -46,6 +46,9 @@ use alexandrainst\XlsxFastEditor\XlsxFastEditorException;
 try {
 	$xlsxFastEditor = new XlsxFastEditor('test.xlsx');
 
+	// Workbook / worksheet methods
+	$nbWorksheets = $xlsxFastEditor->getWorksheetCount();
+	$worksheetName = $xlsxFastEditor->getWorksheetName(1);
 	$worksheetId1 = $xlsxFastEditor->getWorksheetNumber('Sheet1');
 	$worksheetId2 = $xlsxFastEditor->getWorksheetNumber('Sheet2');
 

src/XlsxFastEditor.php

@@ -121,7 +121,19 @@ public function save(bool $close = true): void
 	}
 
 	/**
-	 * Get a worksheet number (ID) from its name.
+	 * Count the number of worksheets in the workbook.
+	 */
+	public function getWorksheetCount(): int
+	{
+		$dom = $this->getDomFromPath(self::WORKBOOK_PATH);
+		$xpath = new \DOMXPath($dom);
+		$xpath->registerNamespace('o', self::OXML_NAMESPACE);
+		$count = $xpath->evaluate('count(/o:workbook/o:sheets/o:sheet)');
+		return is_numeric($count) ? (int)$count : 0;
+	}
+
+	/**
+	 * Get a worksheet number (ID) from its name (base 1).
 	 * @param string $sheetName The name of the worksheet to look up.
 	 * @return int The worksheet ID, or -1 if not found.
 	 */
@@ -137,6 +149,20 @@ public function getWorksheetNumber(string $sheetName): int
 		return -1;
 	}
 
+	/**
+	 * Get a worksheet name from its number (ID).
+	 * @param int $sheetNumber The number of the worksheet to look up.
+	 * @return string|null The worksheet name, or null if not found.
+	 */
+	public function getWorksheetName(int $sheetNumber): ?string
+	{
+		$dom = $this->getDomFromPath(self::WORKBOOK_PATH);
+		$xpath = new \DOMXPath($dom);
+		$xpath->registerNamespace('o', self::OXML_NAMESPACE);
+		$sheetName = $xpath->evaluate("normalize-space(/o:workbook/o:sheets/o:sheet[$sheetNumber][1]/@name)");
+		return is_string($sheetName) ? $sheetName : null;
+	}
+
 	private static function getWorksheetPath(int $sheetNumber): string
 	{
 		return "xl/worksheets/sheet{$sheetNumber}.xml";

tests/test.php

@@ -15,6 +15,8 @@
 try {
 	$xlsxFastEditor = new XlsxFastEditor(__DIR__ . '/_copy.xlsx');
 
+	assert($xlsxFastEditor->getWorksheetCount() === 2);
+
 	$sheet1 = $xlsxFastEditor->getWorksheetNumber('Sheet1');
 	assert($sheet1 === 1);
 
@@ -28,6 +30,7 @@
 
 	$sheet2 = $xlsxFastEditor->getWorksheetNumber('Sheet2');
 	assert($sheet2 === 2);
+	assert($xlsxFastEditor->getWorksheetName($sheet2) === 'Sheet2');
 
 	assert($xlsxFastEditor->readFormula($sheet2, 'c2') === '=Sheet1!C2*2');
 	assert($xlsxFastEditor->readFloat($sheet2, 'D2') === 3.14159 * 2);