Skip to content
PHP 8.1+ Open source Developer documentation
Tools Packagist
Docs v2.0.6
Documentation versions v2.0.6Current v2.0.5Maintenance v2.0.4Maintenance v2.0.3Maintenance v2.0.0Initial v2 Compare versions →
MNB PHPExcelDeveloper Guide
AI

Reference

Method Map by Developer Task

Find the public method you need by outcome rather than scanning class files.

Level
All levels
Reading time
8 min
Package
mnb/mnb-phpexcel
Updated
Task-first API reference

Start with the outcome, then jump to the owning API.

This map is intentionally task-oriented. Use it to find the public entry point quickly, then open the API overview or source reference when you need exact signatures and edge-case details.

01

Read files

Open, inspect, select, and consume workbook data with the right read-session API.

TaskMethodOwner
TaskAuto-detect format
MethodMnbExcel::read()
OwnerApplication
TaskRead XLSX
MethodMnbExcel::read()
OwnerXLSX
TaskRead native XLS
MethodXls::read()
OwnerXLS
TaskSelect sheet strictly
MethodReadSession::sheet()
OwnerCore
TaskCheck sheet exists
MethodReadSession::hasSheet() / sheetIfExists()
OwnerCore
TaskUse workbook active sheet
MethodReadSession::activeSheet() / sheetOrActive()
OwnerCore
TaskCheck for returned rows
MethodReadSession::hasRows() / isEmpty() / assertHasRows()
OwnerCore
TaskRead rows
MethodReadSession::rows()
OwnerCore
TaskRead chunks
MethodReadSession::chunks()
OwnerCore
TaskRead a cell
MethodReadSession::cell()
OwnerCore
TaskRead metadata
MethodReadSession::cellDetails()
OwnerCore
TaskInspect XLSX package metadata
MethodMnbExcel::inspect() / ReadSession::inspect()
OwnerApplication/XLSX
TaskList worksheet names
MethodMnbExcel::sheetNames() / ReadSession::sheetNames()
OwnerApplication/Core
TaskCount streamed rows
MethodReadSession::countRows()
OwnerCore
TaskBuild structured row summary
MethodReadSession::toStructuredSheetArray()
OwnerCore
02

Write files

Create workbook output, reports, multi-sheet files, and large exports.

TaskMethodOwner
TaskCreate from rows
MethodMnbExcel::fromArray()
OwnerApplication
TaskCreate report
MethodMnbExcel::report()
OwnerApplication
TaskCreate multiple sheets
MethodMnbExcel::fromWorkbookArray()
OwnerApplication
TaskSave XLSX
MethodWorkbookBuilder::save()
OwnerApplication/XLSX
TaskWrite native XLS
MethodXls::write()
OwnerXLS
TaskLarge export
MethodMnbExcel::largeExport()
OwnerXLSX
03

Import data

Move spreadsheet rows into SQL or domain-specific import pipelines.

TaskMethodOwner
TaskImport a ReadSession
MethodReadSession::importToSql()
OwnerCore + Database
TaskLarge XLSX SQL import
MethodLargeExcelDatabaseImportEngine::importToSql()
OwnerDatabase XLSX
TaskLarge import through facade
MethodMnbExcel::largeImportToSql()
OwnerApplication + Database XLSX
TaskDomain import
MethodMnbExcel::importDomain()
OwnerDatabase/Application
TaskImport products
MethodMnbExcel::importProducts()
OwnerDatabase/Application
TaskPreview import
MethodMnbExcel::previewDomainImport()
OwnerDatabase/Application
TaskGenerate template
MethodMnbExcel::domainImportTemplate()
OwnerDatabase/Application
04

Workbook features

Add workbook-level presentation and spreadsheet behavior to generated XLSX files.

TaskMethodOwner
TaskStyle a range
MethodWorkbookBuilder::rangeStyle()
OwnerApplication/XLSX
TaskAdd validation
MethodWorkbookBuilder::dataValidation()
OwnerApplication/XLSX
TaskAdd chart
MethodWorkbookBuilder::addChart()
OwnerApplication/XLSX
TaskAdd pivot
MethodWorkbookBuilder::addPivotTable()
OwnerApplication/XLSX
TaskAdd image
MethodWorkbookBuilder::addImage()
OwnerApplication/XLSX
05

Security

Detect encryption, provide passwords, encrypt output, and protect workbooks.

TaskMethodOwner
TaskDetect encryption
MethodXlsx::isEncrypted()
OwnerXLSX
TaskRead with password
MethodReaderOptions::withPassword()
OwnerCore
TaskEncrypt existing XLSX
MethodMnbExcel::encryptXlsx()
OwnerXLSX/Application
TaskEncrypt builder output
MethodWorkbookBuilder::encryptWithPassword()
OwnerApplication/XLSX
TaskProtect workbook
MethodWorkbookBuilder::protectWorkbook()
OwnerApplication/XLSX
06

Operations

Connect spreadsheet work to queues, HTTP endpoints, scheduled jobs, delivery, and diagnostics.

TaskMethodOwner
TaskQueue jobs
MethodMnbExcel::queue() / pdoQueue()
OwnerApplication
TaskHTTP endpoint
MethodMnbExcel::apiHttp()
OwnerApplication
TaskEmail report
MethodMnbExcel::emailGeneratedExcel()
OwnerApplication
TaskSchedule work
MethodMnbExcel::scheduler() / pdoScheduler()
OwnerApplication
TaskValidate XLSX
MethodMnbExcel::assertValidXlsx()
OwnerApplication/XLSX
TaskRender clean developer errors
MethodMnbExcelErrorHandler::registerDeveloperMode()
OwnerCore