ODS classes and methods.
Browse this library and the shared dependency classes returned by its public API. Package ownership remains visible beside each class.
Updated
# Provides the ods class API for format operations.# Declaration: final class Ods# Package: mnb/mnb-phpexcel-ods# Methods: 1Mnb\PHPExcel\Format\Ods{# Purpose: Creates a read session for the supplied source.public static function read(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'array|ReaderOptions $options = [] # Configuration options for this operation. Example: []): ReadSession}# Forward-only OpenDocument Spreadsheet (.ods) reader.# Declaration: final class OdsReader implements IterableReaderInterface, FormatAwareReaderInterface, SheetNamesReaderInterface# Package: mnb/mnb-phpexcel-ods# Methods: 5Mnb\PHPExcel\Reader\OdsReader{# Purpose: Performs the format operation.public function format(): string# Purpose: Iterates over sheet.public function iterateSheet(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'int|string $sheet = 1, # Worksheet name or 1-based worksheet index. Example: 1array $options = [] # Configuration options for this operation. Example: []): iterable# Purpose: Reads sheet.public function readSheet(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'int|string $sheet = 1, # Worksheet name or 1-based worksheet index. Example: 1array $options = [] # Configuration options for this operation. Example: []): array# Purpose: Reads workbook.public function readWorkbook(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'array $options = [] # Configuration options for this operation. Example: []): array# Purpose: Performs the sheet names operation.public function sheetNames(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'array $options = [] # Configuration options for this operation. Example: []): array}# Optional logger bridge. Accepts PSR-3-like objects or callables.# Declaration: final class LoggerBridge# Package: mnb/mnb-phpexcel-core# Methods: 6Mnb\PHPExcel\Application\LoggerBridge{# Purpose: Performs the error operation.public static function error(string $message, # Input value for `$message` (string). Example: 'value'array $context = [] # Input value for `$context` (array). Example: []): void# Purpose: Performs the get operation.public static function get(): mixed# Purpose: Performs the info operation.public static function info(string $message, # Input value for `$message` (string). Example: 'value'array $context = [] # Input value for `$context` (array). Example: []): void# Purpose: Performs the log operation.public static function log(string $level, # Input value for `$level` (string). Example: 'value'string $message, # Input value for `$message` (string). Example: 'value'array $context = [] # Input value for `$context` (array). Example: []): void# Purpose: Performs the set operation.public static function set($logger # Input value for `$logger`.): void# Purpose: Performs the warning operation.public static function warning(string $message, # Input value for `$message` (string). Example: 'value'array $context = [] # Input value for `$context` (array). Example: []): void}# Ordered row transformations for application imports.# Declaration: final class RowTransformerPipeline# Package: mnb/mnb-phpexcel-core# Methods: 5Mnb\PHPExcel\Application\RowTransformerPipeline{# Purpose: Performs the apply operation.public static function apply(array $row, # Row value or 1-based row number. Example: []array $transformers = [], # Input value for `$transformers` (array). Example: []array $context = [] # Input value for `$context` (array). Example: []): array# Purpose: Applies rows.public static function applyRows(array $rows, # Rows supplied for reading, writing, validation, or import. Example: []array $transformers = [], # Input value for `$transformers` (array). Example: []array $context = [] # Input value for `$context` (array). Example: []): array# Purpose: Performs the clear operation.public static function clear(): void# Purpose: Performs the names operation.public static function names(): array# Purpose: Performs the register operation.public static function register(string $name, # Name used to identify the target value. Example: 'value'callable $transformer # Input value for `$transformer` (callable). Example: static fn ($value) => $value): void}# Provides the reader plugin interface interface API for contracts operations.# Declaration: interface ReaderPluginInterface# Package: mnb/mnb-phpexcel-core# Methods: 2Mnb\PHPExcel\Contracts\ReaderPluginInterface{# Purpose: Creates a read session for the supplied source.abstract public function read(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'array $options = [] # Configuration options for this operation. Example: []): iterable# Purpose: Performs the supports operation.abstract public function supports(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'array $options = [] # Configuration options for this operation. Example: []): bool}# Provides the writer plugin interface interface API for contracts operations.# Declaration: interface WriterPluginInterface# Package: mnb/mnb-phpexcel-core# Methods: 2Mnb\PHPExcel\Contracts\WriterPluginInterface{# Purpose: Performs the supports operation.abstract public function supports(string $format, # Spreadsheet or data format identifier. Example: 'xlsx'array $options = [] # Configuration options for this operation. Example: []): bool# Purpose: Writes the supplied data to the destination.abstract public function write(iterable $rows, # Rows supplied for reading, writing, validation, or import. Example: []string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'array $options = [] # Configuration options for this operation. Example: []): string}# Explicit typed cell value for array-first exports.# Declaration: final class CellValue# Package: mnb/mnb-phpexcel-core# Methods: 13Mnb\PHPExcel\Core\CellValue{# Purpose: Performs the blank operation.public static function blank(): self# Purpose: Performs the bool operation.public static function bool(bool $value # Value supplied to the operation. Example: true): self# Purpose: Performs the cached value operation.public function cachedValue(): mixed# Purpose: Performs the date operation.public static function date(DateTimeInterface|string $value, # Value supplied to the operation. Example: 'value'array $options = [] # Configuration options for this operation. Example: []): self# Purpose: Performs the display value operation.public function displayValue(): string|int|float|bool|null# Purpose: Performs the error operation.public static function error(string $code # Input value for `$code` (string). Example: 'value'): self# Purpose: Performs the formula operation.public static function formula(string $formula, # Input value for `$formula` (string). Example: 'value'$cachedValue = null, # Input value for `$cachedValue`.array $options = [] # Configuration options for this operation. Example: []): self# Purpose: Creates the value from array.public static function fromArray(array $definition # Input value for `$definition` (array). Example: []): self# Purpose: Performs the number operation.public static function number(int|float|string $value # Value supplied to the operation. Example: 1): self# Purpose: Performs the options operation.public function options(): array# Purpose: Performs the text operation.public static function text($value # Value supplied to the operation.): self# Purpose: Performs the type operation.public function type(): string# Purpose: Performs the value operation.public function value(): mixed}# Provides the rich text class API for core operations.# Declaration: final class RichText implements \Stringable, \JsonSerializable# Package: mnb/mnb-phpexcel-core# Methods: 6Mnb\PHPExcel\Core\RichText{# Purpose: Creates a new RichText instance.public function __construct(array $runs # Input value for `$runs` (array). Example: []): mixed# Purpose: Creates the value from array.public static function fromArray(array $runs # Input value for `$runs` (array). Example: []): self# Purpose: Performs the json serialize operation.public function jsonSerialize(): array# Purpose: Performs the plain operation.public static function plain(string $text # Input value for `$text` (string). Example: 'value'): self# Purpose: Performs the text operation.public function text(): string# Purpose: Performs the to string operation.public function __toString(): string}# Provides the rich text run class API for core operations.# Declaration: final class RichTextRun implements \JsonSerializable# Package: mnb/mnb-phpexcel-core# Methods: 3Mnb\PHPExcel\Core\RichTextRun{# Purpose: Creates a new RichTextRun instance.public function __construct(string $text, # Input value for `$text` (string). Example: 'value'array $style = [] # Input value for `$style` (array). Example: []): mixed# Purpose: Creates the value from array.public static function fromArray(array $data # Input value for `$data` (array). Example: []): self# Purpose: Performs the json serialize operation.public function jsonSerialize(): array}# Provides the workbook data class API for core operations.# Declaration: final class WorkbookData# Package: mnb/mnb-phpexcel-core# Methods: 1Mnb\PHPExcel\Core\WorkbookData{# Purpose: Creates a new WorkbookData instance.public function __construct(array $sheets, # Input value for `$sheets` (array). Example: []array $metadata = [] # Input value for `$metadata` (array). Example: []): mixed}# Small, dependency-free factory used by format-specific modular facades.# Declaration: final class WorkbookFactory# Package: mnb/mnb-phpexcel-core# Methods: 2Mnb\PHPExcel\Core\WorkbookFactory{# Purpose: Performs the workbook operation.public static function workbook(iterable $rows, # Rows supplied for reading, writing, validation, or import. Example: []string $sheetName = 'Sheet1', # Worksheet name. Example: 'Sheet1'bool $withHeader = false # Input value for `$withHeader` (bool). Example: false): WorkbookData# Purpose: Performs the worksheet operation.public static function worksheet(iterable $rows, # Rows supplied for reading, writing, validation, or import. Example: []string $name = 'Sheet1', # Name used to identify the target value. Example: 'Sheet1'bool $withHeader = false # Input value for `$withHeader` (bool). Example: false): WorksheetData}# Provides the worksheet data class API for core operations.# Declaration: final class WorksheetData# Package: mnb/mnb-phpexcel-core# Methods: 2Mnb\PHPExcel\Core\WorksheetData{# Purpose: Creates a new WorksheetData instance.public function __construct(string $name, # Name used to identify the target value. Example: 'value'array $rows, # Rows supplied for reading, writing, validation, or import. Example: []array $columns = [], # Columns included in the operation. Example: []bool $hasHeader = false, # Input value for `$hasHeader` (bool). Example: falsearray $textColumns = [], # Input value for `$textColumns` (array). Example: []array $dateColumns = [], # Input value for `$dateColumns` (array). Example: []array $numberColumns = [], # Input value for `$numberColumns` (array). Example: []bool $freezeHeader = false, # Input value for `$freezeHeader` (bool). Example: falsebool $autoFilter = false, # Input value for `$autoFilter` (bool). Example: falsebool $escapeFormulaLikeText = true, # Input value for `$escapeFormulaLikeText` (bool). Example: truearray|string $headerStyle = [], # Input value for `$headerStyle` (array|string). Example: []array $mergeCells = [], # Input value for `$mergeCells` (array). Example: []array $columnWidths = [], # Input value for `$columnWidths` (array). Example: []array $rowHeights = [], # Input value for `$rowHeights` (array). Example: []array $images = [], # Input value for `$images` (array). Example: []public?int $headerRowIndex = null, # Input value for `$headerRowIndex` (public?int).array $namedStyles = [], # Input value for `$namedStyles` (array). Example: []array $columnStyles = [], # Input value for `$columnStyles` (array). Example: []array $rowStyles = [], # Input value for `$rowStyles` (array). Example: []array $cellStyles = [], # Input value for `$cellStyles` (array). Example: []array $rangeStyles = [], # Input value for `$rangeStyles` (array). Example: []array $hyperlinks = [], # Input value for `$hyperlinks` (array). Example: []array $comments = [], # Input value for `$comments` (array). Example: []array $sourceColumnKeys = [], # Original associative keys, in worksheet column order. Example: []int $dataRowStart = 0, # Input value for `$dataRowStart` (int). Example: 0public?int $dataRowCount = null, # Input value for `$dataRowCount` (public?int).int $freezeRows = 0, # Input value for `$freezeRows` (int). Example: 0int $freezeColumns = 0, # Input value for `$freezeColumns` (int). Example: 0public?string $freezeTopLeftCell = null, # Input value for `$freezeTopLeftCell` (public?string). Example: 'value'public?string $autoFilterRange = null, # Input value for `$autoFilterRange` (public?string). Example: 'value'array $filterColumns = [], # Input value for `$filterColumns` (array). Example: []array $conditionalFormats = [], # Input value for `$conditionalFormats` (array). Example: []array $dataValidations = [], # Input value for `$dataValidations` (array). Example: []array $charts = [], # Input value for `$charts` (array). Example: []array $pivotTables = [] # Input value for `$pivotTables` (array). Example: []): mixed# Purpose: Return rows suitable for JSON/XML export while restoring associative source keys for the workbook's data-row region.public function rowsForStructuredExport(bool $preserveAssociative = true, # Input value for `$preserveAssociative` (bool). Example: truebool $dataOnly = false # Input value for `$dataOnly` (bool). Example: false): array}# Tiny framework-neutral event dispatcher. Listeners are process-local and optional.# Declaration: final class EventDispatcher# Package: mnb/mnb-phpexcel-core# Methods: 5Mnb\PHPExcel\Events\EventDispatcher{# Purpose: Performs the clear operation.public static function clear(?string $event = null # Input value for `$event` (?string). Example: 'value'): void# Purpose: Performs the dispatch operation.public static function dispatch(string $event, # Input value for `$event` (string). Example: 'value'array $payload = [] # Input value for `$payload` (array). Example: []): array# Purpose: Returns a list of en.public static function listen(string $event, # Input value for `$event` (string). Example: 'value'callable $listener # Input value for `$listener` (callable). Example: static fn ($value) => $value): void# Purpose: Dispatch import failure without allowing listener failures to hide the real exception.public static function safeDispatch(string $event, # Input value for `$event` (string). Example: 'value'array $payload = [] # Input value for `$payload` (array). Example: []): void# Purpose: Performs the summary operation.public static function summary(): array}# Optional capability for formats that expose the workbook's active worksheet.# Declaration: interface ActiveSheetReaderInterface extends ReaderInterface# Package: mnb/mnb-phpexcel-core# Methods: 1Mnb\PHPExcel\Reader\ActiveSheetReaderInterface{# Purpose: Return the active worksheet using a 1-based index.abstract public function activeSheet(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'array $options = [] # Configuration options for this operation. Example: []): array}# Optional advanced workbook capability used by XLSX and future rich formats. Core depends only on this contract; concrete format packages provide the implementation.# Declaration: interface AdvancedReaderInterface extends IterableReaderInterface, FormatAwareReaderInterface, SheetNamesReaderInterface, InspectableReaderInterface# Package: mnb/mnb-phpexcel-core# Methods: 13Mnb\PHPExcel\Reader\AdvancedReaderInterface{# Purpose: Performs the calculate cell operation.abstract public function calculateCell(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'string $cell, # Worksheet cell reference. Example: 'A1'int|string $sheet = 1, # Worksheet name or 1-based worksheet index. Example: 1array $options = [] # Configuration options for this operation. Example: []): mixed# Purpose: Performs the calculate range operation.abstract public function calculateRange(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'string $range, # Worksheet cell range. Example: 'A1:D100'int|string $sheet = 1, # Worksheet name or 1-based worksheet index. Example: 1array $options = [] # Configuration options for this operation. Example: []): array# Purpose: Performs the extract images operation.abstract public function extractImages(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'string $directory, # Input value for `$directory` (string). Example: 'value'int|string $sheet = 1, # Worksheet name or 1-based worksheet index. Example: 1bool $overwrite = false, # Input value for `$overwrite` (bool). Example: falsearray $options = [] # Configuration options for this operation. Example: []): array# Purpose: Performs the images operation.abstract public function images(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'int|string $sheet = 1, # Worksheet name or 1-based worksheet index. Example: 1bool $includeBytes = false, # Input value for `$includeBytes` (bool). Example: falsearray $options = [] # Configuration options for this operation. Example: []): array# Purpose: Reads cell.abstract public function readCell(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'string $cell, # Worksheet cell reference. Example: 'A1'int|string $sheet = 1, # Worksheet name or 1-based worksheet index. Example: 1array $options = [] # Configuration options for this operation. Example: []): mixed# Purpose: Reads cell details.abstract public function readCellDetails(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'string $cell, # Worksheet cell reference. Example: 'A1'int|string $sheet = 1, # Worksheet name or 1-based worksheet index. Example: 1array $options = [] # Configuration options for this operation. Example: []): CellSnapshot# Purpose: Reads cells.abstract public function readCells(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'array $cells, # Input value for `$cells` (array). Example: []int|string $sheet = 1, # Worksheet name or 1-based worksheet index. Example: 1array $options = [] # Configuration options for this operation. Example: []): array# Purpose: Reads cell style.abstract public function readCellStyle(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'string $cell, # Worksheet cell reference. Example: 'A1'int|string $sheet = 1, # Worksheet name or 1-based worksheet index. Example: 1array $options = [] # Configuration options for this operation. Example: []): array# Purpose: Reads protection.abstract public function readProtection(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'int|string $sheet = 1, # Worksheet name or 1-based worksheet index. Example: 1array $options = [] # Configuration options for this operation. Example: []): array# Purpose: Reads range.abstract public function readRange(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'string $range, # Worksheet cell range. Example: 'A1:D100'int|string $sheet = 1, # Worksheet name or 1-based worksheet index. Example: 1array $options = [] # Configuration options for this operation. Example: []): array# Purpose: Reads range styles.abstract public function readRangeStyles(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'string $range, # Worksheet cell range. Example: 'A1:D100'int|string $sheet = 1, # Worksheet name or 1-based worksheet index. Example: 1array $options = [] # Configuration options for this operation. Example: []): array# Purpose: Reads rich text cell.abstract public function readRichTextCell(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'string $cell, # Worksheet cell reference. Example: 'A1'int|string $sheet = 1, # Worksheet name or 1-based worksheet index. Example: 1array $options = [] # Configuration options for this operation. Example: []): ?RichText# Purpose: Reads sheet metadata.abstract public function readSheetMetadata(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'int|string $sheet = 1, # Worksheet name or 1-based worksheet index. Example: 1array $options = [] # Configuration options for this operation. Example: []): array}# Source-level projection used before row normalization and header mapping.# Declaration: final class ColumnProjection# Package: mnb/mnb-phpexcel-core# Methods: 7Mnb\PHPExcel\Reader\ColumnProjection{# Purpose: Performs the active operation.public function active(): bool# Purpose: Performs the compact operation.public function compact(): bool# Purpose: Creates the value from options.public static function fromOptions(array $options # Configuration options for this operation. Example: []): self# Purpose: Performs the includes index operation.public function includesIndex(int $oneBasedIndex # Input value for `$oneBasedIndex` (int). Example: 1): bool# Purpose: Performs the includes key operation.public function includesKey(string $key # Key used to identify the target value. Example: 'value'): bool# Purpose: Performs the indexes operation.public function indexes(): array# Purpose: Performs the project operation.public function project(array $row # Row value or 1-based row number. Example: []): array}# Optional capability exposing the normalized format name handled by a reader.# Declaration: interface FormatAwareReaderInterface extends ReaderInterface# Package: mnb/mnb-phpexcel-core# Methods: 1Mnb\PHPExcel\Reader\FormatAwareReaderInterface{# Purpose: Performs the format operation.abstract public function format(): string}# Provides the header detector class API for reader operations.# Declaration: final class HeaderDetector# Package: mnb/mnb-phpexcel-core# Methods: 1Mnb\PHPExcel\Reader\HeaderDetector{# Purpose: Detect the most likely physical header row in a source sample.public function detect(array $rows, # keyed by zero-based source row index. Example: []int $maxRows = 25 # Input value for `$maxRows` (int). Example: 25): HeaderDetection}# Optional capability for format-specific workbook inspection.# Declaration: interface InspectableReaderInterface extends ReaderInterface# Package: mnb/mnb-phpexcel-core# Methods: 1Mnb\PHPExcel\Reader\InspectableReaderInterface{# Purpose: Performs the inspect operation.abstract public function inspect(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'array $options = [] # Configuration options for this operation. Example: []): array}# Optional reader contract for forward-only row iteration.# Declaration: interface IterableReaderInterface extends ReaderInterface# Package: mnb/mnb-phpexcel-core# Methods: 1Mnb\PHPExcel\Reader\IterableReaderInterface{# Purpose: Iterates over sheet.abstract public function iterateSheet(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'int|string $sheet = 1, # Worksheet name or 1-based worksheet index. Example: 1array $options = [] # Configuration options for this operation. Example: []): iterable}# Immutable, typed read configuration.# Declaration: final class ReaderOptions# Package: mnb/mnb-phpexcel-core# Methods: 13Mnb\PHPExcel\Reader\Options\ReaderOptions{# Purpose: Performs the defaults operation.public static function defaults(): self# Purpose: Creates the value from array.public static function fromArray(array $values = [] # Values supplied to the operation. Example: []): self# Purpose: Performs the get operation.public function get(string $key, # Key used to identify the target value. Example: 'value'$default = null # Input value for `$default`.): mixed# Purpose: Returns the current result as an array.public function toArray(): array# Purpose: Performs the with operation.public function with(array $values # Values supplied to the operation. Example: []): self# Purpose: Detect the most likely physical header row from the first source rows.public function withAutoHeader(int $sampleRows = 25, # Input value for `$sampleRows` (int). Example: 25float $minimumConfidence = 0.35 # Input value for `$minimumConfidence` (float). Example: 0.35): self# Purpose: Returns a copy configured with columns.public function withColumns(array $columns, # Columns included in the operation. Example: []bool $compact = true # Input value for `$compact` (bool). Example: true): self# Purpose: Returns a copy configured with formula mode.public function withFormulaMode(string $mode # Input value for `$mode` (string). Example: 'value'): self# Purpose: Returns a copy configured with mode.public function withMode(ReadMode|string $mode # Input value for `$mode` (ReadMode|string). Example: 'value'): self# Purpose: Supply the password used to open an encrypted XLSX workbook.public function withPassword(string $password # Password used for protection or encryption. Example: 'secret'): self# Purpose: Returns a copy configured with progress.public function withProgress(callable $callback, # Callback invoked during this operation. Example: static fn ($value) => $valueint $everyRows = 1000 # Input value for `$everyRows` (int). Example: 1000): self# Purpose: Returns a copy configured with range.public function withRange(?int $startRow = null, # Input value for `$startRow` (?int).?int $endRow = null, # Input value for `$endRow` (?int).int|string|null $startColumn = null, # Input value for `$startColumn` (int|string|null). Example: 1int|string|null $endColumn = null # Input value for `$endColumn` (int|string|null). Example: 1): self# Purpose: Returns a copy configured with row error policy.public function withRowErrorPolicy(RowErrorPolicy|string $policy, # Input value for `$policy` (RowErrorPolicy|string). Example: 'value'?callable $handler = null # Handler invoked by the operation. Example: static fn ($value) => $value): self}# Provides the read mode enum API for options operations.# Declaration: enum ReadMode :string# Package: mnb/mnb-phpexcel-core# Methods: 1Mnb\PHPExcel\Reader\Options\ReadMode{# Purpose: Creates the value from mixed.public static function fromMixed(self|string|null $value # Value supplied to the operation. Example: 'value'): self}# Provides the row error policy enum API for options operations.# Declaration: enum RowErrorPolicy :string# Package: mnb/mnb-phpexcel-core# Methods: 1Mnb\PHPExcel\Reader\Options\RowErrorPolicy{# Purpose: Creates the value from mixed.public static function fromMixed(self|string|null $value # Value supplied to the operation. Example: 'value'): self}# Provides the plugin reader adapter class API for plugin operations.# Declaration: final class PluginReaderAdapter implements IterableReaderInterface# Package: mnb/mnb-phpexcel-core# Methods: 3Mnb\PHPExcel\Reader\Plugin\PluginReaderAdapter{# Purpose: Creates a new PluginReaderAdapter instance.public function __construct(ReaderPluginInterface $plugin # Input value for `$plugin` (ReaderPluginInterface).): mixed# Purpose: Iterates over sheet.public function iterateSheet(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'int|string $sheet = 1, # Worksheet name or 1-based worksheet index. Example: 1array $options = [] # Configuration options for this operation. Example: []): iterable# Purpose: Reads sheet.public function readSheet(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'int|string $sheet = 1, # Worksheet name or 1-based worksheet index. Example: 1array $options = [] # Configuration options for this operation. Example: []): array}# Provides the reader interface interface API for reader operations.# Declaration: interface ReaderInterface# Package: mnb/mnb-phpexcel-core# Methods: 1Mnb\PHPExcel\Reader\ReaderInterface{# Purpose: Reads sheet.abstract public function readSheet(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'int|string $sheet = 1, # Sheet index starting at 1, or sheet name when supported by the reader. Example: 1array $options = [] # Configuration options for this operation. Example: []): array}# Instance-scoped reader registry for long-running workers and plugins.# Declaration: final class ReaderRegistry# Package: mnb/mnb-phpexcel-core# Methods: 6Mnb\PHPExcel\Reader\ReaderRegistry{# Purpose: Performs the formats operation.public function formats(): array# Purpose: Performs the has operation.public function has(string $format # Spreadsheet or data format identifier. Example: 'xlsx'): bool# Purpose: Performs the register operation.public function register(string $format, # Spreadsheet or data format identifier. Example: 'xlsx'callable|ReaderInterface $reader # Reader implementation used by the session. Example: static fn ($value) => $value): self# Purpose: Performs the register plugin operation.public function registerPlugin(ReaderPluginInterface $plugin, # Input value for `$plugin` (ReaderPluginInterface).int $priority = 0 # Input value for `$priority` (int). Example: 0): self# Purpose: Performs the resolve operation.public function resolve(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'array $options = [] # Configuration options for this operation. Example: []): ReaderInterface# Purpose: Returns a copy configured with built ins.public static function withBuiltIns(): self}# Provides the read session class API for reader operations.# Declaration: final class ReadSession# Package: mnb/mnb-phpexcel-core# Methods: 75Mnb\PHPExcel\Reader\ReadSession{# Purpose: Creates a new ReadSession instance.public function __construct(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'ReaderInterface $reader, # Reader implementation used by the session.array|ReaderOptions $defaultOptions = [] # Input value for `$defaultOptions` (array|ReaderOptions). Example: []): mixed# Purpose: Select the workbook's active worksheet.public function activeSheet(): self# Purpose: Return the active worksheet number using the library's 1-based indexing.public function activeSheetIndex(): int# Purpose: Performs the active sheet info operation.public function activeSheetInfo(): array# Purpose: Performs the active sheet name operation.public function activeSheetName(): string# Purpose: Require at least one normalized data row and keep the session fluent.public function assertHasRows(array|ReaderOptions $options = [], # Configuration options for this operation. Example: []?string $message = null # Input value for `$message` (?string). Example: 'value'): self# Throws: EmptyWorksheetException# Purpose: Detect the most likely source header row before reading data.public function autoDetectHeader(int $sampleRows = 25, # Input value for `$sampleRows` (int). Example: 25float $minimumConfidence = 0.35 # Input value for `$minimumConfidence` (float). Example: 0.35): self# Purpose: Performs the calculated cell operation.public function calculatedCell(string $cell # Worksheet cell reference. Example: 'A1'): mixed# Purpose: Performs the calculated range operation.public function calculatedRange(string $range # Worksheet cell range. Example: 'A1:D100'): array# Purpose: Read one XLSX cell directly by Excel reference, for example A1.public function cell(string $cell, # Worksheet cell reference. Example: 'A1'array|ReaderOptions $options = [] # Configuration options for this operation. Example: []): mixed# Purpose: Return value, formula, calculated/cached values, rich text, style, comments and hyperlinks for a cell.public function cellDetails(string $cell, # Worksheet cell reference. Example: 'A1'array|ReaderOptions $options = [] # Configuration options for this operation. Example: []): CellSnapshot# Purpose: Performs the cells operation.public function cells(array $cells, # Input value for `$cells` (array). Example: []array|ReaderOptions $options = [] # Configuration options for this operation. Example: []): array# Purpose: Performs the cell style operation.public function cellStyle(string $cell # Worksheet cell reference. Example: 'A1'): array# Purpose: Performs the chunk operation.public function chunk(int $size, # Input value for `$size` (int). Example: 1callable $callback, # Callback invoked during this operation. Example: static fn ($value) => $valuearray $options = [] # Configuration options for this operation. Example: []): array# Purpose: Performs the chunks operation.public function chunks(int $size, # Input value for `$size` (int). Example: 1array|ReaderOptions $options = [] # Configuration options for this operation. Example: []): \Generator# Purpose: Returns the number of rows.public function countRows(array|ReaderOptions $options = [] # Configuration options for this operation. Example: []): int# Purpose: Inspect a source sample and return the most likely physical header row.public function detectHeader(array|ReaderOptions $options = [] # Configuration options for this operation. Example: []): HeaderDetection# Purpose: Build an SQL import plan without inserting data.public function dryRunImportToSql(PDO|array|string|null $pdo, # PDO connection used for database operations. Example: []string $table, # Database table name. Example: 'imports'array $options = [] # Configuration options for this operation. Example: []): array# Purpose: Detect duplicate rows after reading the selected sheet.public function duplicateRows(array $columns, # Columns included in the operation. Example: []array $readOptions = [], # Input value for `$readOptions` (array). Example: []array $duplicateOptions = [] # Input value for `$duplicateOptions` (array). Example: []): array# Purpose: Performs the each row operation.public function eachRow(callable $callback, # Callback invoked during this operation. Example: static fn ($value) => $valuearray $options = [] # Configuration options for this operation. Example: []): array# Purpose: Performs the extract images operation.public function extractImages(string $directory, # Input value for `$directory` (string). Example: 'value'bool $overwrite = false # Input value for `$overwrite` (bool). Example: false): array# Purpose: Returns the first matching item.public function first(array|ReaderOptions $options = [] # Configuration options for this operation. Example: []): ?array# Purpose: Use the first non-empty source row as column headers.public function firstNonEmptyRowAsHeader(): self# Purpose: Return true when at least one normalized data row remains after all current options.public function hasRows(array|ReaderOptions $options = [] # Configuration options for this operation. Example: []): bool# Purpose: Return true when a 1-based worksheet number or worksheet name exists.public function hasSheet(int|string|null $sheet # Worksheet name or 1-based worksheet index. Example: 'Sheet1'): bool# Purpose: Treat the selected 1-based normalized data row as column headers.public function headerAtDataRow(int $row = 1 # Row value or 1-based row number. Example: 1): self# Purpose: Treat the exact 1-based physical source row as column headers.public function headerAtPhysicalRow(int $row # Row value or 1-based row number. Example: 1): self# Purpose: Performs the images operation.public function images(bool $includeBytes = false # Input value for `$includeBytes` (bool). Example: false): array# Purpose: Imports to sql.public function importToSql(PDO|array|string|null $pdo, # PDO connection used for database operations. Example: []string $table, # Database table name. Example: 'imports'array $options = [] # Configuration options for this operation. Example: []): array# Purpose: Performs the inspect operation.public function inspect(): array# Purpose: Return true when zero normalized data rows remain after all current options.public function isEmpty(array|ReaderOptions $options = [] # Configuration options for this operation. Example: []): bool# Purpose: Limit normalized data rows returned by rows(), eachRow(), chunk(), or first().public function limit(int $rows # Rows supplied for reading, writing, validation, or import. Example: 1): self# Purpose: Performs the mode operation.public function mode(ReadMode|string $mode # Input value for `$mode` (ReadMode|string). Example: 'value'): self# Purpose: Performs the normal operation.public function normal(): self# Purpose: Performs the on progress operation.public function onProgress(callable $callback, # Callback invoked during this operation. Example: static fn ($value) => $valueint $everyRows = 1000 # Input value for `$everyRows` (int). Example: 1000): self# Purpose: Performs the on row error operation.public function onRowError(RowErrorPolicy|string $policy, # Input value for `$policy` (RowErrorPolicy|string). Example: 'value'?callable $handler = null # Handler invoked by the operation. Example: static fn ($value) => $value): self# Purpose: Performs the options operation.public function options(): array# Purpose: Preview rows before validation/import. Usually pass header_row => true.public function previewImport(array $readOptions = [], # Input value for `$readOptions` (array). Example: []array $previewOptions = [] # Input value for `$previewOptions` (array). Example: []): array# Purpose: Performs the project columns operation.public function projectColumns(array $columns, # Columns included in the operation. Example: []bool $compact = true # Input value for `$compact` (bool). Example: true): self# Purpose: Return file, workbook, and selected worksheet protection metadata.public function protection(): array# Purpose: Returns a copy configured for the selected row and column range.public function range(?int $startRow = null, # Input value for `$startRow` (?int).?int $endRow = null, # Input value for `$endRow` (?int).int|string|null $startColumn = null, # Input value for `$startColumn` (int|string|null). Example: 1int|string|null $endColumn = null # Input value for `$endColumn` (int|string|null). Example: 1): self# Purpose: Performs the range styles operation.public function rangeStyles(string $range # Worksheet cell range. Example: 'A1:D100'): array# Purpose: Read a rectangular XLSX range as a two-dimensional row array.public function rangeValues(string $range, # Worksheet cell range. Example: 'A1:D100'array|ReaderOptions $options = [] # Configuration options for this operation. Example: []): array# Purpose: Alias for assertHasRows().public function requireRows(array|ReaderOptions $options = [], # Configuration options for this operation. Example: []?string $message = null # Input value for `$message` (?string). Example: 'value'): self# Purpose: Performs the rich text operation.public function richText(string $cell # Worksheet cell reference. Example: 'A1'): ?RichText# Purpose: Performs the row errors operation.public function rowErrors(): array# Purpose: Iterate normalized rows. CSV and XLSX readers are forward-only here; JSON and XML may buffer their document structure before yielding rows.public function rows(array|ReaderOptions $options = [] # Configuration options for this operation. Example: []): \Generator# Purpose: Performs the row states operation.public function rowStates(array|ReaderOptions $options = [] # Configuration options for this operation. Example: []): \Generator# Purpose: Save selected sheet rows as JSON after normal read normalization.public function saveJson(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'array $readOptions = [], # Input value for `$readOptions` (array). Example: []array $jsonOptions = [] # Input value for `$jsonOptions` (array). Example: []): string# Purpose: Saves structured json.public function saveStructuredJson(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'array $readOptions = [], # Input value for `$readOptions` (array). Example: []array $jsonOptions = [] # Input value for `$jsonOptions` (array). Example: []): string# Purpose: Save structured workbook/sheet output as an XML file.public function saveStructuredXml(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'array $readOptions = [], # Input value for `$readOptions` (array). Example: []array $xmlOptions = [] # Input value for `$xmlOptions` (array). Example: []): string# Purpose: Save selected sheet rows as XML after normal read normalization.public function saveXml(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'array $readOptions = [], # Input value for `$readOptions` (array). Example: []array $xmlOptions = [] # Input value for `$xmlOptions` (array). Example: []): string# Purpose: Performs the select columns operation.public function selectColumns(array $columns # Columns included in the operation. Example: []): self# Purpose: Alias for sheetOrActive().public function selectSheetOrActive(int|string|null $sheet = null # Worksheet name or 1-based worksheet index. Example: 'Sheet1'): self# Purpose: Returns a copy configured for the selected worksheet.public function sheet(int|string|null $sheetNumber = null # Worksheet name or 1-based worksheet index. Example: 1): self# Purpose: Alias for hasSheet() for discoverable conditional-selection code.public function sheetExists(int|string|null $sheet # Worksheet name or 1-based worksheet index. Example: 'Sheet1'): bool# Purpose: Return a selected session when the worksheet exists, otherwise null.public function sheetIfExists(int|string|null $sheet # Worksheet name or 1-based worksheet index. Example: 'Sheet1'): ?self# Purpose: Return XLSX-only cell metadata for the selected sheet: rich text runs, comments, hyperlinks, and advanced object inventory. CSV/JSON readers return an empty metadata shape.public function sheetMetadata(array $options = [] # Configuration options for this operation. Example: []): array# Purpose: Performs the sheet names operation.public function sheetNames(): array# Purpose: Select an optional worksheet value, falling back to the workbook's active worksheet when the value is null or an empty string.public function sheetOrActive(int|string|null $sheet = null # Worksheet name or 1-based worksheet index. Example: 'Sheet1'): self# Purpose: Skip normalized data rows after an optional header row.public function skip(int $rows # Rows supplied for reading, writing, validation, or import. Example: 1): self# Purpose: Streams ing.public function streaming(): self# Purpose: Returns the current result as an array.public function toArray(array|ReaderOptions $options = [] # Configuration options for this operation. Example: []): array# Purpose: Convert selected sheet rows to a JSON string after normal read normalization.public function toJson(array $readOptions = [], # Input value for `$readOptions` (array). Example: []array $jsonOptions = [] # Input value for `$jsonOptions` (array). Example: []): string# Purpose: Return a professional workbook-level structure instead of only row arrays.public function toStructuredArray(array $options = [] # Configuration options for this operation. Example: []): array# Purpose: Converts the value to structured json.public function toStructuredJson(array $readOptions = [], # Input value for `$readOptions` (array). Example: []array $jsonOptions = [] # Input value for `$jsonOptions` (array). Example: []): string# Purpose: Return selected-sheet structured output.public function toStructuredSheetArray(array $options = [] # Configuration options for this operation. Example: []): array# Purpose: Return workbook-level structured output with all sheets.public function toStructuredWorkbookArray(array $options = [] # Configuration options for this operation. Example: []): array# Purpose: Return structured workbook/sheet output as an XML string without saving. Use this for API responses, browser output, logs, or assigning XML to a variable.public function toStructuredXml(array $readOptions = [], # Input value for `$readOptions` (array). Example: []array $xmlOptions = [] # Input value for `$xmlOptions` (array). Example: []): string# Purpose: Convert selected sheet rows to an XML string after normal read normalization.public function toXml(array $readOptions = [], # Input value for `$readOptions` (array). Example: []array $xmlOptions = [] # Input value for `$xmlOptions` (array). Example: []): string# Purpose: Alias for activeSheet() when used as a fluent selection operation.public function useActiveSheet(): self# Purpose: Validate rows read from the selected sheet.public function validateImport(array $rules, # Input value for `$rules` (array). Example: []array $readOptions = [], # Input value for `$readOptions` (array). Example: []array $validationOptions = [] # Input value for `$validationOptions` (array). Example: []): array# Purpose: Treat the selected 1-based normalized data row as column headers. Empty rows are excluded when skip_empty_rows=true (the default).public function withHeaderRow(int $row = 1 # Row value or 1-based row number. Example: 1): self# Purpose: Returns a copy configured with options.public function withOptions(array|ReaderOptions $options # Configuration options for this operation. Example: []): self# Purpose: Returns a copy configured with out header row.public function withoutHeaderRow(): self}# Optional capability for formats that can expose workbook sheet names.# Declaration: interface SheetNamesReaderInterface extends ReaderInterface# Package: mnb/mnb-phpexcel-core# Methods: 1Mnb\PHPExcel\Reader\SheetNamesReaderInterface{# Purpose: Performs the sheet names operation.abstract public function sheetNames(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'array $options = [] # Configuration options for this operation. Example: []): array}# Provides the cell snapshot class API for state operations.# Declaration: final class CellSnapshot implements \JsonSerializable# Package: mnb/mnb-phpexcel-core# Methods: 2Mnb\PHPExcel\Reader\State\CellSnapshot{# Purpose: Creates a new CellSnapshot instance.public function __construct(string $cell, # Worksheet cell reference. Example: 'A1'$value, # Value supplied to the operation.readonly?string $formula = null, # Input value for `$formula` (readonly?string). Example: 'value'$cachedValue = null, # Input value for `$cachedValue`.$calculatedValue = null, # Input value for `$calculatedValue`.readonly?RichText $richText = null, # Input value for `$richText` (readonly?RichText).array $style = [], # Input value for `$style` (array). Example: []array $comments = [], # Input value for `$comments` (array). Example: []array $hyperlinks = [], # Input value for `$hyperlinks` (array). Example: []array $images = [] # Input value for `$images` (array). Example: []): mixed# Purpose: Performs the json serialize operation.public function jsonSerialize(): array}# Provides the formula result class API for state operations.# Declaration: final class FormulaResult implements \JsonSerializable# Package: mnb/mnb-phpexcel-core# Methods: 2Mnb\PHPExcel\Reader\State\FormulaResult{# Purpose: Creates a new FormulaResult instance.public function __construct(string $formula, # Input value for `$formula` (string). Example: 'value'$cachedValue, # Input value for `$cachedValue`.string $resultType = 'unknown', # Input value for `$resultType` (string). Example: 'unknown'array $metadata = [] # Input value for `$metadata` (array). Example: []): mixed# Purpose: Performs the json serialize operation.public function jsonSerialize(): array}# Provides the header detection class API for state operations.# Declaration: final class HeaderDetection implements \JsonSerializable# Package: mnb/mnb-phpexcel-core# Methods: 2Mnb\PHPExcel\Reader\State\HeaderDetection{# Purpose: Creates a new HeaderDetection instance.public function __construct(int $row, # Row value or 1-based row number. Example: 1float $confidence, # Input value for `$confidence` (float). Example: 1.0array $candidates = [] # Input value for `$candidates` (array). Example: []): mixed# Purpose: Performs the json serialize operation.public function jsonSerialize(): array}# Provides the read progress class API for state operations.# Declaration: final class ReadProgress implements \JsonSerializable# Package: mnb/mnb-phpexcel-core# Methods: 2Mnb\PHPExcel\Reader\State\ReadProgress{# Purpose: Creates a new ReadProgress instance.public function __construct(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'int|string $sheet, # Worksheet name or 1-based worksheet index. Example: 'Sheet1'int $sourceRows, # Input value for `$sourceRows` (int). Example: 1int $outputRows, # Input value for `$outputRows` (int). Example: 1int $errorRows, # Input value for `$errorRows` (int). Example: 1float $elapsedSeconds, # Input value for `$elapsedSeconds` (float). Example: 1.0bool $completed = false # Input value for `$completed` (bool). Example: false): mixed# Purpose: Performs the json serialize operation.public function jsonSerialize(): array}# Provides the row state class API for state operations.# Declaration: final class RowState implements \JsonSerializable# Package: mnb/mnb-phpexcel-core# Methods: 2Mnb\PHPExcel\Reader\State\RowState{# Purpose: Creates a new RowState instance.public function __construct(int $sourceRow, # Input value for `$sourceRow` (int). Example: 1int $outputRow, # Input value for `$outputRow` (int). Example: 1int|string $sheet, # Worksheet name or 1-based worksheet index. Example: 'Sheet1'array $values, # Values supplied to the operation. Example: []array $errors = [], # Input value for `$errors` (array). Example: []bool $skipped = false # Input value for `$skipped` (bool). Example: false): mixed# Purpose: Performs the json serialize operation.public function jsonSerialize(): array}# Native XLS capability contract retained as a format-specific marker.# Declaration: interface XlsReaderInterface extends IterableReaderInterface, FormatAwareReaderInterface, SheetNamesReaderInterface# Package: mnb/mnb-phpexcel-core# Methods: 0Mnb\PHPExcel\Reader\XlsReaderInterface{# This interface declares no public methods.}# Lightweight, instance-based entry point for modular installations.# Declaration: final class SpreadsheetManager# Package: mnb/mnb-phpexcel-core# Methods: 6Mnb\PHPExcel\SpreadsheetManager{# Purpose: Creates a new SpreadsheetManager instance.public function __construct(ReaderRegistry $readers # Input value for `$readers` (ReaderRegistry).): mixed# Purpose: Performs the create operation.public static function create(?ReaderRegistry $readers = null # Input value for `$readers` (?ReaderRegistry).): self# Purpose: Performs the formats operation.public function formats(): array# Purpose: Creates a read session for the supplied source.public function read(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'array|ReaderOptions $options = [] # Configuration options for this operation. Example: []): ReadSession# Purpose: Performs the register reader operation.public function registerReader(string $format, # Spreadsheet or data format identifier. Example: 'xlsx'callable|\Mnb\PHPExcel\Reader\ReaderInterface $reader # Reader implementation used by the session. Example: static fn ($value) => $value): self# Purpose: Performs the register reader plugin operation.public function registerReaderPlugin(ReaderPluginInterface $plugin, # Input value for `$plugin` (ReaderPluginInterface).int $priority = 0 # Input value for `$priority` (int). Example: 0): self}# Provides the arr class API for support operations.# Declaration: final class Arr# Package: mnb/mnb-phpexcel-core# Methods: 2Mnb\PHPExcel\Support\Arr{# Purpose: Checks whether assoc.public static function isAssoc(array $row # Row value or 1-based row number. Example: []): bool# Purpose: Performs the string keys operation.public static function stringKeys(array $row # Row value or 1-based row number. Example: []): array}# Provides the atomic file writer class API for support operations.# Declaration: final class AtomicFileWriter# Package: mnb/mnb-phpexcel-core# Methods: 3Mnb\PHPExcel\Support\AtomicFileWriter{# Purpose: Performs the ensure directory for operation.public static function ensureDirectoryFor(string $path # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'): string# Purpose: Writes string.public static function writeString(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'string $contents, # Input value for `$contents` (string). Example: 'value'string $errorCode = ErrorCode::FILE_WRITE_FAILED # Input value for `$errorCode` (string). Example: ErrorCode::FILE_WRITE_FAILED): void# Purpose: Writes via temp.public static function writeViaTemp(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'callable $writer, # Writer implementation used by the operation. Example: static fn ($value) => $value?callable $validator = null # Input value for `$validator` (?callable). Example: static fn ($value) => $value): void}# Provides the coordinate class API for support operations.# Declaration: final class Coordinate# Package: mnb/mnb-phpexcel-core# Methods: 3Mnb\PHPExcel\Support\Coordinate{# Purpose: Performs the column index to name operation.public static function columnIndexToName(int $index # Zero-based or 1-based index as documented by the method. Example: 1): string# Purpose: Performs the column name to index operation.public static function columnNameToIndex(string $name # Name used to identify the target value. Example: 'value'): int# Purpose: Performs the split cell ref operation.public static function splitCellRef(string $cellRef # Input value for `$cellRef` (string). Example: 'value'): array}# Raised when a caller explicitly requires at least one normalized data row.# Declaration: final class EmptyWorksheetException extends MnbExcelException# Package: mnb/mnb-phpexcel-core# Methods: 1Mnb\PHPExcel\Support\EmptyWorksheetException{# Purpose: Performs the for sheet operation.public static function forSheet(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'int|string $sheet, # Worksheet name or 1-based worksheet index. Example: 'Sheet1'array $options = [], # Configuration options for this operation. Example: []?string $customMessage = null # Input value for `$customMessage` (?string). Example: 'value'): self}# Provides the environment diagnostics class API for support operations.# Declaration: final class EnvironmentDiagnostics# Package: mnb/mnb-phpexcel-core# Methods: 3Mnb\PHPExcel\Support\EnvironmentDiagnostics{# Purpose: Return a compact alert payload that applications can show before running XLSX/SQL workflows.public static function alert(array $options = [] # Configuration options for this operation. Example: []): array# Purpose: Performs the alert message operation.public static function alertMessage(array $options = [] # Configuration options for this operation. Example: []): string# Purpose: Return a developer-friendly capability report for the current PHP runtime.public static function check(array $options = [] # Configuration options for this operation. Example: []): array}# Provides the error code class API for support operations.# Declaration: final class ErrorCode# Package: mnb/mnb-phpexcel-core# Methods: 2Mnb\PHPExcel\Support\ErrorCode{# Purpose: Performs the category for operation.public static function categoryFor(string $code # Input value for `$code` (string). Example: 'value'): string# Purpose: Performs the safe message for operation.public static function safeMessageFor(string $code # Input value for `$code` (string). Example: 'value'): string}# Provides the error reporter class API for support operations.# Declaration: final class ErrorReporter# Package: mnb/mnb-phpexcel-core# Methods: 2Mnb\PHPExcel\Support\ErrorReporter{# Purpose: Performs the report operation.public static function report(Throwable $throwable, # Input value for `$throwable` (Throwable).bool $debug = false # Input value for `$debug` (bool). Example: false): array# Purpose: Performs the safe operation.public static function safe(Throwable $throwable # Input value for `$throwable` (Throwable).): array}# Provides the file format detector class API for support operations.# Declaration: final class FileFormatDetector# Package: mnb/mnb-phpexcel-core# Methods: 1Mnb\PHPExcel\Support\FileFormatDetector{# Purpose: Detect a supported reader format from an explicit option, extension, and file signature.public static function detect(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'array $options = [] # Configuration options for this operation. Example: []): string}# Small locale helper for CSV/array imports where decimal and date formats differ.# Declaration: final class LocaleNormalizer# Package: mnb/mnb-phpexcel-core# Methods: 5Mnb\PHPExcel\Support\LocaleNormalizer{# Purpose: Performs the options operation.public static function options(array $options = [] # Configuration options for this operation. Example: []): array# Purpose: Parse an already-normalized numeric string without silently overflowing PHP integers.public static function parseCanonicalNumber(string $value, # Value supplied to the operation. Example: 'value'array $options = [], # Configuration options for this operation. Example: []bool $integerOnly = false, # Input value for `$integerOnly` (bool). Example: false$originalValue = null, # Value returned when invalid_cast=preserve.bool $preserveLeadingZeros = false # Input value for `$preserveLeadingZeros` (bool). Example: false): mixed# Purpose: Parses date.public static function parseDate($value, # Value supplied to the operation.string $outputFormat = 'Y-m-d', # Input value for `$outputFormat` (string). Example: 'Y-m-d'array $options = [] # Configuration options for this operation. Example: []): mixed# Purpose: Parses localized integer.public static function parseLocalizedInteger($value, # Value supplied to the operation.array $options = [] # Configuration options for this operation. Example: []): mixed# Purpose: Parses localized number.public static function parseLocalizedNumber($value, # Value supplied to the operation.array $options = [] # Configuration options for this operation. Example: []): mixed}# Optional global exception renderer for applications that want clean MNB PHPExcel errors without PHP's uncaught-exception stack trace.# Declaration: final class MnbExcelErrorHandler# Package: mnb/mnb-phpexcel-core# Methods: 6Mnb\PHPExcel\Support\MnbExcelErrorHandler{# Purpose: Performs the handle operation.public static function handle(Throwable $throwable # Input value for `$throwable` (Throwable).): void# Purpose: Checks whether registered.public static function isRegistered(): bool# Purpose: Register a clean global exception handler.public static function register(array $options = [] # Configuration options for this operation. Example: []): void# Purpose: Register the handler with actionable developer messages enabled.public static function registerDeveloperMode(string $format = 'auto', # Spreadsheet or data format identifier. Example: 'auto'?callable $renderer = null # Input value for `$renderer` (?callable). Example: static fn ($value) => $value): void# Purpose: Render an exception without registering or terminating the process.public static function render(Throwable $throwable, # Input value for `$throwable` (Throwable).bool $debug = false, # Input value for `$debug` (bool). Example: falsestring $format = 'auto' # Spreadsheet or data format identifier. Example: 'auto'): string# Purpose: Restore the exception handler that was active before registration.public static function unregister(): void}# Provides the mnb excel exception class API for support operations.# Declaration: class MnbExcelException extends RuntimeException# Package: mnb/mnb-phpexcel-core# Methods: 8Mnb\PHPExcel\Support\MnbExcelException{# Purpose: Backward-compatible constructor.public function __construct(string $message = '', # Input value for `$message` (string). Example: ''string|int $codeOrErrorCode = ErrorCode::RUNTIME_ERROR, # Input value for `$codeOrErrorCode` (string|int). Example: ErrorCode::RUNTIME_ERRORstring|Throwable|null $categoryOrPrevious = null, # Input value for `$categoryOrPrevious` (string|Throwable|null). Example: 'value'array $context = [], # Input value for `$context` (array). Example: []?Throwable $previous = null, # Input value for `$previous` (?Throwable).?string $safeMessage = null # Input value for `$safeMessage` (?string). Example: 'value'): mixed# Purpose: Performs the category operation.public function category(): string# Purpose: Performs the context operation.public function context(): array# Purpose: Performs the error code operation.public function errorCode(): string# Purpose: Returns error code.public function getErrorCode(): string# Purpose: Performs the safe message operation.public function safeMessage(): string# Purpose: Converts the value to error array.public function toErrorArray(bool $debug = false # Input value for `$debug` (bool). Example: false): array# Purpose: Returns a copy configured with code.public static function withCode(string $message, # Input value for `$message` (string). Example: 'value'string $errorCode, # Input value for `$errorCode` (string). Example: 'value'array $context = [], # Input value for `$context` (array). Example: []?Throwable $previous = null, # Input value for `$previous` (?Throwable).?string $safeMessage = null, # Input value for `$safeMessage` (?string). Example: 'value'?string $category = null # Input value for `$category` (?string). Example: 'value'): self}# Produces valid, unique Excel worksheet names.# Declaration: final class SheetNameAllocator# Package: mnb/mnb-phpexcel-core# Methods: 2Mnb\PHPExcel\Support\SheetNameAllocator{# Purpose: Performs the allocate operation.public function allocate(string $name # Name used to identify the target value. Example: 'value'): string# Purpose: Performs the sanitize operation.public static function sanitize(string $name # Name used to identify the target value. Example: 'value'): string}# Developer-facing worksheet selection error with actionable context.# Declaration: final class SheetSelectionException extends MnbExcelException# Package: mnb/mnb-phpexcel-core# Methods: 5Mnb\PHPExcel\Support\SheetSelectionException{# Purpose: Performs the ambiguous name operation.public static function ambiguousName(string $requested, # Input value for `$requested` (string). Example: 'value'string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'array $availableSheets = [] # Input value for `$availableSheets` (array). Example: []): self# Purpose: Performs the empty name operation.public static function emptyName(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'array $availableSheets = [] # Input value for `$availableSheets` (array). Example: []): self# Purpose: Performs the invalid index operation.public static function invalidIndex(int $requested, # Input value for `$requested` (int). Example: 1string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'array $availableSheets = [] # Input value for `$availableSheets` (array). Example: []): self# Purpose: Performs the missing operation.public static function missing(string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'array $availableSheets = [] # Input value for `$availableSheets` (array). Example: []): self# Purpose: Performs the not found operation.public static function notFound(int|string $requested, # Input value for `$requested` (int|string). Example: 1string $path, # Path to the source or destination file. Example: __DIR__ . '/workbook.xlsx'array $availableSheets = [] # Input value for `$availableSheets` (array). Example: []): self}# Provides the value sanitizer class API for support operations.# Declaration: final class ValueSanitizer# Package: mnb/mnb-phpexcel-core# Methods: 10Mnb\PHPExcel\Support\ValueSanitizer{# Purpose: Performs the contains invalid xml characters operation.public static function containsInvalidXmlCharacters(string $value # Value supplied to the operation. Example: 'value'): bool# Purpose: Performs the escape formula like text operation.public static function escapeFormulaLikeText($value # Value supplied to the operation.): mixed# Purpose: Checks whether formula like text.public static function isFormulaLikeText(string $value # Value supplied to the operation. Example: 'value'): bool# Purpose: Checks whether large integer string.public static function isLargeIntegerString(string $value, # Value supplied to the operation. Example: 'value'int $maxDigits = 15 # Input value for `$maxDigits` (int). Example: 15): bool# Purpose: Normalizes scalar.public static function normalizeScalar($value # Value supplied to the operation.): string|int|float|bool|null|CellValue# Purpose: Performs the sanitize cell text operation.public static function sanitizeCellText(string $value, # Value supplied to the operation. Example: 'value'array $options = [] # Configuration options for this operation. Example: []): string# Purpose: Performs the sanitize formula like text operation.public static function sanitizeFormulaLikeText($value, # Value supplied to the operation.string $policy = 'escape' # Input value for `$policy` (string). Example: 'escape'): mixed# Purpose: Performs the strip invalid xml characters operation.public static function stripInvalidXmlCharacters(string $value # Value supplied to the operation. Example: 'value'): string# Purpose: Performs the substring operation.public static function substring(string $value, # Value supplied to the operation. Example: 'value'int $start, # Input value for `$start` (int). Example: 1int $length # Maximum length or number of items. Example: 1): string# Purpose: Performs the text length operation.public static function textLength(string $value # Value supplied to the operation. Example: 'value'): int}# XMLReader-compatible adapter with a native streaming path and pure-PHP fallback.# Declaration: final class XmlReader# Package: mnb/mnb-phpexcel-core# Methods: 11Mnb\PHPExcel\Support\Xml\XmlReader{# Purpose: Creates a new XmlReader instance.public function __construct(): mixed# Purpose: Closes the active resource and releases related state.public function close(): bool# Purpose: Returns attribute.public function getAttribute(string $name # Name used to identify the target value. Example: 'value'): ?string# Purpose: Performs the move to element operation.public function moveToElement(): bool# Purpose: Performs the move to first attribute operation.public function moveToFirstAttribute(): bool# Purpose: Performs the move to next attribute operation.public function moveToNextAttribute(): bool# Purpose: Performs the native available operation.public static function nativeAvailable(): bool# Purpose: Performs the open operation.public function open(string $uri, # URI used by the operation. Example: 'https://example.com/resource'?string $encoding = null, # Text character encoding. Example: 'UTF-8'int $flags = 0 # Input value for `$flags` (int). Example: 0): bool# Purpose: Creates a read session for the supplied source.public function read(): bool# Purpose: Reads outer xml.public function readOuterXml(): string# Purpose: Performs the xml operation.public function XML(string $source, # Source input used by the operation. Example: 'value'?string $encoding = null, # Text character encoding. Example: 'UTF-8'int $flags = 0 # Input value for `$flags` (int). Example: 0): bool}# ZipArchive-compatible adapter. It delegates to ext-zip when available and falls back to a pure-PHP ZIP reader/writer for stored and deflated entries.# Declaration: final class ZipArchive# Package: mnb/mnb-phpexcel-core# Methods: 11Mnb\PHPExcel\Support\Zip\ZipArchive{# Purpose: Adds file.public function addFile(string $filepath, # Path to the workbook or data file. Example: __DIR__ . '/workbook.xlsx'string $entryname = '' # Input value for `$entryname` (string). Example: ''): bool# Purpose: Adds from string.public function addFromString(string $name, # Name used to identify the target value. Example: 'value'string $content # Input value for `$content` (string). Example: 'value'): bool# Purpose: Closes the active resource and releases related state.public function close(): bool# Purpose: Returns from name.public function getFromName(string $name # Name used to identify the target value. Example: 'value'): string|false# Purpose: Returns name index.public function getNameIndex(int $index, # Zero-based or 1-based index as documented by the method. Example: 1int $flags = 0 # Input value for `$flags` (int). Example: 0): string|false# Purpose: Returns stream.public function getStream(string $name # Name used to identify the target value. Example: 'value'): resource|false# Purpose: Performs the locate name operation.public function locateName(string $name, # Name used to identify the target value. Example: 'value'int $flags = 0 # Input value for `$flags` (int). Example: 0): int|false# Purpose: Performs the native available operation.public static function nativeAvailable(): bool# Purpose: Performs the open operation.public function open(string $filename, # File name used by the operation. Example: 'workbook.xlsx'int $flags = 0 # Input value for `$flags` (int). Example: 0): bool|int# Purpose: Performs the stat index operation.public function statIndex(int $index, # Zero-based or 1-based index as documented by the method. Example: 1int $flags = 0 # Input value for `$flags` (int). Example: 0): array|false# Purpose: Performs the stat name operation.public function statName(string $name, # Name used to identify the target value. Example: 'value'int $flags = 0 # Input value for `$flags` (int). Example: 0): array|false}# Provides the array validator class API for validation operations.# Declaration: final class ArrayValidator# Package: mnb/mnb-phpexcel-core# Methods: 1Mnb\PHPExcel\Validation\ArrayValidator{# Purpose: Validates the supplied input and returns the validation result.public function validate(array $rows, # Rows supplied for reading, writing, validation, or import. Example: []array $rules, # Input value for `$rules` (array). Example: []array $options = [] # Configuration options for this operation. Example: []): array}# Provides the custom validator registry class API for validation operations.# Declaration: final class CustomValidatorRegistry# Package: mnb/mnb-phpexcel-core# Methods: 6Mnb\PHPExcel\Validation\CustomValidatorRegistry{# Purpose: Performs the check operation.public static function check(string $column, # Column name, letter, or index. Example: 'A'$value, # Value supplied to the operation.string $rule, # Input value for `$rule` (string). Example: 'value'array $row, # Row value or 1-based row number. Example: []array $rows, # Rows supplied for reading, writing, validation, or import. Example: []?int $rowNumber # Input value for `$rowNumber` (?int).): ?string# Purpose: Performs the clear operation.public static function clear(): void# Purpose: Performs the has operation.public static function has(string $rule # Input value for `$rule` (string). Example: 'value'): bool# Purpose: Performs the names operation.public static function names(): array# Purpose: Performs the parse operation.public static function parse(string $rule # Input value for `$rule` (string). Example: 'value'): array# Purpose: Performs the register operation.public static function register(string $name, # Name used to identify the target value. Example: 'value'callable $callback # Callback invoked during this operation. Example: static fn ($value) => $value): void}No matching API found.Try a class name, method, parameter, or return type.
Was this guide useful?Use GitHub issues for corrections, missing examples, or unclear behavior.
Open an issue