What you will learn
- Locate common read, write, import, security, and workflow methods quickly.
- See which object owns each method.
- Move from high-level facade methods to focused APIs when needed.
Read files
| Task | Method | Owner |
|---|
| Auto-detect format | MnbExcel::read() | Application |
| Read XLSX | MnbExcel::read() | XLSX |
| Read native XLS | Xls::read() | XLS |
| Select sheet strictly | ReadSession::sheet() | Core |
| Check sheet exists | ReadSession::hasSheet() / sheetIfExists() | Core |
| Use workbook active sheet | ReadSession::activeSheet() / sheetOrActive() | Core |
| Check for returned rows | ReadSession::hasRows() / isEmpty() / assertHasRows() | Core |
| Read rows | ReadSession::rows() | Core |
| Read chunks | ReadSession::chunks() | Core |
| Read a cell | ReadSession::cell() | Core |
| Read metadata | ReadSession::cellDetails() | Core |
| Inspect XLSX package metadata | MnbExcel::inspect() / ReadSession::inspect() | Application/XLSX |
| List worksheet names | MnbExcel::sheetNames() / ReadSession::sheetNames() | Application/Core |
| Count streamed rows | ReadSession::countRows() | Core |
| Build structured row summary | ReadSession::toStructuredSheetArray() | Core |
Write files
| Task | Method | Owner |
|---|
| Create from rows | MnbExcel::fromArray() | Application |
| Create report | MnbExcel::report() | Application |
| Create multiple sheets | MnbExcel::fromWorkbookArray() | Application |
| Save XLSX | WorkbookBuilder::save() | Application/XLSX |
| Write native XLS | Xls::write() | XLS |
| Large export | MnbExcel::largeExport() | XLSX |
Import data
| Task | Method | Owner |
|---|
| Import a ReadSession | ReadSession::importToSql() | Core + Database |
| Large XLSX SQL import | LargeExcelDatabaseImportEngine::importToSql() | Database XLSX |
| Large import through facade | MnbExcel::largeImportToSql() | Application + Database XLSX |
| Domain import | MnbExcel::importDomain() | Database/Application |
| Import products | MnbExcel::importProducts() | Database/Application |
| Preview import | MnbExcel::previewDomainImport() | Database/Application |
| Generate template | MnbExcel::domainImportTemplate() | Database/Application |
Workbook features
| Task | Method | Owner |
|---|
| Style a range | WorkbookBuilder::rangeStyle() | Application/XLSX |
| Add validation | WorkbookBuilder::dataValidation() | Application/XLSX |
| Add chart | WorkbookBuilder::addChart() | Application/XLSX |
| Add pivot | WorkbookBuilder::addPivotTable() | Application/XLSX |
| Add image | WorkbookBuilder::addImage() | Application/XLSX |
Security
| Task | Method | Owner |
|---|
| Detect encryption | Xlsx::isEncrypted() | XLSX |
| Read with password | ReaderOptions::withPassword() | Core |
| Encrypt existing XLSX | MnbExcel::encryptXlsx() | XLSX/Application |
| Encrypt builder output | WorkbookBuilder::encryptWithPassword() | Application/XLSX |
| Protect workbook | WorkbookBuilder::protectWorkbook() | Application/XLSX |
Operations
| Task | Method | Owner |
|---|
| Queue jobs | MnbExcel::queue() / pdoQueue() | Application |
| HTTP endpoint | MnbExcel::apiHttp() | Application |
| Email report | MnbExcel::emailGeneratedExcel() | Application |
| Schedule work | MnbExcel::scheduler() / pdoScheduler() | Application |
| Validate XLSX | MnbExcel::assertValidXlsx() | Application/XLSX |
| Render clean developer errors | MnbExcelErrorHandler::registerDeveloperMode() | Core |
Was this guide useful?Use GitHub issues for corrections, missing examples, or unclear behavior.
Open an issue