PHPackages                             fanatik3/cakephp-excel - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. fanatik3/cakephp-excel

ActiveCakephp-plugin[Utility & Helpers](/categories/utility)

fanatik3/cakephp-excel
======================

Excel plugin for CakePHP 3

033PHP

Since Dec 26Pushed 5y ago1 watchersCompare

[ Source](https://github.com/fanatik3/excel-cakephp)[ Packagist](https://packagist.org/packages/fanatik3/cakephp-excel)[ RSS](/packages/fanatik3-cakephp-excel/feed)WikiDiscussions main Synced 2d ago

READMEChangelogDependenciesVersions (1)Used By (0)

Fanatik3/Excel plugin for CakePHP
=================================

[](#fanatik3excel-plugin-for-cakephp)

The plugin is based on the work of \[dakota\] () and uses [PHPExcel](https://github.com/PHPOffice/PHPExcel) for the excel-related functionality.

Installation
------------

[](#installation)

You can install this plugin into your CakePHP application using [composer](http://getcomposer.org).

The recommended way to install composer packages is:

add

```
"repositories": [
         {
            "type": "vcs",
            "url": "https://github.com/Fanatik3/excel"
        }
    ]

```

to your composer.json because this package is not on packagist. Then in your console:

```
composer require Fanatik3/Excel:dev-master

```

should fetch the plugin.

Load the Plugin in your bootstrap.php as ususal:

```
	Plugin::load('Fanatik3/Excel', ['bootstrap' => true, 'routes'=>true]);

```

RequestHandler Component is configured by the Plugin's bootstrap file. If not you could do this this in your controller's initialize method, e.g.:

```
	public function initialize()
		{
        		parent::initialize();
        		$this->loadComponent('RequestHandler', [
            			'viewClassMap' => ['xlsx' => 'Fanatik3/Excel.Excel']
        ]);
        	}

```

Be careful: RequestHandlerComponent is already loaded in your AppController by default. Adapt the settings to your needs.

You need to set up parsing for the xlsx extension. Add the following to your config/routes.php file before any route or scope definition:

```
Router::extensions('xlsx');

```

or you can add within a scope:

```
$routes->setExtensions(['xlsx']);

```

(Setting this in the plugin's config/routes.php file is currently broken. So you do have to provide the code in the application's config/routes.php file)

You further have to provide a layout for the generated Excel-Files. Add a folder xlsx in src/Template/Layout/ subdirectory and within that folder a file named default.ctp with this minimum content:

```

```

You can create Excel Workbooks from views. This works like in [dakotas](https://github.com/dakota/CakeExcel) plugin. Look there for docs. Additions:

1. ExcelHelper
--------------

[](#1-excelhelper)

Has a Method 'addworksheet' which takes a ResultSet, a Entity, a Collection of Entities or an Array of Data and creates a worksheet from the data. Properties of the Entities, or the keys of the first record in the array are set as column-headers in first row of the generated worksheet. Be careful if you use non-standard column-types. The Helper actually works only with strings, numbers and dates.

Register xlsx-Extension in config/routes.php file before the routes that should be affected:

```
    Router::extensions(['xlsx']);

```

Example (assumed you have an article model and controller with the usual index-action)

Include the helper in ArticlesController:

```
   public $helpers = ['Fanatik3/Excel.Excel'];

```

add a Folder 'xlsx' in Template/Articles and create the file 'index.ctp' in this Folder. Include this snippet of code to get an excel-file with a single worksheet called 'Articles':

```
    $this->Excel->addWorksheet($articles, 'Articles');

```

create the link to generate the file somewhere in your app:

```

```

done.

2. ImportComponent
------------------

[](#2-importcomponent)

Takes a excel workbook, extracts a single worksheet with data (e.g. generated with the helper) and generates an array with data ready for building entities. First row must contain names of properties/database columns.

Include the Import-Component in the controller:

```
 public function initialize()
 {
    parent::initialize();
    $this->loadComponent('Fanatik3/Excel.Import');
 }

```

than you can use the method

```
 prepareEntityData($file = null, array $options = [])

```

E.g. if you've uploaded a file:

```
 move_uploaded_file($this->gerRequest()->getData('file.tmp_name'), TMP . DS . $this->getRequest()->getData('file.name'));
 $data = $this->Import->prepareEntityData(TMP . $this->getRequest()->getData('file.name'));

```

and you'll get an array with data like you would get from the form-helper. You then can generate and save entities in the Controller:

```
 $entities = $table->newEntities($data);
 foreach ($entities as $entity) {
       $table->save($entity, ['checkExisting' => false])
 }

```

if your table is not empty and you don't want to replace records in the database, set `'append'=>true` in the $options array:

```
$data = $this->Import->prepareEntityData($file, ['append'=> true]);

```

If there are more than one worksheets in the file you can supply the name or index of the Worksheet to use in the $options array, e.g.:

```
$data = $this->Import->prepareEntityData($file, ['worksheet'=> 0]);

```

or

```
$data = $this->Import->prepareEntityData($file, ['worksheet'=> 'Articles']);

```

###  Health Score

17

—

LowBetter than 6% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity7

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity31

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/e8af849535af6a0f4cb491c20cfea2168631c645ab68f7068fbd7c2e4e8c0a81?d=identicon)[fanatik3](/maintainers/fanatik3)

---

Top Contributors

[![pierrebnjl](https://avatars.githubusercontent.com/u/31212283?v=4)](https://github.com/pierrebnjl "pierrebnjl (6 commits)")

### Embed Badge

![Health badge](/badges/fanatik3-cakephp-excel/health.svg)

```
[![Health](https://phpackages.com/badges/fanatik3-cakephp-excel/health.svg)](https://phpackages.com/packages/fanatik3-cakephp-excel)
```

###  Alternatives

[php-smpp/php-smpp

PHP-based SMPP client lib

234197.5k8](/packages/php-smpp-php-smpp)[demogorgorn/yii2-ajax-submit-button

AjaxSubmitButton renders an ajax button which is very similar to ajaxSubmitButton from Yii1.

29132.8k1](/packages/demogorgorn-yii2-ajax-submit-button)[tanmuhittin/nova-scroll-top

On route change scrolls to the top

22216.2k](/packages/tanmuhittin-nova-scroll-top)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)