/src/PHPFrame/Mapper/ObjectRelationalToolbox.php

<?php
/**
 * PHPFrame/Mapper/ObjectRelationalToolbox.php
 *
 * PHP version 5
 *
 * @category  PHPFrame
 * @package   Mapper
 * @author    Lupo Montero <lupo@e-noise.com>
 * @copyright 2010 The PHPFrame Group
 * @license   http://www.opensource.org/licenses/bsd-license.php New BSD License
 * @link      http://github.com/PHPFrame/PHPFrame
 */

/**
 * Object Relational Toolbox Class
 *
 * @category PHPFrame
 * @package  Mapper
 * @author   Lupo Montero <lupo@e-noise.com>
 * @license  http://www.opensource.org/licenses/bsd-license.php New BSD License
 * @link     http://github.com/PHPFrame/PHPFrame
 * @since    1.0
 */
class PHPFrame_ObjectRelationalToolbox
{
    /**
     * Create a database table to store a given persistent object
     *
     * @param PHPFrame_Database         $db         Reference to a database
     *                                              object.
     * @param PHPFrame_PersistentObject $obj        An instance of the persistent
     *                                              object we want to create the
     *                                              table for.
     * @param string                    $table_name [Optional] Table name to
     *                                              use. If none specified we
     *                                              use the object's class name.
     * @param bool                      $drop       [Optional] Default value is
     *                                              FALSE. When set to true
     *                                              existing table will be
     *                                              dropped.
     *
     * @return void
     * @throws Exception on failure
     * @since  1.0
     */
    public function createTable(
        PHPFrame_Database $db,
        PHPFrame_PersistentObject $obj,
        $table_name=null,
        $drop=false
    ) {
        if (is_null($table_name)) {
            $table_name = get_class($obj);
        }

        if ($db->hasTable($table_name) && !$drop) {
            $msg  = "Could not create table. Table '".$table_name."' already ";
            $msg .= "exists in database. Use the '\$drop' argument in ";
            $msg .= get_class($this)."::".__FUNCTION__."() to drop the table ";
            $msg .= "before trying to create it again.";
            throw new RuntimeException($msg);
        }

        if ($drop) {
            $db->dropTable($table_name);
        }

        $table = new PHPFrame_DatabaseTable($db, $table_name);

        foreach ($obj->getFilters() as $key=>$filter) {
            $column = new PHPFrame_DatabaseColumn(array(
                "name"=>$key,
                "type"=>PHPFrame_DatabaseColumn::TYPE_BLOB
            ));

            $options = $filter->getOptions();

            if ($filter instanceof PHPFrame_BoolFilter) {
                $column->setType(PHPFrame_DatabaseColumn::TYPE_BOOL);

            } elseif ($filter instanceof PHPFrame_IntFilter) {
                $range = $options["max_range"] - $options["min_range"];
                if ($range <= 255) { // 1 byte int
                    $column->setType(PHPFrame_DatabaseColumn::TYPE_TINYINT);
                } elseif ($range <= 65535) { // 2 byte int
                    $column->setType(PHPFrame_DatabaseColumn::TYPE_SMALLINT);
                } elseif ($range <= 16777215) { // 3 byte int
                    $column->setType(PHPFrame_DatabaseColumn::TYPE_MEDIUMINT);
                } elseif ($range <= 4294967295) { // 4 byte int
                    $column->setType(PHPFrame_DatabaseColumn::TYPE_INT);
                } else { // 8 byte int
                    $column->setType(PHPFrame_DatabaseColumn::TYPE_BIGINT);
                }

            } elseif ($filter instanceof PHPFrame_FloatFilter) {
                $column->setType(PHPFrame_DatabaseColumn::TYPE_FLOAT);

            } elseif ($filter instanceof PHPFrame_EnumFilter) {
                $column->setType(PHPFrame_DatabaseColumn::TYPE_ENUM);
                $column->setEnums($filter->getOption("enums"));

            } elseif ($filter instanceof PHPFrame_DateFilter) {
                $format = $options["format"];
                if ($format == PHPFrame_DateFilter::FORMAT_DATE) {
                    $column->setType(PHPFrame_DatabaseColumn::TYPE_DATE);
                } elseif ($format == PHPFrame_DateFilter::FORMAT_DATETIME) {
                    $column->setType(PHPFrame_DatabaseColumn::TYPE_DATETIME);
                } elseif ($format == PHPFrame_DateFilter::FORMAT_TIME) {
                    $column->setType(PHPFrame_DatabaseColumn::TYPE_TIME);
                }

            } elseif ($filter instanceof PHPFrame_URLFilter) {
                $column->setType(PHPFrame_DatabaseColumn::TYPE_VARCHAR);

            } elseif ($filter instanceof PHPFrame_StringFilter) {
                if ($options["max_length"] > 0) {
                    $column->setType(PHPFrame_DatabaseColumn::TYPE_VARCHAR);
                    $column->setLength($options["max_length"]);
                } else {
                    $column->setType(PHPFrame_DatabaseColumn::TYPE_TEXT);
                }
            }

            $column->setNull($obj->allowsNull($key));

            $def_values = iterator_to_array($obj);
            if (!is_null($def_values[$key])) {
                $column->setDefault($def_values[$key]);
            }

            if ($key == "id") {
                $column->setKey(PHPFrame_DatabaseColumn::KEY_PRIMARY);
                $column->setExtra(PHPFrame_DatabaseColumn::EXTRA_AUTOINCREMENT);
            }

            $table->addColumn($column);
        }

        $db->createTable($table);
    }

    /**
     * Create the php code to represent a given database table as a persistent
     * object.
     *
     * @param PHPFrame_Database $db         A reference to a database object.
     * @param string            $table_name The name of the table we want to
     *                                      create the persistent object class
     *                                      for.
     *
     * @return string
     * @throws Exception on failure
     * @since  1.0
     * @todo   This method needs to be implemented.
     */
    public function createPersistentObjectClass(
        PHPFrame_Database $db,
        $table_name
    ) {
        //...
    }

    /**
     * Check whether a database table is valid to store a given persistent
     * object.
     *
     * @param PHPFrame_Database         $db         A reference to a database
     *                                              object.
     * @param string                    $table_name The table name.
     * @param PHPFrame_PersistentObject $obj        Reference to a persistent
     *                                              of the type we want to check.
     *
     * @return bool
     * @since  1.0
     * @todo   This method needs to be implemented.
     */
    public function isValid(
        PHPFrame_Database $db,
        $table_name,
        PHPFrame_PersistentObject $obj
    ) {
        //...
    }
}