sintonia/library/propel/generator/lib/reverse/SchemaParser.php

64 lines
1.3 KiB
PHP

<?php
/**
* This file is part of the Propel package.
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @license MIT License
*/
/**
* Interface for reverse engineering schema parsers.
*
* @author Hans Lellelid <hans@xmpl.org>
* @version $Revision: 1612 $
* @package propel.generator.reverse
*/
interface SchemaParser
{
/**
* Gets the database connection.
* @return PDO
*/
public function getConnection();
/**
* Sets the database connection.
*
* @param PDO $dbh
*/
public function setConnection(PDO $dbh);
/**
* Sets the GeneratorConfig to use in the parsing.
*
* @param GeneratorConfig $config
*/
public function setGeneratorConfig(GeneratorConfig $config);
/**
* Gets a specific propel (renamed) property from the build.
*
* @param string $name
* @return mixed
*/
public function getBuildProperty($name);
/**
* Gets array of warning messages.
* @return array string[]
*/
public function getWarnings();
/**
* Parse the schema and populate passed-in Database model object.
*
* @param Database $database
*
* @return int number of generated tables
*/
public function parse(Database $database, PDOTask $task = null);
}