PHPackages                             mahdyaslami/simple-pluginable - 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. mahdyaslami/simple-pluginable

ActiveLibrary[Utility & Helpers](/categories/utility)

mahdyaslami/simple-pluginable
=============================

Functions that make simple pluginable.

v1.2.1(5y ago)014[2 issues](https://github.com/mahdiaslami/simple-pluginable/issues)MITPHP

Since Oct 22Pushed 5y ago1 watchersCompare

[ Source](https://github.com/mahdiaslami/simple-pluginable)[ Packagist](https://packagist.org/packages/mahdyaslami/simple-pluginable)[ RSS](/packages/mahdyaslami-simple-pluginable/feed)WikiDiscussions develop Synced today

READMEChangelog (4)Dependencies (1)Versions (6)Used By (0)

simple-pluginable
=================

[](#simple-pluginable)

This package allows other packages to make these changes at minimal cost if they need to change the structure of the project folder.

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

[](#installation)

1. Add following script to your project `composer.json` file.

```
{
    ...
    "scripts": {
            "post-autoload-dump": "Simplex\\Plugins\\Composer::postAutoloadDump"
    }
}

```

This script will run after dump autoload command and start process of changing workspaces.

2. Install `simple-pluginable` package.

```
composer require simple-pluginable

```

Process
-------

[](#process)

Pluginable runs after the `dumpautoload` command and checks all packages and executes the `installer.php` file if it exists.

Installer(`installer.php`) of packages will update project workspace.

Pluginable prevents a plugins from being installed twice and after installing all the plugins, they save them in the plugins.json file in the project root directory.

How create a plugin?
--------------------

[](#how-create-a-plugin)

It's simple. you need to only create your package and we prepare some options that helps you to install your workspace.

### Installer

[](#installer)

Create `install.php` file on root of your package (don't use it on `composer.json->autoload`). and finally write your installation script.

You can use [`Simplex\Plugins\Installer::basePath`](https://github.com/mahdyaslami/simple-pluginable/blob/06448f67dca14f3bcc196b56f4c593bec3161e33/src/Installer.php#L186) for knowing where is workspace.

If you just want to copy some file you can create a folder with `workspace` name and put your structure there. and finally add following code on your installer:

```