<?php
/**
 * File containing the ezcDbSchemaPhpArrayWriter class.
 *
 * @package DatabaseSchema
 * @version 1.4.2
 * @copyright Copyright (C) 2005-2008 eZ systems as. All rights reserved.
 * @license http://ez.no/licenses/new_bsd New BSD License
 */

/**
 * Writer handler for files containing PHP arrays that represent DB schemas.
 *
 * @package DatabaseSchema
 * @version 1.4.2
 */
class ezcDbSchemaPhpArrayWriter implements ezcDbSchemaFileWriter, ezcDbSchemaDiffFileWriter
{
    /**
     * Returns what type of schema writer this class implements.
     *
     * This method always returns ezcDbSchema::FILE
     *
     * @return int
     */
    public function getWriterType()
    {
        return ezcDbSchema::FILE;
    }

    /**
     * Returns what type of schema difference writer this class implements.
     *
     * This method always returns ezcDbSchema::FILE
     *
     * @return int
     */
    public function getDiffWriterType()
    {
        return ezcDbSchema::FILE;
    }

    /**
     * Saves the schema definition in $schema to the file $file.
     * @todo throw exception when file can not be opened
     *
     * @param string      $file
     * @param ezcDbSchema $dbSchema
     */
    public function saveToFile( $file, ezcDbSchema $dbSchema )
    {
        $schema = $dbSchema->getSchema();
        $data = $dbSchema->getData();
        
        $fileData = '<?php return '. var_export( array( $schema, $data ), true ) . '; ?>';
        if ( ! @file_put_contents( $file, (string) $fileData ) )
        {
            throw new ezcBaseFilePermissionException( $file, ezcBaseFileException::WRITE );
        }
    }

    /**
     * Saves the differences in $schemaDiff to the file $file
     * @todo throw exception when file can not be opened
     *
     * @param string          $file
     * @param ezcDbSchemaDiff $dbSchemaDiff
     */
    public function saveDiffToFile( $file, ezcDbSchemaDiff $dbSchemaDiff )
    {
        $fileData = '<?php return '. var_export( $dbSchemaDiff, true ) . '; ?>';
        if ( ! @file_put_contents( $file, (string) $fileData ) )
        {
            throw new ezcBaseFilePermissionException( $file, ezcBaseFileException::WRITE );
        }
    }
}
?>