PHPackages                             softius/phig - 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. [Database & ORM](/categories/database)
4. /
5. softius/phig

ActiveLibrary[Database & ORM](/categories/database)

softius/phig
============

Database migrations for PHP 5.3

19PHP

Since Jan 7Pushed 13y ago1 watchersCompare

[ Source](https://github.com/softius/phig)[ Packagist](https://packagist.org/packages/softius/phig)[ RSS](/packages/softius-phig/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

Phig
====

[](#phig)

**phig** provides a convenient way to perform database migrations in PHP. It is vendor and framework independent and can be used with any PDO driver or database abstraction framework like Doctrine.

The aims of phig are:

- to be database framework independent: is not necessary to have background on a particular framework or library to get started.
- provide solid migration mechanism, embeddable to any project

PHP 5.3+ is required.

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

[](#installation)

**phig** is available on packagist. All you need is to add the following lines in your project `composer.json`:

```
	{
    	"require": {
        	"softius/phig": "*@dev"
	    }
	}
```

and install via composer:

```
	php composer.phar install

```

An executable will be added under your project `vendor/bin` directory. If you would like to change this setup, please refer to this [guide](http://getcomposer.org/doc/articles/vendor-bins.md#can-vendor-bins-be-installed-somewhere-other-than-vendor-bin-).

Running migrations
------------------

[](#running-migrations)

**phig** provides a set of tasks which either execute pending migrations or reversed (rollback) already executed migration steps.

For instance, to execute all pending migrations run:

```
	phig migrate

```

If you would like to reach a particular migration you can specified it via arguments as specified below. If ommited, all pending migrations will be executed.

```
	phig migrate 20121230185208

```

This works for both upwards and downwards migrations. For instance, if target 20121230185208 is greater than the current version, this will trigger upwards migration (call up method on all migrations). On the contrary, if target 20121230185208 is less or equal than the current version, this will trigger downwards migration (call down method on all migrations). For further information on up and down methods, refer to **Writing a migration** section.

### Rolling back

[](#rolling-back)

To rollback the last migration step run:

```
	phig rollback

```

If you would like to undo multiple migration steps you can specify it via the `step` argument:

```
	phig rollback 5

```

The above will undo the last 5 migrations.

### Dump execution

[](#dump-execution)

If you would like to view the results of any of the commands above without actually executing them, append the option `--dump`. This will return usefull information about the actions planned to be carried out by the corresponding command. The following examples are all valid:

```
	phig migrate --dump
	phig migrate 20121230185208 --dump
	phig rollback --dump
	phig rollback 3 --dump

```

Writing a migration
-------------------

[](#writing-a-migration)

Migrations are nothing more but classes in PHP, with the following constraints that you should be aware before starting writing code:

- All migrations must be placed in a single directory.
- Any migration class must extend the `MigratableInterface` and thus the methods `up` and `down`. The `up` method is called when executing an upwards migrations while the `down` method is called on downwards migrations and rollbacks. In other words, the `up` method is called to create a change while `down` method of the same class is called to reverse that change.
- The filename of the migration is important since it is used as a reference hash for **phig** operations. While it is possible to use either datetime or a sequence (integer i.e. build number) or even a versioning scheme, I am suggesting to follow the datetime pattern.

Here is an example

```
	// yourproject/migrations/20130104152443-MigrationExample.php
	class MigrationExample implements \Phig\MigratableInterface
	{
		public method up()
		{
			create_table('users');
		}

		public method down()
		{
			destroy_table('users');
		}
	}
```

### Using PDO Drivers

[](#using-pdo-drivers)

The following example illustrates how PDO Migratable abstract class can be used. As you can see no database helpers are provided.

```
	// yourproject/migrations/20130107193139-PdoMigrationExample.php
	class PdoMigrationExample extends \Phig\Migratable\Pdo
	{
		public method up()
		{
			$this->getConnection()->exec('CREATE TABLE users … ');
		}

		public method down()
		{
			$this->getConnection()->exec('DROP TABLE users');
		}
	}
```

TODO
----

[](#todo)

- Provide abstract classes for PDO Drivers and Doctrine library
- Improve configuration / add section in documentation
- Allow class names to be defined (and hence discovered) in migration filename i.e. `20121230185208-MigrationExample` (instead of `20121230185208.php`)
- Support more than one migration folder
- Add more examples in section *Writing a migration*

###  Health Score

20

—

LowBetter than 14% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 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://avatars.githubusercontent.com/u/586121?v=4)[Iacovos Constantinou](/maintainers/softius)[@softius](https://github.com/softius)

---

Top Contributors

[![softius](https://avatars.githubusercontent.com/u/586121?v=4)](https://github.com/softius "softius (11 commits)")

### Embed Badge

![Health badge](/badges/softius-phig/health.svg)

```
[![Health](https://phpackages.com/badges/softius-phig/health.svg)](https://phpackages.com/packages/softius-phig)
```

###  Alternatives

[doctrine/orm

Object-Relational-Mapper for PHP

10.2k285.3M6.2k](/packages/doctrine-orm)[jdorn/sql-formatter

a PHP SQL highlighting library

3.9k115.1M102](/packages/jdorn-sql-formatter)[illuminate/database

The Illuminate Database package.

2.8k52.4M9.4k](/packages/illuminate-database)[ramsey/uuid-doctrine

Use ramsey/uuid as a Doctrine field type.

90440.3M211](/packages/ramsey-uuid-doctrine)[reliese/laravel

Reliese Components for Laravel Framework code generation.

1.7k3.4M16](/packages/reliese-laravel)[wildside/userstamps

Laravel Userstamps provides an Eloquent trait which automatically maintains `created\_by` and `updated\_by` columns on your model, populated by the currently authenticated user in your application.

7511.7M13](/packages/wildside-userstamps)

PHPackages © 2026

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