doctrine2/lib/Doctrine/Data/Import.php

<?php
/*
 *  $Id: Import.php 2552 2007-09-19 19:33:00Z Jonathan.Wage $
 *
 * 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_Data_Import
 *
 * @package     Doctrine
 * @package     Data
 * @author      Jonathan H. Wage <jwage@mac.com>
 * @license     http://www.opensource.org/licenses/lgpl-license.php LGPL
 * @link        www.phpdoctrine.com
 * @since       1.0
 * @version     $Revision: 2552 $
 */
class Doctrine_Data_Import extends Doctrine_Data
{
    /**
     * constructor
     *
     * @param string $directory 
     * @return void
     */
    public function __construct($directory = null)
    {
        if ($directory !== null) {
            $this->setDirectory($directory);
        }
    }

    /**
     * doImport
     *
     * @return void
     */
    public function doImport()
    {
        $directory = $this->getDirectory();
        
        $array = array();
        
        if ($directory !== null) {
            foreach ((array) $directory as $dir) {
                $e = explode('.', $dir);
                
                // If they specified a specific yml file
                if (end($e) == 'yml') {
                    $array = array_merge_recursive(Doctrine_Parser::load($dir, $this->getFormat()), $array);
                // If they specified a directory
                } else if(is_dir($dir)) {
                    $it = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($dir),
                                                            RecursiveIteratorIterator::LEAVES_ONLY);

                    foreach ($it as $file) {
                        $e = explode('.', $file->getFileName());
                        if (in_array(end($e), $this->getFormats())) {
                            $array = array_merge_recursive(Doctrine_Parser::load($file->getPathName(), $this->getFormat()), $array);
                        }
                    }   
                }
            }
        }
        
        $this->loadData($array);
    }

    /**
     * loadData
     *
     * @param string $array 
     * @return void
     */
    protected function loadData(array $array)
    {
        $specifiedModels = $this->getModels();
        
        $pendingRelations = array();
        
        $primaryKeys = array();
        
        foreach ($array as $className => $data) {
            
            if ( ! empty($specifiedModels) && !in_array($className, $specifiedModels)) {
                continue;
            }
            
            foreach ($data as $rowKey => $row) {
                $obj = new $className();
                
                foreach ($row as $key => $value) {
                    // If row key is a relation store it for later fixing once we have all primary keys
                    if ($obj->getTable()->hasRelation($key)) {
                        $relation = $obj->getTable()->getRelation($key);
                        
                        $pendingRelations[] = array('key' => $value, 'obj' => $obj, 'local' => $relation['local'], 'foreign' => $relation['foreign']);
                    // If we have a normal column
                    } else if ($obj->getTable()->hasColumn($key)) {
                        $obj->$key = $value;
                    // Otherwise lets move on
                    } else {
                        continue;
                    }
                }
                
                $identifier = is_array($obj->getTable()->getIdentifier()) ? $obj->getTable()->getIdentifier():array($obj->getTable()->getIdentifier());
                
                // We only want to save the record if it is a single primary key.
                // We can't save the composite primary key because neither of the foreign keys have been created yet
                // We will satisfy these relationships later and save the record.
                if (count($identifier) === 1) {
                    $obj->save();
                }
                
                $primaryKeys[$rowKey] = $obj->identifier();
            }
        }
        
        // Satisfy all relationships
        foreach ($pendingRelations as $rowKey => $pending) {
            $obj = $pending['obj'];
            $key = $pending['key'];
            $local = $pending['local'];
            $pks = $primaryKeys[$key];
            $obj->$local = $pks['id'];
        }
        
        // Loop over all again to save them since we satisfied all pending relationships above
        foreach ($pendingRelations as $rowKey => $pending) {
            $obj = $pending['obj'];
            $obj->save();
        }
    }

    /**
     * doImportDummyData
     *
     * @param string $num 
     * @return void
     */
    public function doImportDummyData($num = 3)
    {
        $models = Doctrine::getLoadedModels();
        
        $specifiedModels = $this->getModels();
        
        foreach ($models as $name) {
            if ( ! empty($specifiedModels) && !in_array($name, $specifiedModels)) {
                continue;
            }
            
            for ($i = 0; $i < $num; $i++) {
                $obj = new $name();
                
                $this->populateDummyRecord($obj);
                
                $obj->save();
                
                $ids[get_class($obj)][] = $obj->identifier();
            }
        }
    }
    
    public function populateDummyRecord(Doctrine_Record $record)
    {
        $lorem = explode(' ', "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem 
                               Ipsum has been the industry's standard dummy text ever since the 1500s, when an 
                               unknown printer took a galley of type and scrambled it to make a type specimen book. 
                               It has survived not only five centuries, but also the leap into electronic 
                               typesetting, remaining essentially unchanged. It was popularised in the 1960s with 
                               the release of Letraset sheets containing Lorem Ipsum passages, and more recently 
                               with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.");
        
        $columns = array_keys($record->toArray());
        $pks = $record->getTable()->getIdentifier();
        
        if ( ! is_array($pks)) {
          $pks = array($pks);
        }
        
        foreach ($columns as $column) {
            
            if ( ! in_array($column, $pks)) {
                if ($relation = $this->isRelation($record, $column)) {
                    $alias = $relation['alias'];
                    $relationObj = $record->$alias;
                    
                    $this->populateDummyRecord($relationObj);
                    
                } else {
                    
                    $definition = $record->getTable()->getDefinitionOf($column);
                    
                    switch($definition['type'])
                    {
                        case 'string';     
                            shuffle($lorem);
                    
                            $record->$column = substr(implode(' ', $lorem), 0, $definition['length']);
                        break;
                        
                        case 'integer':
                            $record->$column = rand();
                        break;
                        
                        case 'boolean':
                            $record->$column = true;
                        break;
                        
                        case 'float':
                            $record->$column = number_format(rand($definition['length'], $definition['length']), 2, '.', null);
                        break;
                        
                        case 'array':
                            $record->$column = array('test' => 'test');
                        break;
                        
                        case 'object':
                            $record->$column = new stdObject();
                        break;
                        
                        case 'blob':
                            $record->$column = '';
                        break;
                        
                        case 'clob':
                            $record->$column = '';
                        break;
                        
                        case 'timestamp':
                            $record->$column = date('Y-m-d h:i:s', time());
                        break;
                        
                        case 'time':
                            $record->$column = date('h:i:s', time());
                        break;
                        
                        case 'date':
                            $record->$column = date('Y-m-d', time());
                        break;
                        
                        case 'enum':
                            $record->$column = 'test';
                        break;
                        
                        case 'gzip':
                            $record->$column = 'test';
                        break;
                    }
                }
            }
        }
        
        return $record;
    }
}