Builder.php 5.06 KB
Newer Older
lsmith's avatar
lsmith committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
<?php
/*
 *  $Id$
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information, see
 * <http://www.phpdoctrine.com>.
 */

/**
 * Doctrine_Import_Builder
 * Import builder is responsible of building Doctrine ActiveRecord classes
 * based on a database schema.
 *
 * @package     Doctrine
 * @category    Object Relational Mapping
 * @link        www.phpdoctrine.com
 * @license     http://www.opensource.org/licenses/lgpl-license.php LGPL
 * @since       1.0
 * @version     $Revision$
 * @author      Konsta Vesterinen <kvesteri@cc.hut.fi>
 * @author      Jukka Hassinen <Jukka.Hassinen@BrainAlliance.com>
 */
lsmith's avatar
lsmith committed
36 37
class Doctrine_Import_Builder
{
lsmith's avatar
lsmith committed
38 39 40 41 42 43 44

    private $path = '';

    private $suffix = '.php';

    private static $tpl;

lsmith's avatar
lsmith committed
45 46
    public function __construct()
    {
lsmith's avatar
lsmith committed
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
        if ( ! isset(self::$tpl)) {
            self::$tpl = file_get_contents(Doctrine::getPath()
                       . DIRECTORY_SEPARATOR . 'Doctrine'
                       . DIRECTORY_SEPARATOR . 'Import'
                       . DIRECTORY_SEPARATOR . 'Builder'
                       . DIRECTORY_SEPARATOR . 'Record.tpl');
        }
    }

    /**
     *
     * @param string path
     * @return
     * @access public
     */
lsmith's avatar
lsmith committed
62 63
    public function setTargetPath($path)
    {
lsmith's avatar
lsmith committed
64 65 66 67 68 69
        if ( ! file_exists($path)) {
            mkdir($path, 0777);
        }

        $this->path = $path;
    }
lsmith's avatar
lsmith committed
70 71
    public function getTargetPath()
    {
lsmith's avatar
lsmith committed
72 73 74 75 76 77 78 79
        return $this->path;
    }
    /**
     *
     * @param string path
     * @return
     * @access public
     */
lsmith's avatar
lsmith committed
80 81
    public function setFileSuffix($suffix)
    {
lsmith's avatar
lsmith committed
82 83
        $this->suffix = $suffix;
    }
lsmith's avatar
lsmith committed
84 85
    public function getFileSuffix()
    {
lsmith's avatar
lsmith committed
86 87 88
        return $this->suffix;
    }

lsmith's avatar
lsmith committed
89 90
    public function buildRecord(Doctrine_Schema_Table $table)
    {
lsmith's avatar
lsmith committed
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
        if (empty($this->path)) {
            throw new Doctrine_Import_Builder_Exception('No build target directory set.');
        }
        if (is_writable($this->path) === false) {
            throw new Doctrine_Import_Builder_Exception('Build target directory ' . $this->path . ' is not writable.');
        }
        $created   = date('l dS \of F Y h:i:s A');
        $className = Doctrine::classify($table->get('name'));
        $fileName  = $this->path . DIRECTORY_SEPARATOR . $className . $this->suffix;
        $columns   = array();

        $i = 0;

        foreach ($table as $name => $column) {
            $columns[$i] = '        $this->hasColumn(\'' . $column['name'] . '\', \'' . $column['type'] . '\'';
            if ($column['length']) {
                $columns[$i] .= ', ' . $column['length'];
            } else {
                $columns[$i] .= ', null';
            }

            $a = array();

            if ($column['default']) {
                $a[] = '\'default\' => ' . var_export($column['default'], true);
            }
            if ($column['notnull']) {
                $a[] = '\'notnull\' => true';
            }
            if ($column['primary']) {
                $a[] = '\'primary\' => true';
            }
            if ($column['autoinc']) {
                $a[] = '\'autoincrement\' => true';
            }
            if ($column['unique']) {
                $a[] = '\'unique\' => true';
            }

            if ( ! empty($a)) {
                $columns[$i] .= ', ' . 'array(' . implode(',
', $a) . ')';
            }
            $columns[$i] .= ');';

            if ($i < (count($table) - 1)) {
                $columns[$i] .= '
';
            }
            $i++;
        }

        $content   = sprintf(self::$tpl, $created, $className, implode('', $columns));

        $bytes     = file_put_contents($fileName, $content);

        if ($bytes === false)
            throw new Doctrine_Import_Builder_Exception("Couldn't write file " . $fileName);
    }
    /**
     *
     * @param Doctrine_Schema_Object $schema
     * @throws Doctrine_Import_Exception
     * @return void
     */
lsmith's avatar
lsmith committed
156 157
    public function build(Doctrine_Schema_Object $schema)
    {
lsmith's avatar
lsmith committed
158 159 160 161 162 163 164 165
        foreach ($schema->getDatabases() as $database){
            foreach ($database->getTables() as $table){
                $this->buildRecord($table);
            }
        }
    }

}