https://github.com/akrabat/akrabatzf

Akrabat_Db_Schema_Manager and a DatabaseSchemaProvider for Zend_Tool
https://github.com/akrabat/akrabatzf

Last synced: about 12 hours ago
JSON representation

Akrabat_Db_Schema_Manager and a DatabaseSchemaProvider for Zend_Tool

• Host: GitHub
• URL: https://github.com/akrabat/akrabatzf
• Owner: akrabat
• License: other
• Created: 2010-03-27T19:55:51.000Z (almost 15 years ago)
• Default Branch: master
• Last Pushed: 2014-03-06T21:01:24.000Z (almost 11 years ago)
• Last Synced: 2025-01-01T23:08:20.928Z (8 days ago)
• Language: PHP
• Homepage: http://akrabat.com
• Size: 215 KB
• Stars: 95
• Watchers: 10
• Forks: 23
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Akrabat ZF library

See [Akrabat_Db_Schema_Manager: Zend Framework database migrations](http://akrabat.com/zend-framework/akrabat_db_schema_manager-zend-framework-database-migrations/) for full details. This code is licensed under the [New-BSD license](http://akrabat.com/license/new_bsd/).

Akrabat_Db_Schema_Manager is a tool for use with ZF1. If you need a standalone tool, then have a look at [South for the Winter](https://github.com/startupdevs/sftw).

## ZF1:

To get the Zend_Tool provider working:

1. Place a copy of ZF1 in `/usr/local/include/zf1/`, so that the Zend folder is in `zf1/library/Zend`

2. Update your `~/.bash_profile` to set up an alias to the zf.sh script

        alias zf='export ZF_CONFIG_FILE=~/.zf.ini; /usr/local/include/zf1/bin/zf.sh'

    

   Restart your terminal or `source ~/.bash_profile`

3. If you haven't already done so, setup the storage directory and config file:

    

        zf --setup storage-directory

        zf --setup config-file

        

4. Place a copy of the Akrabat Tools in `/usr/local/include/Akrabat`:

        

        cd /usr/local/include

        git clone http://github.com/akrabat/Akrabat.git

        

5. Edit the created `~/.zf.ini`. Change path so that it includes ZF1 and Akrabat/library, allow for auotoloading Akrabat and set up the provider:

    

        php.include_path = "/usr/local/include/zf1/library:/usr/local/include/Akrabat/library/"

        autoloadernamespaces.0 = "Akrabat_"

        basicloader.classes.0 = "Akrabat_Tool_DatabaseSchemaProvider"

6. `zf` should provide a help screen with the `DatabaseSchema` provider at the bottom.

### Akrabat_Db_Schema_Manager

1. Create scripts/migrations folder in your ZF application

2. Create migration files within migrations with the file name format of nnn-Xxxx.php. e.g. 001-Users.php

    where:  

       nnn => any number. The lower numbered files are executed first  

       Xxx => any name. This is the class name within the file.

       

 	In up(), database changes are applied, in down(), changes are reverted. If changes cannot be reverted, then down() should throw a Akrabat_Db_Schema_Exception.

   

3. Create a class in your migrations file. Example for 001-Users.php:

    

        class Users extends Akrabat_Db_Schema_AbstractChange 

        {

            function up()

            {

                $tableName = $this->_tablePrefix . 'users';

                $sql = "

                    CREATE TABLE IF NOT EXISTS $tableName (

                      id int(11) NOT NULL AUTO_INCREMENT,

                      username varchar(50) NOT NULL,

                      password varchar(75) NOT NULL,

                      roles varchar(200) NOT NULL DEFAULT 'user',

                      PRIMARY KEY (id)

                    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;";

                $this->_db->query($sql);

        

                $data = array();

                $data['username'] = 'admin';

                $data['password'] = sha1('password');

                $data['roles'] = 'user,admin';

                $this->_db->insert($tableName, $data);

            }

            

            function down()

            {

                $tableName = $this->_tablePrefix . 'users';

                $sql= "DROP TABLE IF EXISTS $tableName";

                $this->_db->query($sql);

            }

        

        }

        

4. If you want a table prefix, add this to your `application.ini`:

        resources.db.table_prefix = "prefix"

        

        

## Phing Task

1. Define the phing task in the `build.xml`

        

        

2. Setup a phing target with the database options in the `build.xml`

 

        

        	

		

3. Run phing using the command line, by `phing database-migration`